Merge remote-tracking branch 'pleroma/develop' into object-tombstone-visibility

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

diff --git a/docs/administration/CLI_tasks/config.md b/docs/administration/CLI_tasks/config.md
index ea07ca293c6ef83c77fe6bbc3431e849562268a1..fc9f3cbd5e1c1e9fd5f359605b9fc7c7c3f1d553 100644 (file)
--- a/docs/administration/CLI_tasks/config.md
+++ b/docs/administration/CLI_tasks/config.md
@@ -32,16 +32,20 @@
     config :pleroma, configurable_from_database: false
     ```
 
-To delete transferred settings from database optional flag `-d` can be used. `<env>` is `prod` by default.
+Options:
+
+- `<path>` - where to save migrated config. E.g. `--path=/tmp`. If file saved into non standart 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"
     ```sh
-     ./bin/pleroma_ctl config migrate_from_db [--env=<env>] [-d]
+     ./bin/pleroma_ctl config migrate_from_db [--env=<env>] [-d] [--path=<path>]
     ```
 
 === "From Source"
     ```sh
-    mix pleroma.config migrate_from_db [--env=<env>] [-d]
+    mix pleroma.config migrate_from_db [--env=<env>] [-d] [--path=<path>]
     ```
 
 ## Dump all of the config settings defined in the database
@@ -111,13 +115,13 @@ e.g., this deletes all the settings under `config :tesla`
 === "OTP"
 
     ```sh
-    ./bin/pleroma_ctl config delete tesla
+    ./bin/pleroma_ctl config delete [--force] tesla
     ```
 
 === "From Source"
 
     ```sh
-    mix pleroma.config delete tesla
+    mix pleroma.config delete [--force] tesla
     ```
 
 To delete values under a specific key:
@@ -127,13 +131,13 @@ e.g., this deletes all the settings under `config :phoenix, :stacktrace_depth`
 === "OTP"
 
     ```sh
-    ./bin/pleroma_ctl config delete phoenix stacktrace_depth
+    ./bin/pleroma_ctl config delete [--force] phoenix stacktrace_depth
     ```
 
 === "From Source"
 
     ```sh
-    mix pleroma.config delete phoenix stacktrace_depth
+    mix pleroma.config delete [--force] phoenix stacktrace_depth
     ```
 
 ## Remove all settings from the database
@@ -143,11 +147,11 @@ This forcibly removes all saved values in the database.
 === "OTP"
 
     ```sh
-    ./bin/pleroma_ctl config reset
+    ./bin/pleroma_ctl config [--force] reset
     ```
 
 === "From Source"
 
     ```sh
-    mix pleroma.config reset
+    mix pleroma.config [--force] reset
     ```