feat: add mailpit container to compose stack and update docs to menti…

…on it. (#271)
dvsa · Aug 23, 2024 · 1b6f0e3 · 1b6f0e3
1 parent 5208e68
commit 1b6f0e3
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 3 deletions.
diff --git a/app/api/config/autoload/local.php.dist b/app/api/config/autoload/local.php.dist
@@ -119,8 +119,8 @@ return [
   'mail' => [
     'type' => '\Laminas\Mail\Transport\Smtp',
     'options' => new \Laminas\Stdlib\ArrayUtils\MergeReplaceKey([
-      'name' => 'mailhog',
-      'host' => 'mailhog',
+      'name' => 'mailpit',
+      'host' => 'mailpit',
       'port' => 1025,
       'connection_config' => [
         'username' => 'null',

diff --git a/compose.yaml b/compose.yaml
@@ -120,6 +120,16 @@ services:
     volumes:
       - "openldap-data:/bitnami/openldap"
 
+  mailpit:
+    image: axllent/mailpit:latest
+    container_name: mailpit
+    ports:
+      - "1025:1025"
+      - "8025:8025"
+    environment:
+      VIRTUAL_HOST: mailpit.local.olcs.dev-dvsacloud.uk
+      VIRTUAL_PORT: 8025
+
 volumes:
   db-data:
   openldap-data:
diff --git a/docs/app/local-setup.md b/docs/app/local-setup.md
@@ -64,7 +64,7 @@ You will need:
     :::
 
     ```bash
-    sudo echo "127.0.0.1 iuweb.local.olcs.dev-dvsacloud.uk ssweb.local.olcs.dev-dvsacloud.uk api.local.olcs.dev-dvsacloud.uk cdn.local.olcs.dev-dvsacloud.uk" >> /etc/hosts
+    sudo echo "127.0.0.1 iuweb.local.olcs.dev-dvsacloud.uk ssweb.local.olcs.dev-dvsacloud.uk api.local.olcs.dev-dvsacloud.uk cdn.local.olcs.dev-dvsacloud.uk mailpit.local.olcs.dev-dvsacloud.uk" >> /etc/hosts
     ```
 
 1. Start the application
@@ -103,4 +103,6 @@ All done!
 
 Visit the application in your browser: - [Internal Application](http://iuweb.local.olcs.dev-dvsacloud.uk) - [Self Service Application](http://ssweb.local.olcs.dev-dvsacloud.uk)
 
+Any mail sent by the app can be viewed via: - [Mailpit](http://mailpit.local.olcs.dev-dvsacloud.uk)
+
 :::