GitHub Integration Setup Guide

This guide walks you through connecting your GitHub repositories to SurfSense for code search and AI-powered insights.

How it works

The GitHub connector uses gitingest to fetch and process repository contents from GitHub.

• For follow-up indexing runs, the connector retrieves the latest repository state and updates changed files.
• Indexing should be configured to run periodically, so updates should appear in your search results within minutes.

---

What Gets Indexed

---

Quick Start (Public Repos)

1. Navigate to Connectors → Add Connector → GitHub
2. Enter repository names: owner/repo (e.g., facebook/react, vercel/next.js)
3. Click Connect GitHub

No authentication required for public repositories.

---

Private Repositories

For private repos, you need a GitHub Personal Access Token (PAT).

Generate a PAT

1. Go to GitHub's token creation page (pre-filled with repo scope)
2. Set an expiration
3. Click Generate token and copy it

---

Connector Configuration

---

Troubleshooting

Repository not found

• Verify format is owner/repo
• For private repos, ensure PAT has access

Authentication failed

• Check PAT is valid and not expired
• Token should start with ghp_ or github_pat_

Rate limit exceeded

• Use a PAT for higher limits (5,000/hour vs 60 unauthenticated)
• Reduce sync frequency