summaryrefslogtreecommitdiff
path: root/README.md
blob: f291e2186547d1883d728c9c339a5713f2f52e5e (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
- upload anyfiles to be your profile avatar and banner (even adobe flash!!!)

### installation

To get the checkout run:

```sh
git clone https://g.freya.cat/freya/xssbook2 xssbook2
cd xssbook2
```

XSSBook v2 runs in docker compose. To run, you MUST do ALL of the following:

    - Update PROJECT_DIR in .env to be an absolute path to your current directory
    - Build all css source from sass by running `make`
    - Use `site/compose` instead of docker compose

Finally, to build the images and start, run:

```sh
./site/compose build --pull
./site/compose up -d
```

> NOTE: You many want to change is HTTP_PORT and HTTP_BIND in .env.

### migrating from xssbook v1

See `shim/README.md`

### license

This project is licensed under the GNU GPLv3.