Skip to content

Commit 1a52e07

Browse files
authored
Docs: add env setup before db commands (#133)
* docs: add env setup before db commands in README.md * docs: add placeholder session cookie values to .env.example * docs: add env setup notes * docs: update README.md
1 parent aa99d83 commit 1a52e07

File tree

2 files changed

+8
-1
lines changed

2 files changed

+8
-1
lines changed

.env.example

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ LOG_LEVEL=info
1919

2020
# Security
2121
COOKIE_SECRET=
22-
COOKIE_NAME=
22+
COOKIE_NAME=session_id
2323
RATE_LIMIT_MAX=4 # 4 is for tests, increase if you need more

README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,14 @@ Install the dependencies:
1818
npm install
1919
```
2020

21+
### Environment variables
22+
23+
Create a `.env` file based on `.env.example` and update values as needed.
24+
25+
Make sure `COOKIE_SECRET` is set to a secret with at least 32 characters.
26+
2127
### Database
28+
2229
You can run a MySQL instance with Docker:
2330
```bash
2431
docker compose up

0 commit comments

Comments
 (0)