Rename keys to groups
authorMark Felder <feld@FreeBSD.org>
Wed, 25 Nov 2020 23:49:36 +0000 (17:49 -0600)
committerMark Felder <feld@FreeBSD.org>
Wed, 2 Dec 2020 16:43:22 +0000 (10:43 -0600)
docs/administration/CLI_tasks/config.md
lib/mix/tasks/pleroma/config.ex

index 482f02b6412d927feddd5a24a58463348d699291..1eb3c7437dfbf37304db55e8ad105b4f68fb4d1a 100644 (file)
@@ -43,3 +43,47 @@ To delete transferred settings from database optional flag `-d` can be used. `<e
     ```sh
     mix pleroma.config migrate_from_db [--env=<env>] [-d]
     ```
+
+## Dump all of the config settings defined in the database
+
+=== "OTP"
+
+    ```sh
+     ./bin/pleroma_ctl config dump
+    ```
+
+=== "From Source"
+
+    ```sh
+    mix pleroma.config dump
+    ```
+
+## List individual configuration groups in the database
+
+=== "OTP"
+
+    ```sh
+     ./bin/pleroma_ctl config groups
+    ```
+
+=== "From Source"
+
+    ```sh
+    mix pleroma.config groups
+    ```
+
+## Dump the saved configuration values for a specific group
+
+e.g., this shows all the settings under `:instance`
+
+=== "OTP"
+
+    ```sh
+    ./bin/pleroma_ctl config dump instance
+    ```
+
+=== "From Source"
+
+    ```sh
+    mix pleroma.config dump instance
+    ```
index 574f8f4beb11271e3c2b269168add3f7f1e960f8..3c94f1f5f0d1e0f11182b0e65b31d3edaae3f414 100644 (file)
@@ -64,7 +64,7 @@ defmodule Mix.Tasks.Pleroma.Config do
     end
   end
 
-  def run(["keylist"]) do
+  def run(["groups"]) do
     with true <- Pleroma.Config.get([:configurable_from_database]) do
       start_pleroma()
 
@@ -96,7 +96,7 @@ defmodule Mix.Tasks.Pleroma.Config do
     end
   end
 
-  def run(["keydel" | dbkey]) do
+  def run(["groupdel" | dbkey]) do
     unless [] == dbkey do
       with true <- Pleroma.Config.get([:configurable_from_database]) do
         start_pleroma()
@@ -115,7 +115,7 @@ defmodule Mix.Tasks.Pleroma.Config do
       end
     else
       shell_error(
-        "You must provide a key to delete. Use the keylist command to get a list of valid keys."
+        "You must provide a group to delete. Use the groups command to get a list of valid configDB groups."
       )
     end
   end