add mmctl config export docs (#7718)

Co-authored-by: Carrie Warner (Mattermost) <[email protected]>
mattermost · Feb 10, 2025 · 36fb502 · 36fb502
1 parent 44de53e
commit 36fb502
Showing 1 changed file with 42 additions and 0 deletions.
diff --git a/source/manage/mmctl-command-line-tool.rst b/source/manage/mmctl-command-line-tool.rst
@@ -1826,6 +1826,7 @@ Configuration settings.
 
    Child Commands
       -  `mmctl config edit`_ - Edit the configuration settings
+      -  `mmctl config export`_ - Export the server configuration
       -  `mmctl config get`_ - Get the value of a configuration setting
       -  `mmctl config migrate`_ - Migrate existing configuration between backends
       -  `mmctl config patch`_ - Patch the configuration
@@ -1868,6 +1869,47 @@ Open the editor defined in the EDITOR environment variable to modify the server'
 
 **Options inherited from parent commands**
 
+.. code-block:: sh
+
+   --config string                path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")
+   --disable-pager                disables paged output
+   --insecure-sha1-intermediate   allows to use insecure TLS protocols, such as SHA-1
+   --insecure-tls-version         allows to use TLS versions 1.0 and 1.1
+   --json                         the output format will be in json format
+   --local                        allows communicating with the server through a unix socket
+   --quiet                        prevent mmctl to generate output for the commands
+   --strict                       will only run commands if the mmctl version matches the server one
+   --suppress-warnings            disables printing warning messages
+
+mmctl config export
+~~~~~~~~~~~~~~~~~~~
+
+**Description**
+
+Use this command to export the server configuration, which can then be imported into another server or environment. Masked values are only exported when the tool is running in `local mode <#local-mode>`__.
+
+**Format**
+
+.. code-block:: sh
+
+   mmctl config export [flags]
+
+**Examples**
+
+.. code-block:: sh
+
+   mmctl config export --remove-masked --remove-defaults
+
+**Options**
+
+.. code-block:: sh
+
+   -h, --help              help for export
+       --remove-defaults   remove default values from the exported configuration
+       --remove-masked     remove masked values from the exported configuration (default true)
+
+**Options inherited from parent commands**
+
 .. code-block:: sh
 
    --config string                path to the configuration file (default "$XDG_CONFIG_HOME/mmctl/config")