Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add maildev container for debugging emails #22425

Merged
merged 3 commits into from
May 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
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