Transferring the config to/from the database

Every command should be ran as the pleroma user from it's home directory. For example if you are superuser, you would have to wrap the command in su pleroma -s $SHELL -lc "$COMMAND".

From source note about MIX_ENV

The mix command should be prefixed with the name of environment your Pleroma server is running in, usually it's MIX_ENV=prod

Transfer config from file to DB.

Note

You need to add the following to your config before executing this command:

config :pleroma, configurable_from_database: true

OTP

./bin/pleroma_ctl config migrate_to_db

From Source

mix pleroma.config migrate_to_db

Transfer config from DB to config/env.exported_from_db.secret.exs

Note

In-Database configuration will still be applied after executing this command unless you set the following in your config:

config :pleroma, configurable_from_database: false

Options:

• <path> - where to save migrated config. E.g. --path=/tmp. If file saved into non-standard folder, you must manually copy file into directory where Pleroma can read it. For OTP install path will be PLEROMA_CONFIG_PATH or /etc/pleroma. For installation from source - config directory in the pleroma folder.
• <env> - environment, for which is migrated config. By default is prod.
• To delete transferred settings from database optional flag -d can be used

OTP

 ./bin/pleroma_ctl config migrate_from_db [--env=<env>] [-d] [--path=<path>]

From Source

mix pleroma.config migrate_from_db [--env=<env>] [-d] [--path=<path>]

Dump all of the config settings defined in the database

OTP

 ./bin/pleroma_ctl config dump

From Source

mix pleroma.config dump

List individual configuration groups in the database

OTP

 ./bin/pleroma_ctl config groups

From Source

mix pleroma.config groups

Dump the saved configuration values for a specific group or key

e.g., this shows all the settings under config :pleroma

OTP

./bin/pleroma_ctl config dump pleroma

From Source

mix pleroma.config dump pleroma

To get values under a specific key:

e.g., this shows all the settings under config :pleroma, :instance

OTP

./bin/pleroma_ctl config dump pleroma instance

From Source

mix pleroma.config dump pleroma instance

Delete the saved configuration values for a specific group or key

e.g., this deletes all the settings under config :tesla

OTP

./bin/pleroma_ctl config delete [--force] tesla

From Source

mix pleroma.config delete [--force] tesla

To delete values under a specific key:

e.g., this deletes all the settings under config :phoenix, :stacktrace_depth

OTP

./bin/pleroma_ctl config delete [--force] phoenix stacktrace_depth

From Source

mix pleroma.config delete [--force] phoenix stacktrace_depth

Remove all settings from the database

This forcibly removes all saved values in the database.

OTP

./bin/pleroma_ctl config [--force] reset

From Source

mix pleroma.config [--force] reset

Remove invalid MRF modules from the database

This forcibly removes any enabled MRF that does not exist and will fix the ability of the instance to start.

OTP

./bin/pleroma_ctl config fix_mrf_policies

From Source

mix pleroma.config fix_mrf_policies