Merge branch 'docs/kyclos' into 'develop'

[akkoma] / docs / administration / CLI_tasks / config.md

diff --git a/docs/administration/CLI_tasks/config.md b/docs/administration/CLI_tasks/config.md
index ce19e2402ac0911d56ec06310c81b6612c8982ba..cc32bf859f9b6e53b101a8a83b17d2d7eeb75cd4 100644 (file)
--- a/docs/administration/CLI_tasks/config.md
+++ b/docs/administration/CLI_tasks/config.md
@@ -1,19 +1,40 @@
 # Transfering the config to/from the database
 
-!!! danger
-    This is a Work In Progress, not usable just yet.
-
-Every command should be ran with a prefix, in case of OTP releases it is `./bin/pleroma_ctl config` and in case of source installs it's
-`mix pleroma.config`.
+{! backend/administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Transfer config from file to DB.
 
-```sh
-$PREFIX migrate_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`
 
-```sh
-$PREFIX migrate_from_db <env>
+!!! 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]
 ```