docs: correct the uptime probe hostname in ops.md - #29
Merged
Conversation
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.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe deployment documentation now uses a retained public hostname for ChangesPublic hostname documentation
Estimated code review effort: 1 (Trivial) | ~3 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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.
Based on
main, independent of #24 and #28 — mergeable in any order.What changed and why
docs/ops.mdtold you to set the uptime workflow'sAPP_BASE_URLvariable tohttps://authgd.fly.dev. I wrote that line in #19 by deriving it fromapp = "authgd"infly.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_URLsecret is set to it:Both hostnames answer today (
authgd.fly.dev/api/health/syncreturns 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.devprobe stays green through an expired cert on the domain that matters.The new text also names the collision: the app's
APP_BASE_URLsecret (what OAuth redirect URIs derive from) and the workflow'sAPP_BASE_URLrepo 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 tohttps://<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
.fly.devvalue with more confidence than the evidence supported. It came from the app name infly.toml, and I did not check for a custom domain before writing it into the docs.<app>.fly.devchange 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