self-hosted/Mailu
1
0
Fork 0
mirror of https://github.com/Mailu/Mailu.git synced 2025-06-17 00:07:45 +02:00
Code Issues Releases Activity

fix some cli commands in the docs

Browse Source
This commit is contained in:
hoellen
2019-01-24 22:38:09 +01:00
parent 49192deec8
commit 928b5470d4
2 changed files with 15 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/cli.rst
View File

@ -4,11 +4,11 @@ Mailu command line
Managing users and aliases can be done from CLI using commands: Managing users and aliases can be done from CLI using commands:
* alias * alias
* alias_delete * alias-delete
* user * user
* user_import * user-import
* user_delete * user-delete
* config_update * config-update
alias alias
----- -----
@ -18,12 +18,12 @@ alias
docker-compose exec admin flask mailu alias foo example.net "mail1@example.com,mail2@example.com" docker-compose exec admin flask mailu alias foo example.net "mail1@example.com,mail2@example.com"
alias_delete alias-delete
------------ ------------
.. code-block:: bash .. code-block:: bash
docker-compose exec admin flask mailu alias_delete foo@example.net docker-compose exec admin flask mailu alias-delete foo@example.net
user user
---- ----
@ -32,30 +32,30 @@ user
docker-compose exec admin flask mailu user --hash_scheme='SHA512-CRYPT' myuser example.net 'password123' docker-compose exec admin flask mailu user --hash_scheme='SHA512-CRYPT' myuser example.net 'password123'
user_import user-import
----------- -----------
primary difference with simple `user` command is that password is being imported as a hash - very useful when migrating users from other systems where only hash is known. primary difference with simple `user` command is that password is being imported as a hash - very useful when migrating users from other systems where only hash is known.
.. code-block:: bash .. code-block:: bash
docker-compose run --rm admin python manage.py user --hash_scheme='SHA512-CRYPT' myuser example.net '$6$51ebe0cb9f1dab48effa2a0ad8660cb489b445936b9ffd812a0b8f46bca66dd549fea530ce' docker-compose run --rm admin flask mailu user-import --hash_scheme='SHA512-CRYPT' myuser example.net '$6$51ebe0cb9f1dab48effa2a0ad8660cb489b445936b9ffd812a0b8f46bca66dd549fea530ce'
user_delete user-delete
------------ ------------
.. code-block:: bash .. code-block:: bash
docker-compose exec admin flask mailu user_delete foo@example.net docker-compose exec admin flask mailu user-delete foo@example.net
config_update config-update
------------- -------------
The sole purpose of this command is for importing users/aliases in bulk and synchronizing DB entries with external YAML template: The sole purpose of this command is for importing users/aliases in bulk and synchronizing DB entries with external YAML template:
.. code-block:: bash .. code-block:: bash
cat mail-config.yml | docker-compose exec admin flask mailu config_update --delete_objects cat mail-config.yml | docker-compose exec admin flask mailu config-update --delete_objects
where mail-config.yml looks like: where mail-config.yml looks like:
@ -72,7 +72,7 @@ where mail-config.yml looks like:
domain: example.com domain: example.com
destination: "user1@example.com,user2@example.com" destination: "user1@example.com,user2@example.com"
without ``--delete_object`` option config_update will only add/update new values but will *not* remove any entries missing in provided YAML input. without ``--delete_object`` option config-update will only add/update new values but will *not* remove any entries missing in provided YAML input.
Users Users
----- -----

2
docs/kubernetes/mailu/index.rst
View File

@ -128,7 +128,7 @@ And in the pod run the following command. The command uses following entries:
.. code-block:: bash .. code-block:: bash
python manage.py admin root example.com password flask mailu admin root example.com password
- ``admin`` Make it an admin user - ``admin`` Make it an admin user
- ``root`` The first part of the e-mail adres (ROOT@example.com) - ``root`` The first part of the e-mail adres (ROOT@example.com)