|
|
|
@@ -26,10 +26,14 @@ Running the back-end is as simple as:
|
|
|
|
npm ci
|
|
|
|
npm ci
|
|
|
|
```
|
|
|
|
```
|
|
|
|
- Copying the .env.default file to .env, and customizing it to own preferences.
|
|
|
|
- Copying the .env.default file to .env, and customizing it to own preferences.
|
|
|
|
|
|
|
|
|
|
|
|
**Example:** Say, you want to add a domain to the trusted CORS origins list. To do so, your .env file in your editor of choice and append a comma (`,`) with the origin you want to add (say, `http://example.com`). Your .env file might then look as follows: `TRUSTED_ORIGINS=http://localhost:6568,http://example.com`.
|
|
|
|
**Example:** Say, you want to add a domain to the trusted CORS origins list. To do so, your .env file in your editor of choice and append a comma (`,`) with the origin you want to add (say, `http://example.com`). Your .env file might then look as follows: `TRUSTED_ORIGINS=http://localhost:6568,http://example.com`.
|
|
|
|
|
|
|
|
|
|
|
|
**Important:** Make sure to change the `ACCESS_TOKEN_PRIVATE_KEY` variable to something secure, as this secret value will be used to generate user sessions. **Setting a weak key will allow attackers to potentially bruteforce your secret and forge user tokens!**
|
|
|
|
**Important:** Make sure to change the `ACCESS_TOKEN_PRIVATE_KEY` variable to something secure, as this secret value will be used to generate user sessions. **Setting a weak key will allow attackers to potentially bruteforce your secret and forge user tokens!**
|
|
|
|
- Pasting your wordlist file into `src/tools/wordlist.ts`.
|
|
|
|
- Pasting your wordlist file into `src/tools/wordlist.ts`.
|
|
|
|
|
|
|
|
|
|
|
|
No wordlist file exists by default in `src/tools/wordlist.ts`. This is because wordlists were meant to be as modular as possible (with the philosophy of "bring your own wordlist"). If you leave that as-is, you'll run into runtime errors.
|
|
|
|
No wordlist file exists by default in `src/tools/wordlist.ts`. This is because wordlists were meant to be as modular as possible (with the philosophy of "bring your own wordlist"). If you leave that as-is, you'll run into runtime errors.
|
|
|
|
|
|
|
|
|
|
|
|
However, if you don't want to provide your own wordlist, and just want to get up and running as fast as possible, you're free to use the provided sample `wordlist.example-large.ts` file. Just copy it into `src/tools/wordlist.ts`:
|
|
|
|
However, if you don't want to provide your own wordlist, and just want to get up and running as fast as possible, you're free to use the provided sample `wordlist.example-large.ts` file. Just copy it into `src/tools/wordlist.ts`:
|
|
|
|
```sh
|
|
|
|
```sh
|
|
|
|
cp wordlist.example-large.ts src/tools/wordlist.ts
|
|
|
|
cp wordlist.example-large.ts src/tools/wordlist.ts
|
|
|
|
|