Mautic is distributed under the GPL v3 license. Full details of the license can be found in the [Mautic GitHub repository](https://github.com/mautic/mautic/blob/staging/LICENSE.txt).
# How to use Docker-Mautic
Docker-Mautic provides a basic environment for Mautic to run correctly.
Docker images are always simple and functional by design, if you need to add specific features to your Mautic Setup just create a new image based on this official image. You can access and customize Docker Mautic from [Official Docker Hub image](https://hub.docker.com/r/mautic/mautic/).
*This repository refers to Mautic 3 Series. If you would like information about Mautic 2, see [README](https://github.com/mautic/docker-mautic/blob/mautic4/mautic2.x/README.md) at 'mautic2.x' folder.*
# Pulling Mautic images from Docker Hub
If you want to pull the latest **stable** image from Mautic 3 Series on DockerHub:
```
docker pull mautic/mautic:v4
```
***Note that during the 4.0.x period, the 'mautic/mautic:latest' tag still refers to Mautic 2 for backward compatibility. If you intend to use Mautic 2, use the 'mautic/mautic:v2' tag instead of 'mautic/mautic:latest'.***
If you want to pull the latest **stable** image from Mautic 4 Series on DockerHub:
```
docker pull mautic/mautic:v4
```
If you want to pull the latest **stable** image based on Apache2 from Mautic 4 Series on DockerHub:
```
docker pull mautic/mautic:v4-apache
```
If you want to pull the latest **stable** image based on FPM from Mautic 4 Series on DockerHub:
```
docker pull mautic/mautic:v4-fpm
```
If you want to pull the latest **stable** image from Mautic 3 Series on DockerHub:
```
docker pull mautic/mautic:v3
```
If you want to pull the latest **stable** image based on Apache2 from Mautic 3 Series on DockerHub:
```
docker pull mautic/mautic:v3-apache
```
If you want to pull the latest **stable** image based on FPM from Mautic 3 Series on DockerHub:
```
docker pull mautic/mautic:v3-fpm
```
You can build your own containers easily using the docker build command in the root of this directory:
```
docker build . -f apache/Dockerfile -t mautic/mautic:v4-apache
docker build . -f fpm/Dockerfile -t mautic/mautic:v4-fpm
```
- `-e MAUTIC_DB_HOST=...` (defaults to the IP and port of the linked `mysql` container)
- `-e MAUTIC_DB_USER=...` (defaults to "root")
- `-e MAUTIC_DB_PASSWORD=...` (defaults to the value of the `MYSQL_ROOT_PASSWORD` environment variable from the linked `mysql` container)
- `-e MAUTIC_DB_NAME=...` (defaults to "mautic")
- `-e MAUTIC_DB_TABLE_PREFIX=...` (defaults to empty) Add prefix do Mautic Tables. Very useful when migrate existing databases from another server to docker.
If you'd like to use an external database instead of a linked `mysql` container, specify the hostname and port with `MAUTIC_DB_HOST` along with the password in `MAUTIC_DB_PASSWORD` and the username in `MAUTIC_DB_USER` (if it is something other than `root`).
If the `MAUTIC_DB_NAME` specified does not already exist on the given MySQL server, it will be created automatically upon startup of the `mautic` container, provided that the `MAUTIC_DB_USER` specified has the necessary permissions to create it.
### Mautic Options
- `-e MAUTIC_RUN_CRON_JOBS=...` (defaults to true - enabled) If set to true runs mautic cron jobs using included cron daemon
- `-e MAUTIC_RUN_MIGRATIONS=...` (defaults to false - disabled) If set to true runs database migrations automatically on startup.
- `-e MAUTIC_TRUSTED_PROXIES=...` (defaults to empty) If Mautic sits behind a reverse proxy, you can set a json array of CIDR network addresses here, and mautic will set those addresses as trusted proxies. You can use `["0.0.0.0/0"]` or See [documentation](http://symfony.com/doc/current/request/load_balancer_reverse_proxy.html)
- `-e MAUTIC_CRON_HUBSPOT=...` (defaults to empty) Enables mautic crons for Hubspot CRM integration
- `-e MAUTIC_CRON_SALESFORCE=...` (defaults to empty) Enables mautic crons for Salesforce integration
- `-e MAUTIC_CRON_PIPEDRIVE=...` (defaults to empty) Enables mautic crons for Pipedrive CRM integration
- `-e MAUTIC_CRON_ZOHO=...` (defaults to empty) Enables mautic crons for Zoho CRM integration
- `-e MAUTIC_CRON_SUGARCRM=...` (defaults to empty) Enables mautic crons for SugarCRM integration
- `-e MAUTIC_CRON_DYNAMICS=...` (defaults to empty) Enables mautic crons for Dynamics CRM integration
### PHP options
- `-e PHP_INI_DATE_TIMEZONE=...` (defaults to `UTC`) Set PHP timezone
- `-e PHP_MEMORY_LIMIT=...` (defaults to `256M`) Set PHP memory limit
- `-e PHP_MAX_UPLOAD=...` (defaults to `20M`) Set PHP upload max file size
- `-e PHP_MAX_EXECUTION_TIME=...` (defaults to `300`) Set PHP max execution time
### PHP options
- `-e PHP_INI_DATE_TIMEZONE=...` (defaults to `UTC`) Set PHP timezone
- `-e PHP_MEMORY_LIMIT=...` (defaults to `256M`) Set PHP memory limit
- `-e PHP_MAX_UPLOAD=...` (defaults to `20M`) Set PHP upload max file size
- `-e PHP_MAX_EXECUTION_TIME=...` (defaults to `300`) Set PHP max execution time
### Persistent Data Volumes
Mautic Docker has two ENV that you can specify an version do start your new container:
- `-e MAUTIC_VERSION` (Defaults to "3.0.0")
- `-e MAUTIC_SHA1` (Defalts to "ed4287367b8484aa146a1fa904b261ab30d9c6e7")
### Automated installation
If you wish your mautic instance to automatically run the installer when the container is first started, provide the following environment variables:
- `-e MAUTIC_URL` The URL at which your mautic instance will be accessed
- `-e MAUTIC_ADMIN_EMAIL` The email address of your initial admin user
- `-e MAUTIC_ADMIN_PASSWORD` The password of your initial admin user
You can also optionally provide other installation variables:
- `-e MAUTIC_INSTALL_FORCE` If the URL used above is HTTP instead of HTTPS, automated installation will fail. Set to true to allow this.
- `-e MAUTIC_ADMIN_USERNAME` The username of your initial admin user
- `-e MAUTIC_ADMIN_FIRSTNAME` The first name of your initial admin user
- `-e MAUTIC_ADMIN_LASTNAME` The last name of your initial admin user
### Mautic configuration
Additional configuration variables can be added to mautic's local config by prepending them with `MAUTIC_CONFIG_`. This will be re-applied every time the container is re-started, so can be used for external config management of mautic instances.
- `-e MAUTIC_CONFIG_DEBUG=1` Set debug=1 in `local.php`
## Accesing the Instance
If you change the *Site Address* of *Mautic General Settings tab* to HTTPS (behind a reverse proxy), you can use `0.0.0.0/0` as Trusted Proxies to avoid a redirect loop error. See [documentation](http://symfony.com/doc/current/request/load_balancer_reverse_proxy.html)
## ... via [`docker-compose`](https://github.com/docker/compose)
Run `docker-compose up`, wait for it to initialize completely, and visit `http://localhost:8080` or `http://host-ip:8080`.
> This compose file was tested on compose file version 3.0+ (docker engine 1.13.0+), see the relation of compose file and docker engine [here](https://docs.docker.com/compose/compose-file/compose-versioning/).
# Supported Docker versions
This image is officially supported on Docker version 1.7.1.
Support for older versions (down to 1.0) is provided on a best-effort basis.
# User Feedback
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/mautic/docker-mautic/issues).
You can also reach the Mautic community through its [online forums](https://www.mautic.org/community/) or the [Mautic Slack channel](https://www.mautic.org/slack/).
## Contributing
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 a [GitHub issue](https://github.com/mautic/docker-mautic/issues), 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.