From 9b3bcb451e0db3d66509810c72109bd90dfe6e3a Mon Sep 17 00:00:00 2001 From: tiennm99 Date: Wed, 7 Oct 2026 11:23:13 +0700 Subject: [PATCH] chore(compose): rename the server token variable to GHGLANCE_TOKEN --- .env.example | 2 +- README.md | 2 +- compose.yml | 2 +- docs/deployment-guide.md | 4 ++-- 4 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.env.example b/.env.example index c099e9fb..0a452c9f 100644 --- a/.env.example +++ b/.env.example @@ -1 +1 @@ -GHGLANCE_GITHUB_TOKEN= +GHGLANCE_TOKEN= diff --git a/README.md b/README.md index 64260c42..e83eb9ab 100644 --- a/README.md +++ b/README.md @@ -253,7 +253,7 @@ In Coolify: 1. Create a resource from this Git repository with the **Docker Compose** build pack and compose file `/compose.yml`. -2. Set `GHGLANCE_GITHUB_TOKEN` (see [`.env.example`](./.env.example)) to a +2. Set `GHGLANCE_TOKEN` (see [`.env.example`](./.env.example)) to a public-only token: a classic PAT with only `read:user`, never `repo`. `compose.yml` requires it and passes it to the container as `GITHUB_TOKEN`. The distinct name keeps a `GITHUB_TOKEN` exported in your diff --git a/compose.yml b/compose.yml index 036909bc..e03df1b0 100644 --- a/compose.yml +++ b/compose.yml @@ -7,7 +7,7 @@ services: restart: unless-stopped environment: - SERVICE_FQDN_GHGLANCE_8080 - - GITHUB_TOKEN=${GHGLANCE_GITHUB_TOKEN:?set a public-only GitHub token} + - GITHUB_TOKEN=${GHGLANCE_TOKEN:?set a public-only GitHub token} volumes: - ghglance-data:/data healthcheck: diff --git a/docs/deployment-guide.md b/docs/deployment-guide.md index 2fb96d0d..b37ade56 100644 --- a/docs/deployment-guide.md +++ b/docs/deployment-guide.md @@ -108,10 +108,10 @@ the `ghglance-data` volume, and health-checks `/healthz` with busybox | Variable | Needed for | | --- | --- | -| `GHGLANCE_GITHUB_TOKEN` | Required by `compose.yml`, which passes it to the container as `GITHUB_TOKEN` for token-less submissions. Must be public-only: a classic PAT with just `read:user`. A token with `repo` scope or any private-repo access is refused for token-less jobs (GitHub would count private contributions in totals and calendars). | +| `GHGLANCE_TOKEN` | Required by `compose.yml`, which passes it to the container as `GITHUB_TOKEN` for token-less submissions. Must be public-only: a classic PAT with just `read:user`. A token with `repo` scope or any private-repo access is refused for token-less jobs (GitHub would count private contributions in totals and calendars). | Coolify: create a Docker Compose resource from this repo, compose file -`/compose.yml`, set `GHGLANCE_GITHUB_TOKEN`, assign the domain, deploy. Server flags +`/compose.yml`, set `GHGLANCE_TOKEN`, assign the domain, deploy. Server flags (`-cooldown`, `-retention`, `-workers`, `-timeout`) are changed by editing `command:` in `compose.yml`. Steps for a plain Docker host and the request-handling rules are in the README's "Run the web UI" section.