Skip to content

📝 Clarified GHOST_PORT comment in .env.example (#80)#218

Open
WhatsTarpening wants to merge 1 commit into
TryGhost:mainfrom
WhatsTarpening:docs/clarify-ghost-port
Open

📝 Clarified GHOST_PORT comment in .env.example (#80)#218
WhatsTarpening wants to merge 1 commit into
TryGhost:mainfrom
WhatsTarpening:docs/clarify-ghost-port

Conversation

@WhatsTarpening

Copy link
Copy Markdown

What

Rewrites the GHOST_PORT comment in .env.example so it accurately describes
the variable's behaviour on current main.

Why

Refs #80. After #88 removed the expose entry from the ghost service,
GHOST_PORT no longer affects the port Ghost serves on — it isn't referenced
in compose.yml and server__port is never set. Ghost listens on 2368
internally, caddy/Caddyfile.example proxies to ghost:2368, and the public
port is set via HTTP_PORT / HTTPS_PORT. The only remaining consumer of
GHOST_PORT is scripts/migrate.sh, which prints it in the "forward traffic to
127.0.0.1:" migration message.

The existing comment ("Port Ghost should listen on… host multiple sites on
the same server") is inaccurate and has repeatedly confused users (#80). This
clarifies it and points to HTTP_PORT / HTTPS_PORT. It intentionally keeps the
# GHOST_PORT=2368 line, since migrate.sh still reads it. Docs-only; it
doesn't address the separate "configurable internal port" discussion noted in
#88 — happy to adjust scope if you'd prefer it folded into that.

How tested

Verified against current main by grepping the repo (GHOST_PORT, server__port,
2368) and reading compose.yml, caddy/Caddyfile.example, and scripts/migrate.sh.
Docs-only change; no behaviour modified.

@coderabbitai

coderabbitai Bot commented Jun 22, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: e302b1e2-c51f-4699-a73f-eb48059f9519

📥 Commits

Reviewing files that changed from the base of the PR and between 07dac00 and 9cd9d7c.

📒 Files selected for processing (1)
  • .env.example

Walkthrough

The comment block in .env.example around lines 56–60 was updated to replace the former "Port Ghost should listen on" description. The new comments clarify that this port is referenced internally by scripts/migrate.sh, that choosing not to use Caddy affects the printed "forward traffic to 127.0.0.1:<port>" message, that Ghost always binds to port 2368 internally while Caddy proxies to it, and that public-facing port changes should be made via HTTP_PORT / HTTPS_PORT rather than altering Ghost's internal bind port.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately describes the main change: clarifying the GHOST_PORT comment in .env.example, which is directly aligned with the changeset.
Description check ✅ Passed The description is comprehensive and directly related to the changeset, explaining the context of why the change was needed and what it accomplishes.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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.

❤️ Share

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

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