Skip to content

Add GitHub connector docs and config example (MAIT-92) #13

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
acikabubo wants to merge 2 commits into
base: main
Choose a base branch
from
+77 −1
Open

Add GitHub connector docs and config example (MAIT-92) #13

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
82030c7
Add GitHub connector to config.yaml.example and README (MAIT-92)
acikabubo Mar 10, 2026
5b0ba91
Add GitHub connector ENV vars to .env.rag.example
acikabubo Mar 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
43 changes: 42 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ interact with your knowledge with ease!
* S3 (any AWS compatible Object Storage including AWS, Contabo, B2, Cloudflare R2, OVH, etc)
* MediaWiki (all versions supported, both private and public wiki)
* SerpAPI
* GitHub (repository files and issues, PAT or GitHub App auth)

### 🌐 Extra connectors

Expand All @@ -47,7 +48,6 @@ Over 100 extra connectors are available at request, including the most popular o
* Google Drive
* Jira
* Slack
* GitHub
* Gitlab
* Notion
* Microsoft Teams
Expand Down Expand Up @@ -228,6 +228,47 @@ SERPAPI1_QUERIES=aaa
SERPAPI1_SCHEDULES=3600
````

### GitHub Connector

The GitHub connector ingests repository files and optionally issues from a GitHub repository.
Supports PAT and GitHub App authentication, branch or commit targeting, file extension/directory
filters, and issue label filters.

```yaml
# config.yaml

sources:
- type: "github"
name: "github1"
config:
# Auth — use one of: personal_token OR github_app_* credentials
personal_token: "${GITHUB1_PERSONAL_TOKEN}"
owner: "${GITHUB1_OWNER}" # repository owner / org
repo: "${GITHUB1_REPO}" # repository name
branch: "main" # default "main" (mutually exclusive with commit_sha)
include_extensions: "md,py" # optional, comma-separated
include_issues: false # set true to also ingest issues
concurrent_requests: 5 # optional, default 5
schedules: "${GITHUB1_SCHEDULES}"
```

```dotenv
# .env.rag

GITHUB1_PERSONAL_TOKEN=ghp_xxxxxxxxxxxx
GITHUB1_OWNER=your-org-or-username
GITHUB1_REPO=your-repo-name
GITHUB1_SCHEDULES=3600
```

For GitHub App authentication, replace `personal_token` with:

```yaml
github_app_id: "${GITHUB1_APP_ID}"
github_app_installation_id: "${GITHUB1_APP_INSTALLATION_ID}"
github_app_private_key: "${GITHUB1_APP_PRIVATE_KEY}"
```

## Embeddings and Inference

### Embeddings support
Expand Down
24 changes: 24 additions & 0 deletions config.yaml.example
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,30 @@ sources:
# queries: "${SERPAPI_QUERIES}"
# schedules: "${SERPAPI_SCHEDULES}"

# GITHUB CONNECTORS (optional):

#- type: "github"
# name: "github1"
# config:
# # Auth — use one of: personal_token OR github_app_id + github_app_installation_id + github_app_private_key
# personal_token: "${GITHUB1_PERSONAL_TOKEN}"
Comment thread
vedmaka marked this conversation as resolved.
# #github_app_id: "${GITHUB1_APP_ID}"
# #github_app_installation_id: "${GITHUB1_APP_INSTALLATION_ID}"
# #github_app_private_key: "${GITHUB1_APP_PRIVATE_KEY}"
# owner: "${GITHUB1_OWNER}"
# repo: "${GITHUB1_REPO}"
# branch: "main" # optional, default "main" (mutually exclusive with commit_sha)
# #commit_sha: "" # optional (mutually exclusive with branch)
# include_extensions: "md,py" # optional, comma-separated (mutually exclusive with exclude_extensions)
# #exclude_extensions: "" # optional (mutually exclusive with include_extensions)
# #include_directories: "" # optional, comma-separated (mutually exclusive with exclude_directories)
# #exclude_directories: "" # optional (mutually exclusive with include_directories)
# include_issues: false # optional, default false
# #include_issues_labels: "" # optional, comma-separated (mutually exclusive with exclude_issues_labels)
# #exclude_issues_labels: "" # optional (mutually exclusive with include_issues_labels)
# concurrent_requests: 5 # optional, default 5
# schedules: "${GITHUB1_SCHEDULES}"

embedding:
# can be `local` or `openrouter`/`openai`
provider: local
Expand Down