mirror of
https://github.com/Mailu/Mailu.git
synced 2024-12-12 10:45:38 +02:00
s/docker\-compose\([^\.]\)/docker compose\1/g
This commit is contained in:
Florent Daigniere
parent
ae3f656923
commit
bb5d007882
@ -10,7 +10,7 @@ These settings tell Mailu that the HTTP header with the remote client IP address
|
||||
For more information see the [configuration reference](https://mailu.io/1.9/configuration.html#advanced-settings).
|
||||
|
||||
One major change for the docker compose file is that the antispam container needs a fixed hostname [#1837](https://github.com/Mailu/Mailu/issues/1837).
|
||||
This is handled when you regenerate the docker-compose file. A fixed hostname is required to retain rspamd history.
|
||||
This is handled when you regenerate the docker compose file. A fixed hostname is required to retain rspamd history.
|
||||
|
||||
After changing mailu.env, it is required to recreate all containers for the changes to be propagated.
|
||||
|
||||
@ -314,8 +314,8 @@ v1.6.0 - 2019-01-18
|
||||
- Enhancement: Reverse proxy - Real ip header and mail-letsencrypt ([#358](https://github.com/Mailu/Mailu/issues/358))
|
||||
- Enhancement: Parametrize hosts ([#373](https://github.com/Mailu/Mailu/issues/373))
|
||||
- Enhancement: Expose ports in dockerfiles ([#392](https://github.com/Mailu/Mailu/issues/392))
|
||||
- Enhancement: Added webmail-imap dependency in docker-compose ([#403](https://github.com/Mailu/Mailu/issues/403))
|
||||
- Enhancement: Add environment variables to allow running outside of docker-compose ([#429](https://github.com/Mailu/Mailu/issues/429))
|
||||
- Enhancement: Added webmail-imap dependency in docker compose ([#403](https://github.com/Mailu/Mailu/issues/403))
|
||||
- Enhancement: Add environment variables to allow running outside of docker compose ([#429](https://github.com/Mailu/Mailu/issues/429))
|
||||
- Enhancement: Add original Delivered-To header to received messages ([#433](https://github.com/Mailu/Mailu/issues/433))
|
||||
- Enhancement: Use HOST_ADMIN in "Forwarding authentication server" ([#436](https://github.com/Mailu/Mailu/issues/436), [#437](https://github.com/Mailu/Mailu/issues/437))
|
||||
- Enhancement: Use POD_ADDRESS_RANGE for Dovecot ([#448](https://github.com/Mailu/Mailu/issues/448))
|
||||
|
||||
@ -19,7 +19,7 @@ Please put your text outside of the comment blocks to be visible. You can use th
|
||||
|
||||
### Environment
|
||||
|
||||
- [ ] docker-compose
|
||||
- [ ] docker compose
|
||||
- [ ] kubernetes
|
||||
- [ ] docker swarm
|
||||
|
||||
@ -61,7 +61,7 @@ Just saying "it doesn’t work as expected" is not useful. It's also helpful to
|
||||
Often it is very useful to include log fragments of the involved component.
|
||||
You can get the logs via `docker logs <container name> --tail 1000`.
|
||||
For example for the admin container: `docker logs mailu_admin_1 --tail 1000`
|
||||
or using docker-compose `docker-compose -f /mailu/docker-compose.yml logs --tail 1000 admin`
|
||||
or using docker compose `docker compose -f /mailu/docker-compose.yml logs --tail 1000 admin`
|
||||
|
||||
If you can find the relevant section, please share only the parts that seem relevant. If you have any logs, please enclose them in code tags, like so:
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
This is a new automatic release of Mailu. The new version can be seen in the tag name.
|
||||
The main version X.Y (e.g. 1.9) will always reflect the latest version of the branch. To update your Mailu installation simply pull the latest images `docker-compose pull && docker-compose up -d`.
|
||||
The main version X.Y (e.g. 1.9) will always reflect the latest version of the branch. To update your Mailu installation simply pull the latest images `docker compose pull && docker compose up -d`.
|
||||
The pinned version X.Y.Z (e.g. 1.9.1) is not updated. It is pinned to the commit that was used for creating this release. You can use a pinned version to make sure your Mailu installation is not suddenly updated when recreating containers. The pinned version allows the user to manually update. It also allows to go back to a previous pinned version.
|
||||
|
||||
To check what was changed:
|
||||
|
||||
@ -88,7 +88,7 @@ If RFC issue #1222 is accepted, Dovecot will need read-only access to the certif
|
||||
|
||||
- Path: `/mailu/data/`
|
||||
|
||||
Database files, like SQLite or PostgreSQL files. Databases don't perform well on network filesystems as they depend heavily on file locking and full controll on the database files. Making it unfit for concurrent access from multiple hosts. This directory should always live on a local filesystem. This makes it only usable in `docker-compose` deployments. Usage of this directory should be avoided in Kubernetes and Docker Swarm deployments. Some services will need to be improved to allow for this.
|
||||
Database files, like SQLite or PostgreSQL files. Databases don't perform well on network filesystems as they depend heavily on file locking and full controll on the database files. Making it unfit for concurrent access from multiple hosts. This directory should always live on a local filesystem. This makes it only usable in `docker compose` deployments. Usage of this directory should be avoided in Kubernetes and Docker Swarm deployments. Some services will need to be improved to allow for this.
|
||||
|
||||
#### admin data
|
||||
|
||||
@ -138,7 +138,7 @@ In the old situation, Maildir indexes are stored on the same volume. However, th
|
||||
|
||||
- Path: `/mailu/local` (new)
|
||||
|
||||
Persistent storage not suitable for replication. In `docker-compose` deployments it lives inside `/mailu` and in replicated deployments it should live somewhere on the local host machine.
|
||||
Persistent storage not suitable for replication. In `docker compose` deployments it lives inside `/mailu` and in replicated deployments it should live somewhere on the local host machine.
|
||||
|
||||
#### Mailqueue
|
||||
|
||||
@ -185,7 +185,7 @@ The final layout of the Mailu filesystem will look like:
|
||||
Where in replicated environments:
|
||||
|
||||
- `/mailu/config/`: should be a small, low performant and shared filesystem.
|
||||
- `/mailu/data`: should be avoided. More work will need to be done to configure external DB servers for relevant services. Ideally, this directory should only exist on docker-compose deployments.
|
||||
- `/mailu/data`: should be avoided. More work will need to be done to configure external DB servers for relevant services. Ideally, this directory should only exist on docker compose deployments.
|
||||
- `/mailu/local/`: Should exist only on local file systems of worker nodes.
|
||||
- `/mailu/mail`: A distributed filesystem with sufficient performance and storage requirements to hold and process all user mailboxes. Ideally only Maildir without indexes.
|
||||
|
||||
|
||||
@ -125,12 +125,12 @@ The following steps have to be taken to configure an additional symbol (rule) th
|
||||
#This file is LIVE reloaded by rspamd. Any changes are EFFECTIVE IMMEDIATELY.
|
||||
dummy.com
|
||||
|
||||
3. Reload Rspamd by stopping the Rspamd container and starting the Rspamd container again. Example for docker-compose setup:
|
||||
3. Reload Rspamd by stopping the Rspamd container and starting the Rspamd container again. Example for docker compose setup:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose scale antispam=0
|
||||
docker-compose scale antispam=1
|
||||
docker compose scale antispam=0
|
||||
docker compose scale antispam=1
|
||||
|
||||
4. (Optional) Check if the custom symbol is loaded. To access the Rspamd webgui, log in the Mailu administration web interface with a user that is an administrator and go to Antispam. In Rspamd webgui go to tab Symbols. Change the group drop-down box to local_bl. The following additional rule will be listed.
|
||||
|
||||
@ -163,8 +163,8 @@ Mailu rejects emails with file attachements it deems to be "executable" or other
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose exec antispam cat /etc/rspamd/local.d/forbidden_file_extension.map > overrides/rspamd/forbidden_file_extension.map
|
||||
docker-compose restart antispam
|
||||
docker compose exec antispam cat /etc/rspamd/local.d/forbidden_file_extension.map > overrides/rspamd/forbidden_file_extension.map
|
||||
docker compose restart antispam
|
||||
|
||||
Now the file `overrides/rspamd/forbidden_file_extension.map` can be edited, to make changes to the forbidden file extensions list.
|
||||
For the changes to take effect, rspamd must be restarted.
|
||||
@ -176,8 +176,8 @@ If configured to do so, Mailu uses a lightweight tool called `mraptor from oleto
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose exec antispam cat /etc/rspamd/local.d/composites.conf > overrides/rspamd/composites.conf
|
||||
docker-compose restart antispam
|
||||
docker compose exec antispam cat /etc/rspamd/local.d/composites.conf > overrides/rspamd/composites.conf
|
||||
docker compose restart antispam
|
||||
|
||||
Now the file `overrides/rspamd/composites.conf` can be edited, to override the mraptor configuration in rspamd.
|
||||
For the changes to take effect, rspamd must be restarted.
|
||||
|
||||
30
docs/cli.rst
30
docs/cli.rst
@ -19,7 +19,7 @@ alias
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
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
|
||||
@ -27,7 +27,7 @@ alias-delete
|
||||
|
||||
.. 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
|
||||
|
||||
|
||||
domain
|
||||
@ -35,7 +35,7 @@ domain
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose exec admin flask mailu domain example.net
|
||||
docker compose exec admin flask mailu domain example.net
|
||||
|
||||
|
||||
password
|
||||
@ -43,7 +43,7 @@ password
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose exec admin flask mailu password myuser example.net 'password123'
|
||||
docker compose exec admin flask mailu password myuser example.net 'password123'
|
||||
|
||||
|
||||
user
|
||||
@ -51,7 +51,7 @@ user
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose exec admin flask mailu user myuser example.net 'password123'
|
||||
docker compose exec admin flask mailu user myuser example.net 'password123'
|
||||
|
||||
|
||||
user-import
|
||||
@ -61,14 +61,14 @@ primary difference with simple `user` command is that password is being imported
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose run --rm admin flask mailu user-import myuser example.net '$6$51ebe0cb9f1dab48effa2a0ad8660cb489b445936b9ffd812a0b8f46bca66dd549fea530ce' 'SHA512-CRYPT'
|
||||
docker compose run --rm admin flask mailu user-import myuser example.net '$6$51ebe0cb9f1dab48effa2a0ad8660cb489b445936b9ffd812a0b8f46bca66dd549fea530ce' 'SHA512-CRYPT'
|
||||
|
||||
user-delete
|
||||
-----------
|
||||
|
||||
.. 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
|
||||
-------------
|
||||
@ -77,7 +77,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 exec -T admin flask mailu config-update --delete-objects
|
||||
cat mail-config.yml | docker compose exec -T admin flask mailu config-update --delete-objects
|
||||
|
||||
where mail-config.yml looks like:
|
||||
|
||||
@ -131,7 +131,7 @@ The purpose of this command is to export the complete configuration in YAML or J
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ docker-compose exec admin flask mailu config-export --help
|
||||
$ docker compose exec admin flask mailu config-export --help
|
||||
|
||||
Usage: flask mailu config-export [OPTIONS] [FILTER]...
|
||||
|
||||
@ -156,11 +156,11 @@ Attributes explicitly specified in filters are automatically exported: there is
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ docker-compose exec admin flask mailu config-export --output mail-config.yml
|
||||
$ docker compose exec admin flask mailu config-export --output mail-config.yml
|
||||
|
||||
$ docker-compose exec admin flask mailu config-export domain.dns_mx domain.dns_spf
|
||||
$ docker compose exec admin flask mailu config-export domain.dns_mx domain.dns_spf
|
||||
|
||||
$ docker-compose exec admin flask mailu config-export user.spam_threshold
|
||||
$ docker compose exec admin flask mailu config-export user.spam_threshold
|
||||
|
||||
config-import
|
||||
-------------
|
||||
@ -169,7 +169,7 @@ This command imports configuration data from an external YAML or JSON source.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
$ docker-compose exec admin flask mailu config-import --help
|
||||
$ docker compose exec admin flask mailu config-import --help
|
||||
|
||||
Usage: flask mailu config-import [OPTIONS] [FILENAME|-]
|
||||
|
||||
@ -184,11 +184,11 @@ This command imports configuration data from an external YAML or JSON source.
|
||||
-n, --dry-run Perform a trial run with no changes made.
|
||||
-?, -h, --help Show this message and exit.
|
||||
|
||||
The current version of docker-compose exec does not pass stdin correctly, so you have to user docker exec instead:
|
||||
The current version of docker compose exec does not pass stdin correctly, so you have to user docker exec instead:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker exec -i $(docker-compose ps -q admin) flask mailu config-import -nv < mail-config.yml
|
||||
docker exec -i $(docker compose ps -q admin) flask mailu config-import -nv < mail-config.yml
|
||||
|
||||
mail-config.yml contains the configuration and looks like this:
|
||||
|
||||
|
||||
@ -138,7 +138,7 @@ WEBSITE=https://mailu.io
|
||||
# Log driver for front service. Possible values:
|
||||
# json-file (default)
|
||||
# journald (On systemd platforms, useful for Fail2Ban integration)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker compose log` for front!)
|
||||
LOG_DRIVER=json-file
|
||||
|
||||
# Docker-compose project name, this will prepended to containers names.
|
||||
|
||||
@ -91,7 +91,7 @@ The Docker website is full of `detailed instructions`_
|
||||
about setting up a proper Docker install. Default configuration should be
|
||||
suited for Mailu.
|
||||
|
||||
Additionally, you must install ``docker-compose`` by following the instructions
|
||||
Additionally, you must install ``docker compose`` by following the instructions
|
||||
from the `Docker website`_ if you plan on using the Compose flavor. Compose is a
|
||||
management tool for Docker, especially suited for multiple containers systems
|
||||
like Mailu.
|
||||
@ -121,8 +121,8 @@ Once everything is setup, you should be able to run the following commands
|
||||
Built: Mon May 2 00:06:51 2016
|
||||
OS/Arch: linux/amd64
|
||||
|
||||
$ docker-compose version
|
||||
docker-compose version 1.7.1, build 6c29830
|
||||
$ docker compose version
|
||||
docker compose version 1.7.1, build 6c29830
|
||||
docker-py version: 1.8.1
|
||||
CPython version: 3.5.1
|
||||
OpenSSL version: OpenSSL 1.0.2h 3 May 2016
|
||||
|
||||
@ -95,7 +95,7 @@ You may now start Mailu. Move the to the Mailu directory and run:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose up -d
|
||||
docker compose up -d
|
||||
|
||||
Finally, you need an admin user account.
|
||||
|
||||
@ -106,7 +106,7 @@ Else, if you don't go with the automatic way, you need to manually create the ad
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose exec admin flask mailu admin me example.net 'password'
|
||||
docker compose exec admin flask mailu admin me example.net 'password'
|
||||
|
||||
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.
|
||||
|
||||
@ -153,25 +153,25 @@ After that you can run:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose up -d
|
||||
docker compose up -d
|
||||
|
||||
If you wish to run commands inside a container, simply run (example):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose exec admin ls -lah /
|
||||
docker compose exec admin ls -lah /
|
||||
|
||||
Or if you wish to start a shell for debugging:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose exec admin sh
|
||||
docker compose exec admin sh
|
||||
|
||||
Finally, if you need to install packages inside the containers for debugging:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose exec admin apk add --no-cache package-name
|
||||
docker compose exec admin apk add --no-cache package-name
|
||||
|
||||
Reviewing
|
||||
---------
|
||||
@ -215,8 +215,8 @@ For example, to test PR #500 against master, reviewers can use:
|
||||
|
||||
export DOCKER_ORG="mailuci"
|
||||
export MAILU_VERSION="pr-500"
|
||||
docker-compose pull
|
||||
docker-compose up -d
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
|
||||
You can now test the PR. Play around. See if (external) mails work. Check for whatever functionality the PR is
|
||||
trying to fix. When happy, you can approve the PR. When running into failures, mark the review as
|
||||
|
||||
@ -15,11 +15,11 @@ This means it is not possible to switch the database back-end used by roundcube
|
||||
|
||||
To switch to a different database back-end:
|
||||
|
||||
1. Run config-export to export the configuration. E.g. `docker-compose exec admin flask mailu config-export --secrets --output mail-config.yml`
|
||||
1. Run config-export to export the configuration. E.g. `docker compose exec admin flask mailu config-export --secrets --output mail-config.yml`
|
||||
2. Set up your new database server. Refer to the subsequent sections for tips for creating the database.
|
||||
3. Modify the database settings (DB_*) in mailu.env. Refer to the :ref:`configuration guide (link) <db_settings>` for the exact settings.
|
||||
4. Start your Mailu deployment.
|
||||
5. Run config-import to import the configuration. E.g. `docker exec -i $(docker-compose ps -q admin) flask mailu config-import -v < mail-config.yml`
|
||||
5. Run config-import to import the configuration. E.g. `docker exec -i $(docker compose ps -q admin) flask mailu config-import -v < mail-config.yml`
|
||||
|
||||
Mailu has now been switched to the new database back-end. The Mailu configuration has also been migrated.
|
||||
|
||||
@ -114,22 +114,22 @@ Prepare the environment. Mailu must not be in use. Only the database container.
|
||||
|
||||
1. Open a terminal.
|
||||
2. `cd /mailu`
|
||||
3. `docker-compose -p mailu down`
|
||||
4. `docker-compose -p mailu up -d database`
|
||||
3. `docker compose -p mailu down`
|
||||
4. `docker compose -p mailu up -d database`
|
||||
|
||||
Create the dump SQL file for recreating the database.
|
||||
|
||||
1. `docker-compose -p mailu exec database /bin/bash`
|
||||
1. `docker compose -p mailu exec database /bin/bash`
|
||||
2. `pg_dump -h database -p 5432 -U mailu > /backup/backup_db.sql`
|
||||
3. Enter the password. See the value of DB_PW in mailu.env.
|
||||
4. `exit`
|
||||
5. The dump is saved to /mailu/data/psql_backup/backup_db.sql.
|
||||
6. `docker-compose -p mailu down`
|
||||
6. `docker compose -p mailu down`
|
||||
|
||||
Prepare the new PostgreSQL deployment.
|
||||
|
||||
1. `mkdir -p /mailu/data/external_psql/pgdata`
|
||||
2. Create the file docker-compose-postgresql.yml with the following contents:
|
||||
2. Create the file docker compose-postgresql.yml with the following contents:
|
||||
|
||||
.. code-block:: docker
|
||||
|
||||
@ -147,12 +147,12 @@ Prepare the new PostgreSQL deployment.
|
||||
- "/mailu/data/psql_backup:/dump"
|
||||
|
||||
|
||||
3. `docker-compose -f docker-compose-postgresql.yml up -d`
|
||||
4. `docker-compose -f docker-compose-postgresql.yml exec database /bin/bash`
|
||||
3. `docker compose -f docker compose-postgresql.yml up -d`
|
||||
4. `docker compose -f docker compose-postgresql.yml exec database /bin/bash`
|
||||
5. `cat /dump/backup_db.sql | psql -h localhost -p 5432 -U mailu`
|
||||
6. `exit`
|
||||
7. `docker-compose -f docker-compose-postgresql.yml down`
|
||||
8. Remove the file docker-compose-postgresql.yml.
|
||||
7. `docker compose -f docker compose-postgresql.yml down`
|
||||
8. Remove the file docker compose-postgresql.yml.
|
||||
|
||||
The new PostgreSQL deployment has the dump loaded now. Now it is time to modify Mailu to use the official PostgreSQL docker image.
|
||||
|
||||
@ -199,7 +199,7 @@ to
|
||||
|
||||
Mailu is now configured to use the official PostgreSQL docker image. Bring your new deployment online
|
||||
|
||||
1. `docker-compose -p mailu up -d`
|
||||
1. `docker compose -p mailu up -d`
|
||||
|
||||
Optionally you can remove left-over files which were used by the old database:
|
||||
|
||||
|
||||
14
docs/faq.rst
14
docs/faq.rst
@ -401,8 +401,8 @@ down and up again. A container restart is not sufficient.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose down && \
|
||||
docker-compose up -d
|
||||
docker compose down && \
|
||||
docker compose up -d
|
||||
|
||||
*Issue reference:* `615`_.
|
||||
|
||||
@ -479,8 +479,8 @@ to check the logs.
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose logs front | less -R
|
||||
docker-compose exec front less /var/log/letsencrypt/letsencrypt.log
|
||||
docker compose logs front | less -R
|
||||
docker compose exec front less /var/log/letsencrypt/letsencrypt.log
|
||||
|
||||
Common problems:
|
||||
|
||||
@ -551,7 +551,7 @@ See the :ref:`[configuration reference <reverse_proxy_headers>` for more informa
|
||||
Assuming you have a working Fail2Ban installation on the host running your Docker containers,
|
||||
follow these steps:
|
||||
|
||||
1. In the mailu docker-compose set the logging driver of the front container to journald; and set the tag to mailu-front
|
||||
1. In the mailu docker compose set the logging driver of the front container to journald; and set the tag to mailu-front
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@ -585,7 +585,7 @@ follow these steps:
|
||||
|
||||
The above will block flagged IPs for a week, you can of course change it to your needs.
|
||||
|
||||
4. In the mailu docker-compose set the logging driver of the Admin container to journald; and set the tag to mailu-admin
|
||||
4. In the mailu docker compose set the logging driver of the Admin container to journald; and set the tag to mailu-admin
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
@ -790,7 +790,7 @@ In many cases, Docker Compose will complain about the yaml syntax because it is
|
||||
Unless your distribution has proper up-to-date packages for Compose, we strongly advise that you install it either:
|
||||
|
||||
- from the Docker-CE repositories along with Docker CE itself,
|
||||
- from PyPI using `pip install docker-compose` or
|
||||
- from PyPI using `pip install docker compose` or
|
||||
- from Github by downloading it directly.
|
||||
|
||||
Detailed instructions can be found at https://docs.docker.com/compose/install/
|
||||
|
||||
@ -14,9 +14,9 @@ simply pull the latest images and recreate the containers :
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose pull
|
||||
docker-compose down
|
||||
docker-compose up -d
|
||||
docker compose pull
|
||||
docker compose down
|
||||
docker compose up -d
|
||||
|
||||
Monitoring the mail server
|
||||
--------------------------
|
||||
@ -25,7 +25,7 @@ Logs are managed by Docker directly. You can easily read your logs using:
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose logs
|
||||
docker compose logs
|
||||
|
||||
Docker is able to forward logs to multiple log engines. Read the following documentation for details: https://docs.docker.com/engine/admin/logging/overview/.
|
||||
|
||||
|
||||
@ -382,9 +382,9 @@ For this upgrade it is necessary to bring the project down and up, due to networ
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose pull
|
||||
docker-compose down --remove-orphans
|
||||
docker-compose up -d
|
||||
docker compose pull
|
||||
docker compose down --remove-orphans
|
||||
docker compose up -d
|
||||
|
||||
After everything runs successfully, ``/mailu/certs/dhparam.pem`` is no longer needed and can be deleted.
|
||||
It's included in the Mailu distribution by default now. Also the old ``.env`` can be deleted.
|
||||
@ -441,8 +441,8 @@ were removed (e.g. rmilter):
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
docker-compose pull
|
||||
docker-compose up -d --remove-orphans
|
||||
docker compose pull
|
||||
docker compose up -d --remove-orphans
|
||||
|
||||
If you experience problems when upgrading, feel free to post issues and contact
|
||||
us on our chat channel for emergency support.
|
||||
|
||||
@ -67,7 +67,7 @@ Make sure that you test properly before going live!
|
||||
- Try to send an email to an external service
|
||||
- On the external service, verify that DKIM and SPF are listed as passing
|
||||
- Try to receive an email from an external service
|
||||
- Check the logs (``docker-compose logs -f servicenamehere``) to look for
|
||||
- Check the logs (``docker compose logs -f servicenamehere``) to look for
|
||||
warnings or errors
|
||||
- Use an open relay checker like `mxtoolbox`_
|
||||
to ensure you're not contributing to the spam problem on the internet.
|
||||
|
||||
@ -161,7 +161,7 @@ DOMAIN_REGISTRATION=true
|
||||
# Log driver for front service. Possible values:
|
||||
# json-file (default)
|
||||
# journald (On systemd platforms, useful for Fail2Ban integration)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker compose log` for front!)
|
||||
# LOG_DRIVER={{ log_driver or 'json-file' }}
|
||||
|
||||
# Docker-compose project name, this will prepended to containers names.
|
||||
|
||||
@ -31,12 +31,12 @@ files before going any further.</p>
|
||||
command using <code>-p mailu</code> flag for project name.</p>
|
||||
|
||||
<pre><code>cd {{ root }}
|
||||
docker-compose -p mailu up -d
|
||||
docker compose -p mailu up -d
|
||||
</pre></code>
|
||||
|
||||
Before you can use Mailu, you must create the primary administrator user account. This should be {{ postmaster }}@{{ domain }}. Use the following command, changing PASSWORD to your liking:
|
||||
|
||||
<pre><code>docker-compose -p mailu exec admin flask mailu admin {{ postmaster }} {{ domain }} PASSWORD
|
||||
<pre><code>docker compose -p mailu exec admin flask mailu admin {{ postmaster }} {{ domain }} PASSWORD
|
||||
</pre></code>
|
||||
|
||||
<p>Login to the admin interface to change the password for a safe one, at
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
echo "Users tests ..."
|
||||
# Should fail, admin is already auto-created
|
||||
docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu admin admin mailu.io 'FooBar' && exit 1
|
||||
docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu admin admin mailu.io 'FooBar' && exit 1
|
||||
echo "The above error was intended!"
|
||||
# Should not fail, but does nothing; ifmissing mode
|
||||
docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu admin admin mailu.io 'FooBar' --mode=ifmissing || exit 1
|
||||
docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu admin admin mailu.io 'FooBar' --mode=ifmissing || exit 1
|
||||
# Should not fail and update the password; update mode
|
||||
docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu admin admin mailu.io 'password' --mode=update || exit 1
|
||||
docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu user user mailu.io 'password' || exit 1
|
||||
docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu user 'user/with/slash' mailu.io 'password' || exit 1
|
||||
docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu admin admin mailu.io 'password' --mode=update || exit 1
|
||||
docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu user user mailu.io 'password' || exit 1
|
||||
docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu user 'user/with/slash' mailu.io 'password' || exit 1
|
||||
echo "User testing successful!"
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
cat << EOF | docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
cat << EOF | docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
users:
|
||||
- localpart: forwardinguser
|
||||
password_hash: "\$1\$F2OStvi1\$Q8hBIHkdJpJkJn/TrMIZ9/"
|
||||
@ -9,7 +9,7 @@ EOF
|
||||
|
||||
python3 tests/forward_test.py
|
||||
|
||||
cat << EOF | docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
cat << EOF | docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
users:
|
||||
- localpart: forwardinguser
|
||||
password_hash: "\$1\$F2OStvi1\$Q8hBIHkdJpJkJn/TrMIZ9/"
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
cat << EOF | docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
cat << EOF | docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
aliases:
|
||||
- localpart: alltheusers
|
||||
domain: mailu.io
|
||||
@ -7,6 +7,6 @@ EOF
|
||||
|
||||
python3 tests/alias_test.py
|
||||
|
||||
cat << EOF | docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
cat << EOF | docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
aliases: []
|
||||
EOF
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
cat << EOF | docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
cat << EOF | docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
users:
|
||||
- localpart: replyuser
|
||||
password_hash: "\$1\$F2OStvi1\$Q8hBIHkdJpJkJn/TrMIZ9/"
|
||||
@ -10,7 +10,7 @@ EOF
|
||||
|
||||
python3 tests/reply_test.py
|
||||
|
||||
cat << EOF | docker-compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
cat << EOF | docker compose -f tests/compose/core/docker-compose.yml exec -T admin flask mailu config-update -v 1
|
||||
users:
|
||||
- localpart: replyuser
|
||||
password_hash: "\$1\$F2OStvi1\$Q8hBIHkdJpJkJn/TrMIZ9/"
|
||||
|
||||
@ -128,7 +128,7 @@ WEBSITE=https://mailu.io
|
||||
# Log driver for front service. Possible values:
|
||||
# json-file (default)
|
||||
# journald (On systemd platforms, useful for Fail2Ban integration)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker compose log` for front!)
|
||||
# LOG_DRIVER=json-file
|
||||
|
||||
# Docker-compose project name, this will prepended to containers names.
|
||||
|
||||
@ -128,7 +128,7 @@ WEBSITE=https://mailu.io
|
||||
# Log driver for front service. Possible values:
|
||||
# json-file (default)
|
||||
# journald (On systemd platforms, useful for Fail2Ban integration)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker compose log` for front!)
|
||||
# LOG_DRIVER=json-file
|
||||
|
||||
# Docker-compose project name, this will prepended to containers names.
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
echo "Creating user required for next test ..."
|
||||
# Should not fail and update the password; update mode
|
||||
docker-compose -f tests/compose/filters/docker-compose.yml exec -T admin flask mailu admin admin mailu.io 'password' --mode=update || exit 1
|
||||
docker-compose -f tests/compose/filters/docker-compose.yml exec -T admin flask mailu user user mailu.io 'password' || exit 1
|
||||
docker compose -f tests/compose/filters/docker-compose.yml exec -T admin flask mailu admin admin mailu.io 'password' --mode=update || exit 1
|
||||
docker compose -f tests/compose/filters/docker-compose.yml exec -T admin flask mailu user user mailu.io 'password' || exit 1
|
||||
echo "User created successfully"
|
||||
|
||||
@ -128,7 +128,7 @@ WEBSITE=https://mailu.io
|
||||
# Log driver for front service. Possible values:
|
||||
# json-file (default)
|
||||
# journald (On systemd platforms, useful for Fail2Ban integration)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker compose log` for front!)
|
||||
# LOG_DRIVER=json-file
|
||||
|
||||
# Docker-compose project name, this will prepended to containers names.
|
||||
|
||||
@ -22,7 +22,7 @@ containers = []
|
||||
def stop(exit_code):
|
||||
print_logs()
|
||||
sys.stdout.flush()
|
||||
print(subprocess.check_output("docker-compose -f " + compose_file + " down", shell=True).decode())
|
||||
print(subprocess.check_output("docker compose -f " + compose_file + " down", shell=True).decode())
|
||||
sys.exit(exit_code)
|
||||
|
||||
def health_checks(deadline):
|
||||
@ -88,7 +88,7 @@ def hooks():
|
||||
sys.stdout.flush()
|
||||
deadline=datetime.datetime.now()+datetime.timedelta(minutes=timeout)
|
||||
deadline=calendar.timegm(deadline.timetuple())
|
||||
print(subprocess.check_output("docker-compose -f " + compose_file + " up -d", shell=True).decode())
|
||||
print(subprocess.check_output("docker compose -f " + compose_file + " up -d", shell=True).decode())
|
||||
print()
|
||||
print(Fore.LIGHTMAGENTA_EX + "Sleeping for 10s" + Style.RESET_ALL)
|
||||
time.sleep(10)
|
||||
|
||||
@ -128,7 +128,7 @@ WEBSITE=https://mailu.io
|
||||
# Log driver for front service. Possible values:
|
||||
# json-file (default)
|
||||
# journald (On systemd platforms, useful for Fail2Ban integration)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker compose log` for front!)
|
||||
# LOG_DRIVER=json-file
|
||||
|
||||
# Docker-compose project name, this will prepended to containers names.
|
||||
|
||||
@ -128,7 +128,7 @@ WEBSITE=https://mailu.io
|
||||
# Log driver for front service. Possible values:
|
||||
# json-file (default)
|
||||
# journald (On systemd platforms, useful for Fail2Ban integration)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker-compose log` for front!)
|
||||
# syslog (Non systemd platforms, Fail2Ban integration. Disables `docker compose log` for front!)
|
||||
# LOG_DRIVER=json-file
|
||||
|
||||
# Docker-compose project name, this will prepended to containers names.
|
||||
|
||||
Loading…
Reference in New Issue
Block a user