From e024542d8e0def109cc61ab4012ad85d5c971fd2 Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Thu, 3 Apr 2025 15:09:10 +0200 Subject: [PATCH] Solved msmtp bug and implemented healthchecks for it --- .../templates/services/msmtp_curl_test.yml.j2 | 24 +++++++++++++++++++ .../templates/docker-compose.yml.j2 | 19 +++------------ roles/docker-wordpress/Administration.md | 2 +- roles/docker-wordpress/files/Dockerfile | 2 +- roles/docker-wordpress/handlers/main.yml | 8 ------- roles/docker-wordpress/tasks/main.yml | 16 ++++--------- .../templates/docker-compose.yml.j2 | 8 +++---- roles/docker-wordpress/vars/main.yml | 3 ++- 8 files changed, 39 insertions(+), 43 deletions(-) create mode 100644 roles/docker-compose/templates/services/msmtp_curl_test.yml.j2 delete mode 100644 roles/docker-wordpress/handlers/main.yml diff --git a/roles/docker-compose/templates/services/msmtp_curl_test.yml.j2 b/roles/docker-compose/templates/services/msmtp_curl_test.yml.j2 new file mode 100644 index 00000000..a328433a --- /dev/null +++ b/roles/docker-compose/templates/services/msmtp_curl_test.yml.j2 @@ -0,0 +1,24 @@ + +{# + This health check ensures the test email is sent only once to prevent + hitting SMTP rate limits due to multiple health check executions. + The logic checks for a temporary file (/tmp/email_sent) to determine + if the email has already been sent. If the file exists, the email + is skipped, but the health check continues by verifying the HTTP service. + Refer to the conversation with ChatGPT (https://chatgpt.com/share/67898c3f-2c1c-800f-861c-47dcbe109135) + on January 16, 2025, for the background behind this complexity. + + Additional it is also checked if the host is reachable +#} + + healthcheck: + test: + - CMD-SHELL + - > + if [ ! -f /tmp/email_sent ]; then + echo 'Subject: testmessage from {{domains[application_id]}}\n\nSUCCESSFULL' | msmtp -t {{test_email}} && touch /tmp/email_sent; + fi && + curl -f http://localhost:80/ || exit 1 + interval: 1m + timeout: 20s + retries: 3 diff --git a/roles/docker-friendica/templates/docker-compose.yml.j2 b/roles/docker-friendica/templates/docker-compose.yml.j2 index 6447a97b..c6f37fd3 100644 --- a/roles/docker-friendica/templates/docker-compose.yml.j2 +++ b/roles/docker-friendica/templates/docker-compose.yml.j2 @@ -9,22 +9,9 @@ services: - data:/var/www/html ports: - "127.0.0.1:{{ports.localhost.http[application_id]}}:80" - healthcheck: - # This health check ensures the test email is sent only once to prevent - # hitting SMTP rate limits due to multiple health check executions. - # The logic checks for a temporary file (/tmp/email_sent) to determine - # if the email has already been sent. If the file exists, the email - # is skipped, but the health check continues by verifying the HTTP service. - # Refer to the conversation with ChatGPT (https://chatgpt.com/share/67898c3f-2c1c-800f-861c-47dcbe109135) - # on January 16, 2025, for the background behind this complexity. - test: - [ - "CMD-SHELL", - "(if [ ! -f /tmp/email_sent ]; then echo 'Subject: testmessage from {{domains[application_id]}}\n\nSUCCESSFULL' | msmtp -t {{test_email}} && touch /tmp/email_sent; fi && curl -f http://127.0.0.1:80) || exit 1" - ] - interval: 1m - timeout: 10s - retries: 3 + +{% include 'roles/docker-compose/templates/services/msmtp_curl_test.yml.j2' %} + {% include 'templates/docker/container/networks.yml.j2' %} {% include 'templates/docker/container/depends-on-just-database.yml.j2' %} diff --git a/roles/docker-wordpress/Administration.md b/roles/docker-wordpress/Administration.md index c2ccf657..a10d625f 100644 --- a/roles/docker-wordpress/Administration.md +++ b/roles/docker-wordpress/Administration.md @@ -37,6 +37,6 @@ docker-compose exec -it application /bin/sh To test the email execute: ```bash -echo "Test Email" | sendmail -v your-email@example.com +docker-compose exec -it application /bin/sh -c 'echo "Test Email" | sendmail -v your-email@example.com' ``` diff --git a/roles/docker-wordpress/files/Dockerfile b/roles/docker-wordpress/files/Dockerfile index a46dc1cb..933802c2 100644 --- a/roles/docker-wordpress/files/Dockerfile +++ b/roles/docker-wordpress/files/Dockerfile @@ -6,7 +6,7 @@ RUN apt-get update && \ rm -rf /var/lib/apt/lists/* # Copy the msmtp configuration into the container -COPY msmtp.conf /etc/msmtp.conf +COPY config/msmtprc.conf /etc/msmtprc # Copy the PHP configuration for uploads (and mail settings) COPY upload.ini $PHP_INI_DIR/conf.d/ \ No newline at end of file diff --git a/roles/docker-wordpress/handlers/main.yml b/roles/docker-wordpress/handlers/main.yml deleted file mode 100644 index 010cd2de..00000000 --- a/roles/docker-wordpress/handlers/main.yml +++ /dev/null @@ -1,8 +0,0 @@ ---- -- name: rebuild wordpress container - command: - cmd: docker build --no-cache -t {{custom_wordpress_image}} . - chdir: "{{docker_compose.directories.instance}}" - environment: - COMPOSE_HTTP_TIMEOUT: 600 - DOCKER_CLIENT_TIMEOUT: 600 \ No newline at end of file diff --git a/roles/docker-wordpress/tasks/main.yml b/roles/docker-wordpress/tasks/main.yml index 86d02b9d..b40569d2 100644 --- a/roles/docker-wordpress/tasks/main.yml +++ b/roles/docker-wordpress/tasks/main.yml @@ -17,25 +17,19 @@ template: src: upload.ini.j2 dest: "{{ docker_compose.directories.instance }}upload.ini" - notify: - - docker compose project setup - - rebuild wordpress container + notify: docker compose project build and setup -- name: "Transfering msmtp.conf to {{ docker_compose.directories.instance }}" +- name: "Transfering msmtprc to {{ host_msmtp_conf }}" template: src: "{{ playbook_dir }}/roles/msmtp/templates/msmtprc.conf.j2" - dest: "{{ docker_compose.directories.instance }}msmtp.conf" - notify: - - docker compose project setup - - rebuild wordpress container + dest: "{{ host_msmtp_conf }}" + notify: docker compose project build and setup - name: "Transfering Dockerfile to {{ docker_compose.directories.instance }}" copy: src: Dockerfile dest: "{{ docker_compose.directories.instance }}Dockerfile" - notify: - - docker compose project setup - - rebuild wordpress container + notify: docker compose project build and setup - name: "copy docker-compose.yml and env file" include_tasks: copy-docker-compose-and-env.yml diff --git a/roles/docker-wordpress/templates/docker-compose.yml.j2 b/roles/docker-wordpress/templates/docker-compose.yml.j2 index dbcb1b40..4d677e71 100644 --- a/roles/docker-wordpress/templates/docker-compose.yml.j2 +++ b/roles/docker-wordpress/templates/docker-compose.yml.j2 @@ -12,11 +12,9 @@ services: - "127.0.0.1:{{ports.localhost.http[application_id]}}:80" volumes: - data:/var/www/html - healthcheck: - test: ["CMD", "curl", "-f", "http://localhost:80/"] - interval: 1m - timeout: 10s - retries: 3 + +{% include 'roles/docker-compose/templates/services/msmtp_curl_test.yml.j2' %} + {% include 'templates/docker/container/depends-on-just-database.yml.j2' %} {% include 'templates/docker/container/networks.yml.j2' %} diff --git a/roles/docker-wordpress/vars/main.yml b/roles/docker-wordpress/vars/main.yml index 9277e76d..cb7d0cd4 100644 --- a/roles/docker-wordpress/vars/main.yml +++ b/roles/docker-wordpress/vars/main.yml @@ -2,4 +2,5 @@ application_id: "wordpress" wordpress_max_upload_size: "64M" database_type: "mariadb" database_password: "{{wordpress_database_password}}" -custom_wordpress_image: "custom_wordpress" \ No newline at end of file +custom_wordpress_image: "custom_wordpress" +host_msmtp_conf: "{{docker_compose.directories.config}}msmtprc.conf" \ No newline at end of file