tiennm99/ghglance
1
0 Fork 0
mirror of https://github.com/tiennm99/ghglance.git synced 2026-10-14 10:18:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: use a generic example domain

Browse Source
This commit is contained in:
tiennm99 committed 2026-10-11 13:00:46 +07:00
1 parent db195e46dd
commit c602078d35
2 files changed
+2 -2
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+1 -1
View File
@@ -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.
docs/deployment-guide.md
+1 -1
View File
@@ -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 `<public-url>/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 `<public-url>/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