xssbook/README.md
Tyler Murphy f3f5e03651 docker
2023-01-28 13:14:53 -05:00

42 lines
1.3 KiB
Markdown

# xssbook
**description**
who doesn't want to run non free javascript
now with xssbook you can run as much stallman disapprovement as you want
- all inputs on the site are unfiltered
- api calls dont care what you send them as long as they are valid strings
- /console page to see everyones amazing api calls
**installation**
The project is written in rust, so you can build it by running
`cargo build --release`
Make sure where you run the binary from, you also move the public folder to.
Finally, the site runs on port `8080`, so its recommended you put it begind a reverse proxy, or you could use a docker container and remap the outsite port (see below).
**docker**
If you want to run it in a docker container a premade dockerfile is here for you
`docker build -f deployments/docker/Dockerfile -t xssbook .`
There is also a docker-compose.yml file for your reference in the /deployments/docker folder.
The one thing about the docker container is you have to mount the volume
`-v [your directory]/xssbook.db:/data/xssbook.db`
to make the database persistant. Finally, before running the container run
`touch [your directory]/xssbook.db`
since docker will create a folder there otherwise and it won't work.
**license**
This amazing project is licensed under the WTFPL