From ada073f2511ae57eb22dc9e8a4220b2382b9f97c Mon Sep 17 00:00:00 2001
From: Mark Felder <feld@FreeBSD.org>
Date: Wed, 25 Nov 2020 17:49:36 -0600
Subject: [PATCH] Rename keys to groups

---
 docs/administration/CLI_tasks/config.md | 44 +++++++++++++++++++++++++
 lib/mix/tasks/pleroma/config.ex         |  6 ++--
 2 files changed, 47 insertions(+), 3 deletions(-)

diff --git a/docs/administration/CLI_tasks/config.md b/docs/administration/CLI_tasks/config.md
index 482f02b64..1eb3c7437 100644
--- a/docs/administration/CLI_tasks/config.md
+++ b/docs/administration/CLI_tasks/config.md
@@ -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
+    ```
diff --git a/lib/mix/tasks/pleroma/config.ex b/lib/mix/tasks/pleroma/config.ex
index 574f8f4be..3c94f1f5f 100644
--- a/lib/mix/tasks/pleroma/config.ex
+++ b/lib/mix/tasks/pleroma/config.ex
@@ -64,7 +64,7 @@ def run(["dump" | dbkey]) 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 @@ def run(["reset"]) 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 @@ def run(["keydel" | dbkey]) 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