Skip to content

Add Pharos to the mail configuration examples - #182

Open
pharos-email wants to merge 1 commit into
TryGhost:mainfrom
pharos-email:add-pharos-mail-example
Open

pharos-email wants to merge 1 commit into
TryGhost:mainfrom
pharos-email:add-pharos-mail-example

Conversation

@pharos-email

Copy link
Copy Markdown

Why: Self-hosters choosing a transactional SMTP provider get one more tested example next to Amazon SES.

What: Adds a short Pharos subsection after the Amazon SES example in the Mail section of config.mdx, with the same config.[env].json shape.

Tested: Ghost 6.71.0 (official Docker image). The setup email and a staff password reset were delivered with the settings shown. secure: false with requireTLS: true is the STARTTLS form the DigitalOcean FAQ already uses, and the note on port 2525 points to the same workaround.

@coderabbitai

coderabbitai Bot commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 73b1eaee-de5e-4402-90d9-5ac38ef3d994
📥 Commits

Reviewing files that changed from the base of the PR and between 49c3f6a and 285125d.

📒 Files selected for processing: 1
  • config.mdx

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Walkthrough

The documentation adds Pharos SMTP configuration guidance. It specifies port 587 with STARTTLS required, credentials for a verified sending domain, and port 2525 as an alternative when port 587 is blocked on DigitalOcean Droplets. It also states that Pharos handles transactional email and that newsletters still require Mailgun.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 28512

The documentation provides supported Pharos SMTP settings and keeps Mailgun as the newsletter provider. No actionable merge risk remains.

### Architecture Summary

Architecture risk: 🔵 Low · up to 28512

The change affects 1 system.

Changed systems: config.mdx

Architecture concerns
No architecture-level concerns identified.

Review details

Systems and components

  • observed — config.mdx (service) was modified; 1 changed file maps to changed impact.

Before / after behavior

  • observed — Modified behavior in config.mdx: Added Pharos SMTP configuration guidance: use the Pharos host on port 587 with STARTTLS required, and provide SMTP credentials for a verified domain. Port 2525 is documented as an alternative on DigitalOcean when 587 is blocked; Pharos sends transactional email only, while newsletters still require Mailgun.
Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and concisely describes the main change: adding Pharos to the mail configuration examples.
Description check Passed The description is directly related to the changeset. It explains why the Pharos example was added, what the documentation includes, and how the configuration was tested.
Docstring Coverage Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Warning

⚠️ This pull request has been flagged as potential spam (promotional) by CodeRabbit slop detection and should be reviewed carefully.

Comment @coderabbitai help to get the list of available commands.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant