Merge remote-tracking branch 'remotes/origin/develop' into auth-improvements

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

diff --git a/docs/administration/CLI_tasks/config.md b/docs/administration/CLI_tasks/config.md
index e9d44b9a426f0d55e157a36f1ba48a8b70a7c5b6..0923004b55d7683ad9a40528b1b9a6cf781aace7 100644 (file)
--- a/docs/administration/CLI_tasks/config.md
+++ b/docs/administration/CLI_tasks/config.md
@@ -1,28 +1,45 @@
 # Transfering the config to/from the database
 
-!!! danger
-    This is a Work In Progress, not usable just yet.
-
 {! backend/administration/CLI_tasks/general_cli_task_info.include !}
 
 ## Transfer config from file to DB.
 
-```sh tab="OTP"
- ./bin/pleroma_ctl config migrate_to_db
-```
+!!! note
+    You need to add the following to your config before executing this command:
+
+    ```elixir
+    config :pleroma, configurable_from_database: true
+    ```
+
+=== "OTP"
 
-```sh tab="From Source"
-mix pleroma.config migrate_to_db
-```
+    ```sh
+    ./bin/pleroma_ctl config migrate_to_db
+    ```
 
+=== "From Source"
+
+    ```sh
+    mix pleroma.config migrate_to_db
+    ```
 
 ## Transfer config from DB to `config/env.exported_from_db.secret.exs`
 
-```sh tab="OTP"
- ./bin/pleroma_ctl config 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="From Source"
-mix pleroma.config migrate_from_db <env>
-```
+=== "OTP"
+    ```sh
+     ./bin/pleroma_ctl config migrate_from_db [--env=<env>] [-d]
+    ```
 
+=== "From Source"
+    ```sh
+    mix pleroma.config migrate_from_db [--env=<env>] [-d]
+    ```