diff options
| author | rinpatch <rinpatch@sdf.org> | 2019-10-02 23:54:55 +0300 |
|---|---|---|
| committer | rinpatch <rinpatch@sdf.org> | 2019-10-02 23:54:55 +0300 |
| commit | 03e1898917d161c2682ded202d335de582c04989 (patch) | |
| tree | c5bf790ae6b7d302fb08d2c92c85068ae75bdfb1 /docs/configuration | |
| parent | acc62f327d45c0a9a0414da56bc339ec3e22cb63 (diff) | |
| download | pleroma-03e1898917d161c2682ded202d335de582c04989.tar.gz | |
Rename "Configuration" to "Configuration Cheat Sheet" and explain a bit
about how Pleroma Configuration works
Diffstat (limited to 'docs/configuration')
| -rw-r--r-- | docs/configuration/cheatsheet.md (renamed from docs/configuration/config.md) | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/docs/configuration/config.md b/docs/configuration/cheatsheet.md index 262d15bba..fd936aed7 100644 --- a/docs/configuration/config.md +++ b/docs/configuration/cheatsheet.md @@ -1,7 +1,11 @@ -# Configuration +# Configuration Cheat Sheet + +This is a cheat sheet for Pleroma configuration file, any setting possible to configure should be listed here. + +Pleroma configuration works by first importing the base config (`config/config.exs` on source installs, compiled-in on OTP releases), then overriding it by the environment config (`config/$MIX_ENV.exs` on source installs, N/A to OTP releases) and then overriding it by user config (`config/$MIX_ENV.secret.exs` on source installs, typically `/etc/pleroma/config.exs` on OTP releases). + +You shouldn't edit the base config directly to avoid breakages and merge conflicts, but it can be used as a reference if you don't understand how an option is supposed to be formatted, the latest version of it can be viewed [here](https://git.pleroma.social/pleroma/pleroma/blob/develop/config/config.exs). -This file describe the configuration, it is recommended to edit the relevant *.secret.exs file instead of the others founds in the ``config`` directory. -If you run Pleroma with ``MIX_ENV=prod`` the file is ``prod.secret.exs``, otherwise it is ``dev.secret.exs``. ## Pleroma.Upload * `uploader`: Select which `Pleroma.Uploaders` to use |