diff --git a/docker/README.md b/docker/README.md index 9049f62..7d06757 100644 --- a/docker/README.md +++ b/docker/README.md @@ -11,18 +11,25 @@ WORK-IN-PROGRESS mkdir /opt/Zabbix-Mailgraph/config mkdir /opt/Zabbix-Mailgraph/templates ``` -- Create a new `config.json` in the config directory and configure accordingly (refer to the wiki for more detailed instructions or use the `config.json.template` as a boilerplate). -- Deploy the mailGraph container, preferably using `docker-compose`. +- Create a new `config.json` in the above `config` directory and configure accordingly (refer to the wiki for more detailed instructions or use the `config.json.template` as a boilerplate). +- Copy the `plain.template` and `html.template` into the above `templates` directory. +- Deploy the mailGraph container, preferably using `docker-compose`: -- Adopt and configure the `docker-compose.yml` file to your needs; -- Configure `RESTART_POLICY=unless-stopped` in a file name `.env` (same directory as `docker-compose`). -- Start the container: `docker-compose -D up` +- Start the container: `docker-compose -D up`. - Follow best-practices on your applicable Linux version to ensure the container is started after a reboot. +When running: +- mailGraph is exposed on port `9080` (point the Zabbix webhook to this location). +- Apache logging is exposed on `/opt/Zabbix-Mailgraph/apache.log`. + ## Testing and Debugging ## -- Display currently running containers `docker ps` -- Execute `docker exec -it sh` for a shell into the container -- Following the instructions in the Wiki on troubleshooting and debugging -- When done testing, `exit` the container +- Display currently running containers `docker ps`. +- Execute `docker exec -it sh` for a shell into the container. +- Following the instructions in the Wiki on troubleshooting and debugging, i.e.: +-- `cd /var/www/site/public` +-- `php mailGraph.test test` +- When done testing, `exit` the container. ## Periodic cleanup of images and logs ## The following command must be run on a regular basis to clean up images and logs (add to cron for example):