]> Untitled Git - lemmy.git/commitdiff
Update configuration documentation
authorKenneth Koski <kenneth.koski@canonical.com>
Sat, 31 Oct 2020 21:28:09 +0000 (16:28 -0500)
committerKenneth Koski <kenneth.koski@canonical.com>
Sat, 31 Oct 2020 21:28:09 +0000 (16:28 -0500)
docs/src/administration_configuration.md

index 0e730d3305352d3c40bf40b7b27f74fd4e29fea4..cfda34f75d8f26a3a70b6dcacef13c6719763ee4 100644 (file)
@@ -1,22 +1,17 @@
 # Configuration
 
-The configuration is based on the file
-[defaults.hjson](https://yerbamate.dev/LemmyNet/lemmy/src/branch/main/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.
+The configuration is based on the file [defaults.hjson](https://yerbamate.dev/LemmyNet/lemmy/src/branch/main/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.
 
-To use a different `config.hjson` location than the current directory, set the environment variable `LEMMY_CONFIG_LOCATION`. Make sure you copy the `defaults.hjson` if you do this, otherwise you will be missing settings.
+The `defaults.hjson` and `config.hjson` files are located at `config/defaults.hjson` and`config/config.hjson`, respectively. To change these default locations, you can set these two environment variables:
 
-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__POOL_SIZE=10`.
+    LEMMY_CONFIG_LOCATION           # config.hjson
+    LEMMY_CONFIG_DEFAULTS_LOCATION  # defaults.hjson
 
-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.
+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__POOL_SIZE=10`.
 
-If the Docker container is not used, manually create the database specified above by running the
-following commands:
+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.
+
+If the Docker container is not used, manually create the database specified above by running the following commands:
 
 ```bash
 cd server