Skip to content

Commit 438b423

Browse files
Add maildev container for debugging emails (directus#22425)
Co-authored-by: Pascal Jufer <[email protected]>
1 parent 0d6c6b9 commit 438b423

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

docker-compose.yml

+18-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,20 @@
1-
# This compose file is meant to spin up a copy of all supported database vendors + Redis and S3 (Minio).
1+
# This compose file is meant to spin up a copy of supported database vendors,
2+
# Redis, S3 (Minio) and a fake SMTP server (MailDev).
3+
#
4+
# ONLY FOR DEBUGGING. THIS IS NOT INTENDED FOR PRODUCTION USE.
5+
#
26
# For production use see the docker compose file example in the docs:
37
# https://docs.directus.io/self-hosted/docker-guide.html#example-docker-compose
48
#
5-
# ONLY FOR DEBUGGING. THIS IS NOT INTENDED FOR PRODUCTION USE.
9+
# For receiving emails via MailDev, you'll need to add the following to your env:
10+
11+
# EMAIL_TRANSPORT=smtp
12+
# EMAIL_SMTP_HOST=0.0.0.0
13+
# EMAIL_SMTP_PORT=1025
614
#
715
# Ports:
16+
# Maildev SMTP: 1025
17+
# Maildev Web-UI: 1080
818
# Postgres: 5100
919
# MySQL (8): 5101
1020
# MariaDB: 5102
@@ -158,3 +168,9 @@ services:
158168
DB_VENDOR: h2
159169
ports:
160170
- 5110:8080
171+
172+
maildev:
173+
image: maildev/maildev
174+
ports:
175+
- 1025:1025
176+
- 1080:1080

docs/contributing/running-locally.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ mandatory in production.
5959

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

6464
:::
6565

0 commit comments

Comments
 (0)