Skip to content

docs: correct the uptime probe hostname in ops.md - #29

Merged
guarzo merged 1 commit into
mainfrom
docs-uptime-url
Aug 3, 2026
Merged

docs: correct the uptime probe hostname in ops.md#29
guarzo merged 1 commit into
mainfrom
docs-uptime-url

Conversation

@guarzo

@guarzo guarzo commented Aug 3, 2026

Copy link
Copy Markdown
Owner

Based on main, independent of #24 and #28 — mergeable in any order.

What changed and why

docs/ops.md told you to set the uptime workflow's APP_BASE_URL variable to https://authgd.fly.dev. I wrote that line in #19 by deriving it from app = "authgd" in fly.toml, which is Fly's default hostname — not the URL the app actually serves on.

The app has a custom domain, and its own APP_BASE_URL secret is set to it:

$ fly certs list -a authgd
HOSTNAME                       SOURCE     STATUS
authgd.zoolanders.space        Fly        Issued

$ curl -sD - https://authgd.fly.dev/auth/eve/login | grep -i ^location
location: https://login.eveonline.com/v2/oauth/authorize?...&redirect_uri=https%3A%2F%2Fauthgd.zoolanders.space%2Fauth%2Feve%2Fcallback&...

Both hostnames answer today (authgd.fly.dev/api/health/sync returns 200), so the wrong value would have probed green — it just would not have covered the DNS record or the certificate users depend on. A .fly.dev probe stays green through an expired cert on the domain that matters.

The new text also names the collision: the app's APP_BASE_URL secret (what OAuth redirect URIs derive from) and the workflow's APP_BASE_URL repo variable (the probe target) share a name but are unrelated storage. Same value here, but nothing enforces that.

Second, smaller change: the first-deploy secrets template said APP_BASE_URL=https://<app>.fly.dev, which steers a new deploy toward exactly the hostname this PR is moving away from. Generalized to https://<public-hostname> with a note that changing it later means re-registering callback URLs with both EVE SSO and Discord.

What CI cannot check

Documentation only — no code path. npm run format:check -> All matched files use Prettier code style!. The hostname claims are backed by the two commands quoted above.

Deploy notes

None. The repository variable has already been set to the corrected value by hand, so the merged uptime workflow is probing the right URL regardless of when this merges.

Flags

  • I originally reported the .fly.dev value with more confidence than the evidence supported. It came from the app name in fly.toml, and I did not check for a custom domain before writing it into the docs.
  • The <app>.fly.dev change is adjacent to what was asked for. It is the same defect and one line, but say the word and I will drop it.

Summary by CodeRabbit

  • Documentation
    • Updated deployment guidance to use a retained public hostname.
    • Clarified OAuth callback URL updates when the hostname changes.
    • Improved uptime monitoring instructions, including custom domain, certificate, DNS, and configuration details.

The uptime workflow's APP_BASE_URL example named authgd.fly.dev, which
is Fly's default hostname for app = "authgd" and not the URL the app
actually serves on. `fly certs list` shows an issued cert for
authgd.zoolanders.space, and the app's own APP_BASE_URL secret is set
to it — the EVE SSO redirect_uri the app builds points there.

Both hostnames answer today, so the wrong value would have probed
successfully; it just would not have covered the DNS record or the
certificate that users depend on.

Also generalizes the first-deploy secrets template from
https://<app>.fly.dev to https://<public-hostname>, with a note that
OAuth redirect URIs derive from it and changing it later means
re-registering callbacks with EVE SSO and Discord.
@coderabbitai

coderabbitai Bot commented Aug 3, 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: ASSERTIVE

Plan: Pro Plus

Run ID: d2fd9621-4709-48f5-bfda-9c563f161528

📥 Commits

Reviewing files that changed from the base of the PR and between 9047052 and 6424a80.

📒 Files selected for processing (1)
  • docs/ops.md

📝 Walkthrough

Walkthrough

The deployment documentation now uses a retained public hostname for APP_BASE_URL. It explains OAuth callback re-registration requirements and updates uptime probe guidance to validate the public domain, DNS, and certificate.

Changes

Public hostname documentation

Layer / File(s) Summary
Deployment hostname and OAuth guidance
docs/ops.md
The APP_BASE_URL example uses a retained public hostname. Deployment guidance explains OAuth callback URL re-registration after hostname changes.
Uptime probe hostname configuration
docs/ops.md
The uptime probe uses the public custom domain. The documentation distinguishes the repository variable from the application OAuth secret and explains DNS and certificate coverage.

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

Poem

A rabbit hops where hostnames stay,
OAuth paths now know the way.
DNS and certs align just right,
Uptime checks the public site.
“Stable burrows!” cheers the hare.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: correcting the uptime probe hostname in the operations documentation.
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-uptime-url
✨ Simplify code
  • Create PR with simplified code
  • Commit simplified code in branch docs-uptime-url

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

@guarzo
guarzo merged commit 941299a into main Aug 3, 2026
4 checks passed
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