Skip to content

Latest commit

 

History

History
178 lines (125 loc) · 7.01 KB

README.md

File metadata and controls

178 lines (125 loc) · 7.01 KB
Raw

Docker Mautic Image

License

Mautic is distributed under the GPL v3 license. Full details of the license can be found in the Mautic GitHub repository.

How to use this image

You can access and customize Docker Mautic from Official Docker Hub image.

Pulling image from Docker Hub

If you want to pull the latest stable image from DockerHub:

docker pull mautic/mautic:latest

You can use the beta images to test latest beta releases of Mautic with current PHP version.

Running Basic Container

Setting up MySQL Server:

$ docker volume create mysql_data

$ docker run --name percona -d \
    -p 3306:3306 \
    -e MYSQL_ROOT_PASSWORD=mypassword \
    -v mysql_data:/var/lib/mysql \
    percona/percona-server:5.7 \
     --character-set-server=utf8mb4 --collation-server=utf8mb4_general_ci

Running Mautic:

$ docker volume create mautic_data

$ docker run --name mautic -d \
    --restart=always \
    -e MAUTIC_DB_HOST=127.0.0.1 \
    -e MAUTIC_DB_USER=root \
    -e MAUTIC_DB_PASSWORD=mypassword \
    -e MAUTIC_DB_NAME=mautic \
    -e MAUTIC_RUN_CRON_JOBS=true \
    -e MAUTIC_TRUSTED_PROXIES=0.0.0.0/0 \
    -p 8080:80 \
    -v mautic_data:/var/www/html \
    mautic/mautic:latest

This will run a basic mysql service within Mautic on http://localhost:8080.

Customizing Mautic Container

The following environment variables are also honored for configuring your Mautic instance:

Database Options

  • -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_TRUSTED_PROXIES=... (defaults to empty) If it's Mautic behind a reverse proxy you can set a list of comma-separated CIDR network addresses it sets those addresses as trusted proxies. You can use 0.0.0.0/0 or See documentation
  • -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

Enable / Disable Features

  • -e MAUTIC_TESTER=... (defaults to empty) Enables Mautic Github Pull Tester documentation

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

On first run Mautic is unpacked at /var/www/html. You need to attach a volume on this path to persist data.

Mautic Versioning

Mautic Docker has two ENV that you can specify an version do start your new container:

  • -e MAUTIC_VERSION (Defaults to "2.15.0")
  • -e MAUTIC_SHA1 (Defalts to "b07bd42bb092cc96785d2541b33700b55f74ece7")

Accesing the Instance

Access your new Mautic on http://localhost:8080 or http://host-ip:8080 in a browser.

... via docker-compose

Example docker-compose.yml for mautic:

version: '2'

services:

  mauticdb:
    image: percona/percona-server:5.7
    container_name: mauticdb
    volumes:
      - mysql_data:/var/lib/mysql
    environment:
      - MYSQL_ROOT_PASSWORD=mysecret
    command:
      --character-set-server=utf8mb4 --collation-server=utf8mb4_general_ci
    networks:
      - mautic-net

  mautic:
    image: mautic/mautic:latest
    container_name: mautic
    links:
      - mauticdb:mysql
    depends_on:
      - mauticdb
    ports:
      - 8080:80
    volumes:
      - mautic_data:/var/www/html
    environment:
      - MAUTIC_DB_HOST=mauticdb
      - MYSQL_PORT_3306_TCP=3306
      - MAUTIC_DB_USER=root
      - MAUTIC_DB_PASSWORD=mysecret
      - MAUTIC_DB_NAME=mautic
      - MAUTIC_RUN_CRON_JOBS=true
    networks:
      - mautic-net

volumes:
  mysql_data:
    driver: local
  mautic_data:
    driver: local
networks:
  mautic-net:
    driver: bridge

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.

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

Issues

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

You can also reach the Mautic community through its online forums or the Mautic Slack channel.

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, 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.