Repository files navigation

all Mautic 5 Docker images follow the following naming stategy.

<major.minor.patch>-<variant>

There are some defaults if parts are omitted:

• <minor.patch> is the latest release patch version in the latest minor version.

some examples:

• 5-apache: latest stable version of Mautic 5 of theapache variant
• 5.0-fpm: latest version in the 5.0 minor release in thefpm variant
• 5.0.3-apache: specific point release of theapache variant

The Docker images exist in 2 variants:

• apache: image based on the officialphp:apache images.
• fpm: image based on the officialphp:fpm images.

The latest supported Mautic PHP version is used the moment of generating of the image.

Each variant contains:

• the needed dependencies to run Mautic (e.g. PHP modules)
• the Mautic codebase installed via composer (see mautic/recommended-project)
• the needed files and configuration to run as a specific role

See theexamples explanation below how you could use them.

each image can be started in 3 modes:

• mautic_web: runs the Mautic webinterface
• mautic_worker: runs the worker processes to consume the messenger queues
• mautic_cron: runs the defined cronjobs

This allows you to use different scaling strategies to run the workers or crons, without having to maintain separate images.
Themautic_cron andmautic_worker require the codebase anyhow, as they execute console commands that need to bootstrap the full application.

Theexamples folder contains examples ofdocker-compose setups that use the Docker images.

• basic: standard example using theapache image withdoctrine as async queue.
• fpm-nginx: example using thefpm image in combination with annginx withdoctrine as async queue.
• rabbitmq-worker: example using theapache image withrabbitmq as async queue.

You can build your own images easily using thedocker build command in the root of this directory:

docker build . -f apache/Dockerfile -t mautic/mautic:5-apachedocker build . -f fpm/Dockerfile -t mautic/mautic:5-fpm

The images by default foresee following volumes to persist data (not taking into account e.g. database or queueing data, as that's not part of these images).

• config: the local config folder containinglocal.php,parameters_local.php, ...
• var/logs: the folder with logs
• docroot/media: the folder with uploaded and generated media files

The following environment variables can be used to configure how your setup should behave.There are 2 files where those settings can be set:

• the.env file:Should be used for all general variables for Mysql, PHP, ...
• the.mautic_env file:Should be used for all Mautic specific variables.

Those variables can also be set via theenvironment key on services defined in thedocker-compose.yml file.

• MYSQL_HOST: the MySQL host to connect to
• MYSQL_PORT: the MySQL port to use
• MYSQL_DATABASE: the database name to be used by Mautic
• MYSQL_USER: the MySQL user that has access to the database
• MYSQL_PASSWORD: the password for the MySQL user
• MYSQL_ROOT_PASSWORD: the password for the MySQL root user that is able to configure the above users and database

• PHP_INI_VALUE_DATE_TIMEZONE: defaults toUTC
• PHP_INI_VALUE_MEMORY_LIMIT: defaults to512M
• PHP_INI_VALUE_UPLOAD_MAX_FILESIZE: defaults to512M
• PHP_INI_VALUE_POST_MAX_FILESIZE: defaults to512M
• PHP_INI_VALUE_MAX_EXECUTION_TIME: defaults to300

• DOCKER_MAUTIC_ROLE: which role does the container has to perform.
  Defaults tomautic_web, other supported values aremautic_worker andmautic_cron.
• DOCKER_MAUTIC_LOAD_TEST_DATA: should the test data be loaded on start or not.
  Defaults tofalse, other supported value istrue.
  This variable is only usable when using theweb role.
• DOCKER_MAUTIC_RUN_MIGRATIONS: should the Doctrine migrations be executed on start.
  Defaults tofalse, other supported value istrue.
  This variable is only usable when using theweb role.
• DOCKER_MAUTIC_WORKERS_CONSUME_EMAIL: Number of workers to start consuming mails.
  Defaults to2
• DOCKER_MAUTIC_WORKERS_CONSUME_HIT: Number of workers to start consuming hits.
  Defaults to2
• DOCKER_MAUTIC_WORKERS_CONSUME_FAILED: Number of workers to start consuming failed e-mails.
  Defaults to2

Technically, every setting of Mautic you can set via the UI or via thelocal.php file can be set as environment variable.

e.g. themessenger_dsn_hit can be set via theMAUTIC_MESSENGER_DSN_HIT environment variable.
See the general Mautic documentation for more info.

Currently this image has no easy way to extend Mautic (e.g. adding extracomposer dependencies or installing extra plugins or themes).
This is an ongoing effort we hope to support in an upcoming 5.x release.

For now, please build your own images based on the official ones to add the needed dependencies, plugins and themes.

if you want to execute commands, you can make use ofdocker compose exec.

A full list of options for the command is availableon the help pages.
The most important flags used in the examples below are:

• -u www-data: execute as thewww-data user, which is the same user as the webserver runs. This ensures that e.g. file permissions after clearing the cache are correct.
• -w /var/www/html: set the working directory to the/var/www/html folder, which is the project root of Mautic.

Examples

• Open a shell in the runningmautic_web container:

  docker compose exec -u www-data -w /var/www/html mautic_web /bin/bash

• execute a command in the runningmautic_web container and return the output directly

  docker compose exec -u www-data -w /var/www/html mautic_web php ./bin/console

If you have any problems with or questions about this image, please contact us through aGitHub issue.

You can also reach the Mautic community through itsonline forums or theMautic Slack channel.

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through aGitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.