summaryrefslogtreecommitdiff
path: root/README.md
blob: 7f50320d79a3d6a26638bd56c7def9419189a1ad (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
# 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 behind 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