Bernhard.Linz/mailGraph
1
0
Fork 0
mirror of https://github.com/moudsen/mailGraph synced 2025-10-31 17:47:39 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

v0.9.1 - Initial public beta release for testing purposes

Browse Source
This commit is contained in:
Mark Oudsen
2025-05-05 19:00:32 +02:00
parent 2a599cb777
commit 12c9f1e331
1 changed files with 9 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docker/README.md
View File

@@ -2,6 +2,8 @@
With the following instructions, mailGraph can be run in a Docker container. With the following instructions, mailGraph can be run in a Docker container.
Every new version of mailGraph will also be deployed to Docker Hub. Every new version of mailGraph will also be deployed to Docker Hub.
WORK-IN-PROGRESS
## Instructions - Plain vanilla deployment ## ## Instructions - Plain vanilla deployment ##
- Create a directory structure on your system as follows: - 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; -- 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`). -- 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.
## Testing and Debugging ## ## Testing and Debugging ##
- Display currently running containers `docker ps` - Display currently running containers `docker ps`
- Execute `docker exec -it <container ID> sh` for a shell into the container - Execute `docker exec -it <container name> sh` for a shell into the container
- Following the instructions in the Wiki on troubleshooting and debugging - Following the instructions in the Wiki on troubleshooting and debugging
- When done testing, `exit` the container - When done testing, `exit` the container
## Periodic cleanup of images and logs ## ## 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 <container name> 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. 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 ## ## 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: 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: