Merge branch 'confirm-users' 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 3572b59155b3ae2f3d5b5f5be52e9dc26b78d9df..000ed4d98cc2963a5b613e2eb734032b3207c6fe 100644 (file)
--- a/docs/administration/CLI_tasks/config.md
+++ b/docs/administration/CLI_tasks/config.md
@@ -72,36 +72,68 @@ To delete transferred settings from database optional flag `-d` can be used. `<e
     mix pleroma.config groups
     ```
 
-## Dump the saved configuration values for a specific group
+## Dump the saved configuration values for a specific group or key
 
-e.g., this shows all the settings under `:instance`
+e.g., this shows all the settings under `config :pleroma`
 
 === "OTP"
 
     ```sh
-    ./bin/pleroma_ctl config dump instance
+    ./bin/pleroma_ctl config dump pleroma
     ```
 
 === "From Source"
 
     ```sh
-    mix pleroma.config dump instance
+    mix pleroma.config dump pleroma
     ```
 
-## Delete the saved configuration values for a specific group
+To get values under a specific key:
 
-e.g., this deletes all the settings under `:instance`
+e.g., this shows all the settings under `config :pleroma, :instance`
 
 === "OTP"
 
     ```sh
-    ./bin/pleroma_ctl config groupdel instance
+    ./bin/pleroma_ctl config dump pleroma instance
     ```
 
 === "From Source"
 
     ```sh
-    mix pleroma.config groupdel 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`
+
+=== "OTP"
+
+    ```sh
+    ./bin/pleroma_ctl config delete [--force] tesla
+    ```
+
+=== "From Source"
+
+    ```sh
+    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`
+
+=== "OTP"
+
+    ```sh
+    ./bin/pleroma_ctl config delete [--force] phoenix stacktrace_depth
+    ```
+
+=== "From Source"
+
+    ```sh
+    mix pleroma.config delete [--force] phoenix stacktrace_depth
     ```
 
 ## Remove all settings from the database
@@ -111,11 +143,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
     ```