Skip to content

Commit 35e1829

Browse files
authored
Updated README.md to add a step regarding .env (#64)
* Update README.md added a section for a missing config step for .env * added more info about how to get the application running
1 parent 0cd51ee commit 35e1829

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ Easily share code and text.
3232
- Clone
3333
- Copy `config.template.toml` into `config.toml`
3434
- The default config for database (and redis) should work Out of Box.
35+
- Ensure you change the `host` key to `0.0.0.0` from `localhost`
36+
- Copy `.env.example` into `.env`
37+
- The default config should work Out of Box
38+
- The database container doesn't expose connections outside of the network, but for added security edit `.env` and change the password.
3539
- Optionally in `core/server.py` set `ignore_localhost=` to `False` in the RateLimit Middleware for testing.
3640
- Run `docker compose up -d` to start the services.
3741
- If you want to use redis for session/limit handling, run with the redis profile: `docker compose --profile redis up -d`

0 commit comments

Comments
 (0)