self-hosted/Mailu
1
0
Fork 0
mirror of https://github.com/Mailu/Mailu.git synced 2025-02-11 13:25:44 +02:00
Code Issues Releases Activity

updated documentation for config-dump

Browse Source
This commit is contained in:
Alexander Graf 2020-10-24 22:32:08 +02:00
parent adc9c70c3e
commit 0a907a744e
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/cli.rst
View File

@ -78,22 +78,29 @@ The purpose of this command is to dump domain-, relay-, alias- and user-configur
# docker-compose exec admin flask mailu config-dump --help # docker-compose exec admin flask mailu config-dump --help
Usage: flask mailu config-dump [OPTIONS] Usage: flask mailu config-dump [OPTIONS] [SECTIONS]...
dump configuration as YAML-formatted data to stdout dump configuration as YAML-formatted data to stdout
SECTIONS can be: domains, relays, users, aliases
Options: Options:
-f, --full Include default attributes -f, --full Include default attributes
-s, --secrets Include secrets (plain-text / not hashed) -s, --secrets Include secrets (dkim-key, plain-text / not hashed)
-d, --dns Include dns records
--help Show this message and exit. --help Show this message and exit.
If you want to export secrets (plain-text / not hashed) you have to add the ``--secrets`` option. If you want to export secrets (dkim-keys, plain-text / not hashed) you have to add the ``--secrets`` option.
Only non-default attributes are dumped. If you want to dump all attributes use ``--full``. Only non-default attributes are dumped. If you want to dump all attributes use ``--full``.
To include dns records (mx, spf, dkim and dmarc) add the ``--dns`` option.
Unless you specify some sections all sections are dumped by default.
.. code-block:: bash .. code-block:: bash
docker-compose exec admin flask mailu config-dump > mail-config.yml docker-compose exec admin flask mailu config-dump > mail-config.yml
docker-compose exec admin flask mailu config-dump --dns domains
config-update config-update
------------- -------------