Skip to content

docs(servers): describe host-owned Dev token wiring #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ryanbarlow97 merged 1 commit into from
Oct 15, 2026
Merged

docs(servers): describe host-owned Dev token wiring #272

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions projects/ProvinceSystem/docs/integrations/servers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,11 +68,13 @@ since the last startup is not detected.
| `SERVERS_GITHUB_TOKEN` | A read-only GitHub token, falling back to `PATCHNOTES_GITHUB_TOKEN`. Each check discovers active repositories afresh, then reads current releases in groups of eight with at most six queries concurrently. Without a token, fresh REST reads remain available but can quickly reach GitHub’s unauthenticated limit. |
| `SERVERS_GITHUB_ORG` | The organisation to read. Defaults to `TF-Minecraft`. |

Main loads its token from `backend/.env`. Dev's staging Compose file loads its
optional project-root `.env` as a backend environment file; keep only the shared
`SERVERS_GITHUB_TOKEN` there. This works with the host's environment override.
These secret files stay outside Git. Recreate the backend through the deployment
workflow after changing either file.
Main loads its token from `backend/.env`. Configure Dev's administrator-managed
Compose override to load a token-only project-root `.env` with `env_file`, using
the same read-only `SERVERS_GITHUB_TOKEN`. The host's `environment: !override`
can discard entries from the base Compose file; an environment file avoids that.
Keep secret files outside Git and recreate the backend after configuration changes.
The deployment account's read-only Compose mounts require administrator access
for this wiring.

Mount the folders read-only in the host's `docker-compose.override.yml`:

Expand Down