mirrors/pleroma
1
0
Fork 0
mirror of https://git.pleroma.social/pleroma/pleroma.git synced 2024-12-23 08:36:29 +00:00
Code Issues Projects Releases Wiki Activity

Merge branch 'fix/configdb-otp-instructions' into 'develop'

Browse source 
OTP users need Pleroma running to execute pleroma_ctl, so reorganize instructions.

See merge request pleroma/pleroma!2817
This commit is contained in:
feld 2020-07-30 20:28:28 +00:00
commit 09aef71db9
1 changed files with 46 additions and 45 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

57
docs/configuration/howto_database_config.md
View file

@ -5,13 +5,7 @@ The configuration of Pleroma has traditionally been managed with a config file,
## Migration to database config ## Migration to database config
1. Stop your Pleroma instance and edit your Pleroma config to enable database configuration: 1. Run the mix task to migrate to the database. You'll receive some debugging output and a few messages informing you of what happened.
```
config :pleroma, configurable_from_database: true
```
2. Run the mix task to migrate to the database. You'll receive some debugging output and a few messages informing you of what happened.
**Source:** **Source:**
@ -23,6 +17,8 @@ The configuration of Pleroma has traditionally been managed with a config file,
**OTP:** **OTP:**
*Note: OTP users need Pleroma to be running for `pleroma_ctl` commands to work*
``` ```
$ ./bin/pleroma_ctl config migrate_to_db $ ./bin/pleroma_ctl config migrate_to_db
``` ```
@ -47,53 +43,56 @@ The configuration of Pleroma has traditionally been managed with a config file,
Settings for group :pleroma migrated. Settings for group :pleroma migrated.
``` ```
2. It is recommended to backup your config file now.
3. It is recommended to backup your config file now.
``` ```
cp config/dev.secret.exs config/dev.secret.exs.orig cp config/dev.secret.exs config/dev.secret.exs.orig
``` ```
4. Now you can edit your config file and strip it down to the only settings which are not possible to control in the database. e.g., the Postgres and webserver (Endpoint) settings cannot be controlled in the database because the application needs the settings to start up and access the database. 3. Edit your Pleroma config to enable database configuration:
⚠️ **THIS IS NOT REQUIRED** ```
config :pleroma, configurable_from_database: true
```
4. ⚠️ **THIS IS NOT REQUIRED** ⚠️
Now you can edit your config file and strip it down to the only settings which are not possible to control in the database. e.g., the Postgres (Repo) and webserver (Endpoint) settings cannot be controlled in the database because the application needs the settings to start up and access the database.
Any settings in the database will override those in the config file, but you may find it less confusing if the setting is only declared in one place. Any settings in the database will override those in the config file, but you may find it less confusing if the setting is only declared in one place.
A non-exhaustive list of settings that are only possible in the config file include the following: A non-exhaustive list of settings that are only possible in the config file include the following:
* config :pleroma, Pleroma.Web.Endpoint * config :pleroma, Pleroma.Web.Endpoint
* config :pleroma, Pleroma.Repo * config :pleroma, Pleroma.Repo
* config :pleroma, configurable_from_database * config :pleroma, configurable\_from\_database
* config :pleroma, :database, rum_enabled * config :pleroma, :database, rum_enabled
* config :pleroma, :connections_pool * config :pleroma, :connections_pool
Here is an example of a server config stripped down after migration: Here is an example of a server config stripped down after migration:
``` ```
use Mix.Config use Mix.Config
config :pleroma, Pleroma.Web.Endpoint, config :pleroma, Pleroma.Web.Endpoint,
url: [host: "cool.pleroma.site", scheme: "https", port: 443] url: [host: "cool.pleroma.site", scheme: "https", port: 443]
config :pleroma, Pleroma.Repo,
config :pleroma, Pleroma.Repo,
adapter: Ecto.Adapters.Postgres, adapter: Ecto.Adapters.Postgres,
username: "pleroma", username: "pleroma",
password: "MySecretPassword", password: "MySecretPassword",
database: "pleroma_prod", database: "pleroma_prod",
hostname: "localhost" hostname: "localhost"
config :pleroma, configurable_from_database: true config :pleroma, configurable_from_database: true
``` ```
5. Start your instance back up and you can now access the Settings tab in AdminFE. 5. Restart your instance and you can now access the Settings tab in AdminFE.
## Reverting back from database config ## Reverting back from database config
1. Stop your Pleroma instance. 1. Run the mix task to migrate back from the database. You'll receive some debugging output and a few messages informing you of what happened.
2. Run the mix task to migrate back from the database. You'll receive some debugging output and a few messages informing you of what happened.
**Source:** **Source:**
@ -118,7 +117,9 @@ config :pleroma, configurable_from_database: true
Database configuration settings have been saved to config/dev.exported_from_db.secret.exs Database configuration settings have been saved to config/dev.exported_from_db.secret.exs
``` ```
3. The in-database configuration still exists, but it will not be used if you remove `config :pleroma, configurable_from_database: true` from your config. 2. Remove `config :pleroma, configurable_from_database: true` from your config. The in-database configuration still exists, but it will not be used. Future migrations will erase the database config before importing your config file again.
3. Restart your instance.
## Debugging ## Debugging