summaryrefslogtreecommitdiff
path: root/docs/administration/CLI_tasks/config.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/administration/CLI_tasks/config.md')
-rw-r--r--docs/administration/CLI_tasks/config.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/docs/administration/CLI_tasks/config.md b/docs/administration/CLI_tasks/config.md
new file mode 100644
index 000000000..cc32bf859
--- /dev/null
+++ b/docs/administration/CLI_tasks/config.md
@@ -0,0 +1,40 @@
+# Transfering the config to/from the database
+
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
+
+## Transfer config from file to DB.
+
+!!! note
+ You need to add the following to your config before executing this command:
+
+ ```elixir
+ config :pleroma, configurable_from_database: true
+ ```
+
+```sh tab="OTP"
+ ./bin/pleroma_ctl config migrate_to_db
+```
+
+```sh tab="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:
+
+ ```elixir
+ config :pleroma, configurable_from_database: false
+ ```
+
+To delete transfered settings from database optional flag `-d` can be used. `<env>` is `prod` by default.
+
+```sh tab="OTP"
+ ./bin/pleroma_ctl config migrate_from_db [--env=<env>] [-d]
+```
+
+```sh tab="From Source"
+mix pleroma.config migrate_from_db [--env=<env>] [-d]
+```