Skip to main content
Connect GitHub to Realm to make repository documentation, issues, pull requests, wikis, and discussions searchable. Navigate to Settings > Data sources and click Connect on GitHub, or click Configure if already connected.

​
Connecting GitHub

Click Connect on the GitHub data source page. You’ll be redirected to GitHub’s OAuth flow. Review the permissions and click Authorize. The person connecting should be a GitHub organization admin. If GitHub shows Request or Install and request, GitHub sends an installation request to the owners of the selected organization. Realm for GitHub remains disconnected and does not sync data while approval is pending. After an owner installs the app, return to Realm and connect GitHub again. Once authorized, you can configure which repositories to sync from the GitHub app settings page. Click Configure on the data source page to manage repository access.

​
What gets synced

​
Permissions

Realm enforces GitHub’s native permission model. Public repositories are visible to every user in your Realm workspace. Content from a private repository is visible only to Realm users whose GitHub account is a collaborator on that repository. To apply a private repository’s collaborator list, Realm has to match each GitHub account to a Realm user by email. Authorizing the connection does not link the GitHub account of the admin who authorized it to their Realm account, so even that admin sees only public repositories until a match exists. A match is made from any of the following:
  • Public profile email. The email shown on the user’s public GitHub profile matches their Realm email. Users set this under GitHub Settings > Public profile > Public email.
  • Organization-verified domain email. The GitHub organization has verified a domain and the user has a verified email on that domain that matches their Realm email.
  • Personal GitHub connection. The user connects GitHub under Settings > Personal integrations in Realm. This links their GitHub account to their Realm account using all verified emails on the GitHub account and refreshes repository access right away. It syncs no additional data.
If private repositories are missing for a user, have them connect GitHub under Personal integrations. That works regardless of the user’s GitHub profile or organization settings. You can bypass GitHub permissions by switching to Everyone in this organization on the data source settings page, which makes all synced GitHub data, including private repositories, visible to all Realm users.