Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated README.md to add a step regarding .env #64

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Updated README.md to add a step regarding .env #64

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b0cf0f4
Update README.md
ShadowFox88 Dec 28, 2024
13fa215
added more info about how to get the application running
ShadowFox88 Dec 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ 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.
- Ensure you change the `host` key to `0.0.0.0` from `localhost`
- 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