GitHubMake your GitHub code and activity searchable in Glean
Indexes repositories, code, commits, issues, and pull requests across GitHub Cloud, Enterprise Server, and Server. Always scoped to each user's permissions.
Choose your deployment
Glean has a connector for each GitHub hosting model. Pick the one that matches how your organization runs GitHub.
GitHub Cloud
For GitHub.com, including GitHub Enterprise Cloud. An admin installs a GitHub App and each user authorizes their own account through per-user OAuth.
GitHub Enterprise Server
For self-hosted GitHub Enterprise Server, including multiple instances on one Glean deployment. Uses a GitHub App plus an admin personal access token.
GitHub Server
For on-prem GitHub Server instances the Glean crawler can reach. Uses a GitHub App created on your instance.
Compare deployments
All three connectors index the same GitHub content (repositories, code, commits, issues, and pull requests) and enforce permissions at query time. They differ in where GitHub is hosted, how Glean authenticates, and a few capabilities.
| GitHub Cloud | Enterprise Server | Server | |
|---|---|---|---|
| Best for | GitHub.com, including GitHub Enterprise Cloud | Self-hosted GitHub Enterprise Server | On-prem GitHub Server the crawler can reach |
| Authentication | GitHub App + per-user OAuth | GitHub App + admin personal access token | GitHub App created on your instance |
| Per-user OAuth for private repos | Required | Not used | Not used |
| Multiple instances | No | Supported on one Glean deployment | No |
| Network | Glean-hosted; nothing to expose | Instance must be reachable by the crawler | Instance must be reachable by the crawler |
| Code Search | On by default | On by default | On by default |
| GitHub Pages | Legacy gh-pages sites, by repo list | Legacy gh-pages sites, by repo list | Legacy gh-pages sites, by repo list |
Not sure which you run? Most GitHub.com customers use GitHub Cloud. Choose Enterprise Server or Server only if GitHub is self-hosted in your own environment.
Explore by deployment
- GitHub Cloud
- GitHub Enterprise Server
- GitHub Server
Overview
What the GitHub Cloud connector indexes, how identity works, and how often it crawls.
Setup
Install the Glean GitHub App, configure the connector, and enable per-user OAuth for private repositories.
Crawling restrictions
Control which repositories Glean crawls using repository inclusion and exclusion lists.
Security
API endpoints
The GitHub REST API endpoints the connector calls and the read-only scopes it requests.
Permissions
The fixed, read-only GitHub App permissions Glean uses and how they map to indexed content.