From c602078d352857c0f6079fb6e82eaea9d03fe188 Mon Sep 17 00:00:00 2001 From: tiennm99 Date: Sun, 11 Oct 2026 13:00:46 +0700 Subject: [PATCH] docs: use a generic example domain --- README.md | 2 +- docs/deployment-guide.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c944e343..ec900b10 100644 --- a/README.md +++ b/README.md @@ -322,7 +322,7 @@ In Coolify: 2. Register the [OAuth App](#sign-in-with-github) and set `GHGLANCE_OAUTH_CLIENT_ID`, `GHGLANCE_OAUTH_CLIENT_SECRET` and `GHGLANCE_PUBLIC_URL` (see [`.env.example`](./.env.example)); the public - URL is the domain from step 3, e.g. `https://ghglance.sg.miti99.com`. + URL is the domain from step 3, e.g. `https://ghglance.example.com`. `compose.yml` requires all three and refuses to start without them. 3. Keep the generated domain or set your own on the `ghglance` service, then deploy. diff --git a/docs/deployment-guide.md b/docs/deployment-guide.md index d8854fb6..76206271 100644 --- a/docs/deployment-guide.md +++ b/docs/deployment-guide.md @@ -110,7 +110,7 @@ the `ghglance-data` volume, and health-checks `/healthz` with busybox | --- | --- | | `GHGLANCE_OAUTH_CLIENT_ID` | Required. Client ID of the GitHub OAuth App behind "Sign in with GitHub" (`-oauth-client-id`). | | `GHGLANCE_OAUTH_CLIENT_SECRET` | Required. That OAuth App's client secret (`-oauth-client-secret`). Never logged or printed. | -| `GHGLANCE_PUBLIC_URL` | Required. The site's external origin, e.g. `https://ghglance.sg.miti99.com` (`-public-url`). The OAuth App's callback URL must be exactly `/auth/callback`. | +| `GHGLANCE_PUBLIC_URL` | Required. The site's external origin, e.g. `https://ghglance.example.com` (`-public-url`). The OAuth App's callback URL must be exactly `/auth/callback`. | The server holds no GitHub token: every generation runs on the visitor's token, either from Sign in with GitHub (revoked when the job ends) or one