From 066b9884c20a608969f49a4744d2eddfdf987eea Mon Sep 17 00:00:00 2001 From: sherl Date: Wed, 7 Jan 2026 23:11:18 +0100 Subject: [PATCH] docs: minor markdown rendering fixes to readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 6e3a8a7..c8465a7 100644 --- a/README.md +++ b/README.md @@ -26,10 +26,14 @@ Running the back-end is as simple as: npm ci ``` - 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`. + **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`. + 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`: ```sh cp wordlist.example-large.ts src/tools/wordlist.ts