From 12c9f1e3319f08722b3c414ff87204af9c957ba1 Mon Sep 17 00:00:00 2001 From: Mark Oudsen Date: Mon, 5 May 2025 19:00:32 +0200 Subject: [PATCH] v0.9.1 - Initial public beta release for testing purposes --- docker/README.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/docker/README.md b/docker/README.md index 2d34955..9049f62 100644 --- a/docker/README.md +++ b/docker/README.md @@ -2,6 +2,8 @@ With the following instructions, mailGraph can be run in a Docker container. Every new version of mailGraph will also be deployed to Docker Hub. +WORK-IN-PROGRESS + ## Instructions - Plain vanilla deployment ## - Create a directory structure on your system as follows: ``` @@ -14,15 +16,21 @@ Every new version of mailGraph will also be deployed to Docker Hub. -- 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` +- Follow best-practices on your applicable Linux version to ensure the container is started after a reboot. ## Testing and Debugging ## - Display currently running containers `docker ps` -- Execute `docker exec -it sh` for a shell into the container +- 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 ## 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): +- `docker exec -it cleanup` + +## Custom deployment ## In case you like to adjust the container to your needs, you can adopt and modiyfy the provisioned scripts and files in this directory. +Please do not forget to modify the repository name in `build.sh` and `docker-compose.yml`. ## Special thank you ## I would like to express my gratitude to the following people that have actively contributed to bring bugs and improvements to my attention with regards for mailGraph on Docker: