Skip to content

Transfering 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
./bin/pleroma_ctl config migrate_to_db
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

To delete transferred settings from database optional flag -d can be used. <env> is prod by default.

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

Dump all of the config settings defined in the database

 ./bin/pleroma_ctl config dump
mix pleroma.config dump

List individual configuration groups in the database

 ./bin/pleroma_ctl config groups
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

./bin/pleroma_ctl config dump pleroma
mix pleroma.config dump pleroma

To get values under a specific key:

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

./bin/pleroma_ctl config dump pleroma instance
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

./bin/pleroma_ctl config delete [--force] tesla
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

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

Remove all settings from the database

This forcibly removes all saved values in the database.

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