docs(email): simplify MailHog setup for worktree-based local dev - #306
Open
agustin-sanc wants to merge 2 commits into
Open
docs(email): simplify MailHog setup for worktree-based local dev#306agustin-sanc wants to merge 2 commits into
agustin-sanc wants to merge 2 commits into
Conversation
- .env.template: default SMTP_HOST=localhost, SMTP_PORT=1025, blank creds (MailHog needs no auth; real Gmail creds only in prod via Kamal secrets) - docker-compose.yml: make MailHog host ports overridable via MAILHOG_UI_PORT / MAILHOG_SMTP_PORT (default 18025/11025) so the all-in-Docker path is also conflict-proof - README.md: rewrite the email section — shared-inbox model (one MailHog on localhost:1025/8025 for all worktrees), quick-start one-liner, step- by-step guide to testing email flows, and a note on the Docker alternative
Contributor
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Repository UI Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
.env.template: defaults SMTP tolocalhost:1025with blank creds — points all local dev at the shared MailHog (no accidental real Gmail sends, no credentials needed)docker-compose.yml: MailHog host ports now configurable viaMAILHOG_UI_PORT/MAILHOG_SMTP_PORT(defaults18025/11025), so the all-in-Docker path is also conflict-proofREADME.md: complete rewrite of the email section — shared-inbox model (one MailHog onlocalhost:1025/8025for all worktrees in parallel), quick-start one-liner, step-by-step testing guide, note on the Docker alternativeContext
The primary local dev model is
pnpm dev(portless) per worktree, mirroring how Postgres works: a shared host service (localhost:1025) with a single inbox atlocalhost:8025. Sincescripts/setup-worktree-db.shcopies the main.envverbatim into each new worktree, setting SMTP once in the main checkout propagates to all worktrees automatically.The previous setup had
SMTP_HOSTblank in.env.template, which meant a fresh contributor runningpnpm devwould fall through to real Gmail sends using any credentials they had set. Now the template defaults to MailHog.Test plan
docker run -d --name mailhog -p 1025:1025 -p 8025:8025 mailhog/mailhoghttp://localhost:8025shows the MailHog UIpnpm devand trigger a signup or password-reset flowhttp://localhost:8025(not sent to a real inbox)MAILHOG_UI_PORT=19025in.env, rundocker-compose up, confirm UI atlocalhost:19025