Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
added a section for a missing config step for .env
  • Loading branch information
ShadowFox88 authored Dec 28, 2024
1 parent d8b4375 commit b0cf0f4
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@ Easily share code and text.
- Clone
- Copy `config.template.toml` into `config.toml`
- The default config for database (and redis) should work Out of Box.
- Copy `.env.example` into `.env`
- The default config should work Out of Box
- The database container doesn't expose connections outside of the network, but for added security edit `.env` and change the password.
- Optionally in `core/server.py` set `ignore_localhost=` to `False` in the RateLimit Middleware for testing.
- Run `docker compose up -d` to start the services.
- If you want to use redis for session/limit handling, run with the redis profile: `docker compose --profile redis up -d`
Expand Down

0 comments on commit b0cf0f4

Please sign in to comment.