Skip to content

Commit 7fab774

Browse files
pyama86Copilot
andcommitted
Move GitHub App docs out of README
Keep the GitHub App guide under docs/ only and remove the extra README references. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent fe2da47 commit 7fab774

1 file changed

Lines changed: 2 additions & 8 deletions

File tree

README.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -182,7 +182,7 @@ GitHub Enterprise Server does not support remote server hosting. Please refer to
182182

183183
1. To run the server in a container, you will need to have [Docker](https://www.docker.com/) installed.
184184
2. Once Docker is installed, you will also need to ensure Docker is running. The Docker image is available at `ghcr.io/github/github-mcp-server`. The image is public; if you get errors on pull, you may have an expired token and need to `docker logout ghcr.io`.
185-
3. **Authentication.** On github.com you don't need to create anything up front — the one-click buttons above log you in with OAuth on first use (a browser-based flow; the token is kept in memory only). The Docker buttons publish a fixed callback port (`127.0.0.1:8085`) so the container's login callback is reachable. See **[Local Server OAuth Login](docs/oauth-login.md)** for how it works, headless/device-code fallback, and bringing your own OAuth or GitHub App client for the OAuth flow. To authenticate directly as a GitHub App installation via `GITHUB_APP_ID` / `GITHUB_APP_INSTALLATION_ID`, see **[Local Server GitHub App Authentication](docs/github-app-auth.md)**.
185+
3. **Authentication.** On github.com you don't need to create anything up front — the one-click buttons above log you in with OAuth on first use (a browser-based flow; the token is kept in memory only). The Docker buttons publish a fixed callback port (`127.0.0.1:8085`) so the container's login callback is reachable. See **[Local Server OAuth Login](docs/oauth-login.md)** for how it works, headless/device-code fallback, and bringing your own OAuth or GitHub App (required for GitHub Enterprise Server and `ghe.com`).
186186

187187
Prefer a token? You can still authenticate with a [GitHub Personal Access Token](https://github.com/settings/personal-access-tokens/new) by setting `GITHUB_PERSONAL_ACCESS_TOKEN` instead (it takes precedence over OAuth). The MCP server can use many of the GitHub APIs, so enable the permissions that you feel comfortable granting your AI tools (to learn more about access tokens, please check out the [documentation](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)).
188188

@@ -242,12 +242,6 @@ To keep your GitHub PAT secure and reusable across different MCP hosts:
242242

243243
</details>
244244

245-
### GitHub App Authentication
246-
247-
As an alternative to user-based PAT or OAuth login, the local server can authenticate directly as a [GitHub App](https://docs.github.com/en/apps) installation using `GITHUB_APP_ID`, `GITHUB_APP_INSTALLATION_ID`, and either `GITHUB_APP_PRIVATE_KEY` or `GITHUB_APP_PRIVATE_KEY_PATH`. This works for both `stdio` and `http`, uses short-lived installation tokens, and refreshes them automatically.
248-
249-
See **[Local Server GitHub App Authentication](docs/github-app-auth.md)** for setup, required environment variables, Docker and VS Code examples, and GitHub Enterprise Server guidance.
250-
251245
### GitHub Enterprise Server and Enterprise Cloud with data residency (ghe.com)
252246

253247
The flag `--gh-host` and the environment variable `GITHUB_HOST` can be used to set
@@ -315,7 +309,7 @@ Add one of the following JSON blocks to your IDE's MCP settings.
315309
}
316310
```
317311

318-
See **[Local Server OAuth Login](docs/oauth-login.md)** for the native-binary flow (no fixed port needed), the headless/device-code fallback, GitHub Enterprise Server / `ghe.com`, and bringing your own OAuth or GitHub App client for OAuth login. For installation-based GitHub App auth, see **[Local Server GitHub App Authentication](docs/github-app-auth.md)**.
312+
See **[Local Server OAuth Login](docs/oauth-login.md)** for the native-binary flow (no fixed port needed), the headless/device-code fallback, GitHub Enterprise Server / `ghe.com`, and bringing your own OAuth or GitHub App.
319313

320314
**Or authenticate with a Personal Access Token.** Set `GITHUB_PERSONAL_ACCESS_TOKEN` instead (it takes precedence over OAuth):
321315

0 commit comments

Comments
 (0)