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

Update docs with the new flask command

Browse Source
This commit is contained in:
kaiyou 2018-11-08 21:35:41 +01:00
parent 02995f0a15
commit 30716b8bdf
4 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
docs/cli.rst
View File

@ -15,7 +15,7 @@ alias
.. code-block:: bash
docker-compose run --rm admin python manage.py 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
@ -23,14 +23,14 @@ alias_delete
.. code-block:: bash
docker-compose run --rm admin python manage.py alias_delete foo@example.net
docker-compose exec admin flask mailu alias_delete foo@example.net
user
----
.. code-block:: bash
docker-compose run --rm admin python manage.py 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
-----------
@ -39,14 +39,14 @@ primary difference with simple `user` command is that password is being imported
.. code-block:: bash
docker-compose run --rm admin python manage.py user --hash_scheme='SHA512-CRYPT' myuser example.net '$6$51ebe0cb9f1dab48effa2a0ad8660cb489b445936b9ffd812a0b8f46bca66dd549fea530ce'
docker-compose exec admin flask mailu user --hash_scheme='SHA512-CRYPT' myuser example.net '$6$51ebe0cb9f1dab48effa2a0ad8660cb489b445936b9ffd812a0b8f46bca66dd549fea530ce'
user_delete
------------
.. code-block:: bash
docker-compose run --rm admin python manage.py user_delete foo@example.net
docker-compose exec admin flask mailu user_delete foo@example.net
config_update
-------------
@ -55,7 +55,7 @@ The sole purpose of this command is for importing users/aliases in bulk and sync
.. code-block:: bash
cat mail-config.yml | docker-compose run --rm admin python manage.py config_update --delete_objects
cat mail-config.yml | docker-compose exec admin flask mailu config_update --delete_objects
where mail-config.yml looks like:

4
docs/compose/setup.rst
View File

@ -151,6 +151,6 @@ Finally, you must create the initial admin user account:
.. code-block:: bash
docker-compose run --rm admin python manage.py admin root example.net password
docker-compose exec admin flask mailu admin me example.net password
This will create a user named ``root@example.net`` with password ``password`` and administration privileges. Connect to the Web admin interface and change the password to a strong one.
This will create a user named ``me@example.net`` with password ``password`` and administration privileges. Connect to the Web admin interface and change the password to a strong one.

4
docs/contributors/database.rst
View File

@ -17,7 +17,7 @@ migration script:
.. code-block:: bash
python manage.py db migrate
flask db migrate
This will generate a new script in ``migrations/versions`` that you must review
before adding it for commit.
@ -54,7 +54,7 @@ At that point, to start working on the changed database structure, you will need
.. code-block:: bash
python manage.py db upgrade
flask db upgrade
If any error arises, restore the backup, fix the migration script and try again.

4
docs/kubernetes/1.6/README.md
View File

@ -82,7 +82,7 @@ And in the pod run the following command. The command uses following entries:
- `password` the chosen password for the user
```bash
python manage.py admin root example.com password
flask mailu admin root example.com password
```
Now you should be able to login on the mail account: `https://mail.example.com/admin`
@ -154,4 +154,4 @@ Wait for the pod to recreate and you're online!
Happy mailing!
Wait for the pod to recreate and you're online!
Happy mailing!
Happy mailing!