Skip to content

Commit

Permalink
Add maildev container for debugging emails (#22425)
Browse files Browse the repository at this point in the history
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
  • Loading branch information
DanielBiegler and paescuj committed May 8, 2024
1 parent 0d6c6b9 commit 438b423
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 3 deletions.
20 changes: 18 additions & 2 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# This compose file is meant to spin up a copy of all supported database vendors + Redis and S3 (Minio).
# This compose file is meant to spin up a copy of supported database vendors,
# Redis, S3 (Minio) and a fake SMTP server (MailDev).
#
# ONLY FOR DEBUGGING. THIS IS NOT INTENDED FOR PRODUCTION USE.
#
# For production use see the docker compose file example in the docs:
# https://docs.directus.io/self-hosted/docker-guide.html#example-docker-compose
#
# ONLY FOR DEBUGGING. THIS IS NOT INTENDED FOR PRODUCTION USE.
# For receiving emails via MailDev, you'll need to add the following to your env:
# EMAIL_FROM=directus@directus.io
# EMAIL_TRANSPORT=smtp
# EMAIL_SMTP_HOST=0.0.0.0
# EMAIL_SMTP_PORT=1025
#
# Ports:
# Maildev SMTP: 1025
# Maildev Web-UI: 1080
# Postgres: 5100
# MySQL (8): 5101
# MariaDB: 5102
Expand Down Expand Up @@ -158,3 +168,9 @@ services:
DB_VENDOR: h2
ports:
- 5110:8080

maildev:
image: maildev/maildev
ports:
- 1025:1025
- 1080:1080
2 changes: 1 addition & 1 deletion docs/contributing/running-locally.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ mandatory in production.

Also the [Database Configuration](https://docs.directus.io/self-hosted/config-options.html#database) must be specified.
You might want to use the [docker-compose.yml](https://github.com/directus/directus/blob/main/docker-compose.yml) file
to spin up a test database.
to spin up a test database or a local mail server.

:::

Expand Down

0 comments on commit 438b423

Please sign in to comment.