Commit 197cfe41 authored by Dave Lane's avatar Dave Lane Committed by GitHub
Browse files

Updated README to make it more germain to our fork

This updates the README from the official Mautic one (which is woefully out-of-date) and addresses some of the structural changes we've made to help bring it up-to-date and make it usable in our environment.
parent 363c1003
Docker Mautic Image
===================
<img src="https://www.mautic.org/media/images/github_readme.png" />
# Supported tags and respective `Dockerfile` links
- [`1.2.4-fpm`, `1.1-fpm`, `1-fpm`, `fpm` (*fpm/Dockerfile*)](https://github.com/mautic/docker-mautic/blob/master/fpm/Dockerfile)
# License
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).
Mautic (and this Docker Recipe) 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 this image
docker run --name some-mautic --link some-mysql:mysql -d mautic/mautic
The following environment variables are also honored for configuring your Mautic instance:
- `-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")
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.
If you'd like to be able to access the instance from the host without the container's IP, standard port mappings can be used:
docker run --name some-mautic --link some-mysql:mysql -p 8080:80 -d mautic
1. you need a Docker host configured to use both a current Docker and Docker Compose with network access and git installed.
Then, access it via `http://localhost:8080` or `http://host-ip:8080` in a browser.
1. make sure you have a MySQL or MariaDB running either on your Docker host, or in a container
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`):
1. clone this repo:
`git clone git@github.com:oeru/docker-mautic.git`
which will, by default, create a directory called 'docker-mautic'
docker run --name some-mautic -e MAUTIC_DB_HOST=10.1.2.3:3306 \
-e MAUTIC_DB_USER=... -e MAUTIC_DB_PASSWORD=... -d mautic/mautic
1. create a local docker-compose.yml by copying docker-compose.yml-sample:
`cd docker-mautic`
`cp docker-compose.yml-sample docker-compose.yml`
and the edit the file to specify the details of your MySQL or MariaDB database. You need to specify a user who has the ability to create a database. Also, if you're running an nginx container, you can tweak the ports assignments to make it publicly visible (I encourage defaulting to SSL!).
## ... via [`docker-compose`](https://github.com/docker/compose)
If you're running MySQL or MariaDB in another container, add another stanza to this yml file to describe it and link it with the mautic stanza!
Example `docker-compose.yml` for `mautic`:
mautic:
image: mautic/mautic
mautic:
image: kiwilightweight/mautic
links:
- mauticdb:mysql
ports:
- 8080:80
- ...
mauticdb:
image: mariadb
mauticdb:
image: mysql:5.6
environment:
MYSQL_ROOT_PASSWORD: example
1. adjust the nginx "default.conf" (replace it with "ssl.conf" if you want to offer secure hosting!) and set up the path to your repo in the yml file so that the nginx container can find the conf file.
Run `docker-compose up`, wait for it to initialize completely, and visit `http://localhost:8080` or `http://host-ip:8080`.
1. you also need to create a directory on your Docker host for your Mautic code, and reference it in the yml file.
# Supported Docker versions
1. then run
`docker-compose up`
to pull (if necessary) and run your mautic (and, if you're using it) your nginx container. If you're running it locally, access it via `http://localhost:8083` in a browser.
This image is officially supported on Docker version 1.7.1.
1. Run `docker-compose up`, wait for it to initialize completely, and visit `http://localhost:8080` or `http://host-ip:8080`.
# Supported Docker versions
Support for older versions (down to 1.0) is provided on a best-effort basis.
This has been tested on Docker 1.13.1
# User Feedback
## Issues
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.
If you have any problems with or questions about this image, please contact us through a [GitHub issue](https://github.com/oeru/docker-mautic/issues). We will endeavour to assist, although we're doing this through enlightened self-interest, so can't provide any guarantees!
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment