summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorFelix Ableitner <me@nutomic.com>2019-12-17 22:35:48 +0100
committerFelix Ableitner <me@nutomic.com>2019-12-27 17:28:46 +0100
commit1f7546789a3e9d4a095aa72ba69843259eb56fc6 (patch)
treeee10142913b4211b3719e108f70875e80325a22c /README.md
parentddc913ba7cd7759c9ea63123cd7bb97e861fa00f (diff)
update documentation, docker and ansible files
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
index 0e8dd601..fa35788d 100644
--- a/README.md
+++ b/README.md
@@ -54,6 +54,7 @@ Front Page|Post
+ [Requirements](#requirements)
+ [Set up Postgres DB](#set-up-postgres-db)
+ [Running](#running)
+- [Configuration](#configuration)
- [Documentation](#documentation)
- [Support](#support)
- [Translations](#translations)
@@ -222,6 +223,19 @@ cd lemmy
# cd server && cargo watch -x run
```
+## Configuration
+
+The configuration is based on the file [defaults.hjson](server/config/defaults.hjson). This file also contains
+documentation for all the available options. To override the defaults, you can copy the options you want to change
+into your local `config.hjson` file.
+
+Additionally, you can override any config files with environment variables. These have the same name as the config
+options, and are prefixed with `LEMMY_`. For example, you can override the `database.password` with
+`LEMMY_DATABASE_PASSWORD=my_password`.
+
+An additional option `LEMMY_DATABASE_URL` is available, which can be used with a PostgreSQL connection string like
+`postgres://lemmy:password@lemmy_db:5432/lemmy`, passing all connection details at once.
+
## Documentation
- [Websocket API for App developers](docs/api.md)