## Summary **Batch A of Phase 3** of the H1 → front-matter migration (`DOCS-484`; parent `DOCS-477`). Adds a front-matter `title` to every navigable docs page whose title can be migrated **mechanically**, with no editorial judgment. This is the content step that Phase 1 (renderers prefer front-matter title, `DOCS-482`) and Phase 2 (tooling + generators front-matter-aware, `DOCS-483`) unblocked. Both are merged; coder.com #964/#974 are merged and live. **Rendered no-op.** The renderers already resolve the page title from the manifest and hide the leading body H1 (Phase 1), so no page changes visually. This just moves the title into front matter where Fumadocs and the migrated tooling can read it. ## What's in this batch Dry-run on `main` (464 navigable pages) splits into: | category | count | this PR | |----------|-------|---------| | already has front-matter title (Reference, from Phase 2 generators) | 196 | skipped (idempotent) | | **mechanical** — leading body H1 equals the manifest label | 138 | ✅ add front-matter `title`, drop the duplicate H1 | | **no body H1** — renders under the manifest label only | 4 | ✅ add front-matter `title` only | | **mismatch** — body H1 differs from the manifest label | 126 | ⏭️ deferred (needs an editorial decision, see below) | 142 files changed, all under `docs/`. ## Deliberately out of scope: the 126 mismatches Pages where the body H1 is richer than the short sidebar label (e.g. label **Modules** / H1 *Contributing modules*, label **Install** / H1 *Installing Coder*) need a canonical-title decision, not a script. A few even look like the body H1 is the redundant one (`install/cli.md` and `install/index.md` both carry the H1 *Installing Coder*). These will land in follow-up batches **by nav section** once the policy is set, so each gets real review. ## Verification AI was the primary author of this PR (see disclosure below); per the [AI Contribution Guidelines](https://coder.com/docs/about/contributing/AI_CONTRIBUTING) here is the manual verification. - Every added front-matter block parses as YAML and its `title` round-trips to the manifest label (checked programmatically across all 142 files). - Every removed line is a leading `# H1` that equalled the manifest title; no body prose was reflowed. Front matter is correctly hoisted above pre-existing `<!-- markdownlint-disable -->` comments on the two pages that had them. - `pnpm check-docs` (markdownlint-cli2 + table formatter) passes on the changed set: `Summary: 0 error(s)`. `MD041` stays off (re-enabled in Phase 4); `MD025` is not tripped because the duplicate body H1s are removed. ``` $ pnpm exec markdownlint-cli2 $(git diff --name-only origin/main) Linting: 142 file(s) Summary: 0 error(s) ``` Linear: DOCS-484 > This PR was created with AI assistance (Coder Agents).
3.8 KiB
title
| title |
|---|
| Git Providers |
Coder Agents leverages your existing
external authentication configuration
to power the in-chat diff viewer.
Self-hosted GitHub Enterprise deployments require one additional setting
(API_BASE_URL) for this feature to work.
GitHub Enterprise configuration
For public github.com, no additional configuration is needed.
For self-hosted GitHub Enterprise, add API_BASE_URL to your
existing configuration:
CODER_EXTERNAL_AUTH_0_ID="primary-github"
CODER_EXTERNAL_AUTH_0_TYPE=github
CODER_EXTERNAL_AUTH_0_CLIENT_ID=xxxxxx
CODER_EXTERNAL_AUTH_0_CLIENT_SECRET=xxxxxxx
CODER_EXTERNAL_AUTH_0_AUTH_URL="https://github.example.com/login/oauth/authorize"
CODER_EXTERNAL_AUTH_0_TOKEN_URL="https://github.example.com/login/oauth/access_token"
CODER_EXTERNAL_AUTH_0_VALIDATE_URL="https://github.example.com/api/v3/user"
CODER_EXTERNAL_AUTH_0_API_BASE_URL="https://github.example.com/api/v3"
CODER_EXTERNAL_AUTH_0_REGEX=github\.example\.com
Without API_BASE_URL, Coder defaults to https://api.github.com. Clone
and push still work (they use AUTH_URL and TOKEN_URL directly), but
the diff viewer silently fails because Coder builds its URL-matching
patterns from the API base URL.
Note
If you have both a
github.comand a GHE external auth config, only the GHE config needsAPI_BASE_URL.
GitLab configuration
For gitlab.com, no additional API_BASE_URL is needed. Coder
automatically derives it from your AUTH_URL for self-hosted instances.
Required scopes
The default GitLab scopes (read_user) are sufficient for basic
authentication. To use merge request features (diffs, status checks) with
Coder Agents, configure:
CODER_EXTERNAL_AUTH_0_ID="primary-gitlab"
CODER_EXTERNAL_AUTH_0_TYPE=gitlab
CODER_EXTERNAL_AUTH_0_CLIENT_ID=xxxxxx
CODER_EXTERNAL_AUTH_0_CLIENT_SECRET=xxxxxxx
CODER_EXTERNAL_AUTH_0_SCOPES="write_repository read_api"
The read_api scope grants read access to the API (needed for fetching
merge request metadata and diffs). The write_repository scope allows
pushing commits and creating merge requests.
Self-hosted GitLab
For self-hosted GitLab, set AUTH_URL and TOKEN_URL to your instance.
Coder derives API_BASE_URL automatically from AUTH_URL:
CODER_EXTERNAL_AUTH_0_ID="primary-gitlab"
CODER_EXTERNAL_AUTH_0_TYPE=gitlab
CODER_EXTERNAL_AUTH_0_CLIENT_ID=xxxxxx
CODER_EXTERNAL_AUTH_0_CLIENT_SECRET=xxxxxxx
CODER_EXTERNAL_AUTH_0_AUTH_URL="https://gitlab.example.com/oauth/authorize"
CODER_EXTERNAL_AUTH_0_TOKEN_URL="https://gitlab.example.com/oauth/token"
CODER_EXTERNAL_AUTH_0_SCOPES="write_repository read_api"
CODER_EXTERNAL_AUTH_0_REGEX=gitlab\.example\.com
Note
You may also set
API_BASE_URLexplicitly if needed (e.g.,https://gitlab.example.com/api/v4), but this is usually unnecessary.
Known limitations
GitLab
The GitLab provider has some semantic differences compared to the GitHub provider:
- Approved uses GitLab's threshold-based approval (e.g., "all required approvals met") rather than GitHub's "at least one approval and no changes requested" model.
- Changes requested has no GitLab equivalent. This field is always
reported as
false. - Reviewer count only counts users who have approved, not all assigned reviewers.
These gaps are tracked internally and may be refined in future releases.
Troubleshooting
Diffs not appearing on GHE
Add API_BASE_URL to your GHE external auth config and restart Coder.
Diffs should appear within a couple of minutes.
Users not seeing diffs
The chat owner must have linked their account through the relevant external auth provider.
Checking logs
Look for gitsync warnings such as no provider for origin or
resolve token errors.