diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 6 |
1 files changed, 5 insertions, 1 deletions
@@ -15,7 +15,7 @@ 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. +Next, make sure where you are runing the binary from, that you copy the sources public folder to the same directory. The public folder is needed to server html, css, js, and font files. Finally, the site runs on port `8080`, so its recommended you put it behind a reverse proxy, or you could use a docker container and remap the outsite port (see below). @@ -37,6 +37,10 @@ to make the database persistant. Finally, before running the container run since docker will create a folder there otherwise and it won't work. +**reverse proxy** + +Finally if you are using docker by itself, a reverse proxy, or both, the ip send to the container likily will not be the correct ip. xssbook looks for headers `x-forwarded-for`, `x-real-ip`, and `forwarded` to check for proxies. So make sure to have those headers set. Or if your running just docker, you could also run the docker container on the host network instead of on the bridge network. + **license** This amazing project is licensed under the WTFPL
\ No newline at end of file |