khoj/documentation/docs/data-sources/github_integration.md

# Github integration

The Github integration allows you to index as many repositories as you want. It's currently default configured to index Issues, Commits, and all Markdown/Org files in each repository. For large repositories, this takes a fairly long time, but it works well for smaller projects.

# Configure your settings

1. Go to [https://app.khoj.dev/settings](https://app.khoj.dev/settings) and enter in settings for the data sources you want to index. You'll have to specify the file paths.

## Use the Github plugin

1. Generate a [classic PAT (personal access token)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) from [Github](https://github.com/settings/tokens) with `repo` and `admin:org` scopes at least.
2. Navigate to [https://app.khoj.dev/settings/content/github](https://app.khoj.dev/settings/content/github) to configure your Github settings. Enter in your PAT, along with details for each repository you want to index.
3. Click `Save`. Go back to the settings page and click `Configure`.
4. Go to [https://app.khoj.dev/](https://app.khoj.dev/) and start searching!
Add updated information in docs about the Notion integration 2024-04-05 12:01:43 +02:00			`# Github integration`
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify 2023-07-21 07:34:25 +02:00
			`The Github integration allows you to index as many repositories as you want. It's currently default configured to index Issues, Commits, and all Markdown/Org files in each repository. For large repositories, this takes a fairly long time, but it works well for smaller projects.`

			`# Configure your settings`

Expose web, desktop settings page under /settings, not /configure - Update references to the settings page to use new url across docs and code - Rename desktop and web settings page to settigns.html instead of config[ure].html 2024-07-17 09:29:06 +02:00			`1. Go to [https://app.khoj.dev/settings](https://app.khoj.dev/settings) and enter in settings for the data sources you want to index. You'll have to specify the file paths.`
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify 2023-07-21 07:34:25 +02:00
			`## Use the Github plugin`

			1. Generate a [classic PAT (personal access token)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens) from [Github](https://github.com/settings/tokens) with `repo` and `admin:org` scopes at least.
Expose web, desktop settings page under /settings, not /configure - Update references to the settings page to use new url across docs and code - Rename desktop and web settings page to settigns.html instead of config[ure].html 2024-07-17 09:29:06 +02:00			`2. Navigate to [https://app.khoj.dev/settings/content/github](https://app.khoj.dev/settings/content/github) to configure your Github settings. Enter in your PAT, along with details for each repository you want to index.`
📝 Add a documentation base for Khoj! (#333) * Add docs for more organized, accessible information detailing Khoj setup * Delete duplicated files * Add a coverpage without enabling it. Add logo and theme * Remove obsidian README.md * Add plausible script to index.html via docsify 2023-07-21 07:34:25 +02:00			3. Click `Save`. Go back to the settings page and click `Configure`.
Update references to all documentation to reflect instructions for managed service - By default assume the audience of this website is people looking to understand the featuer offering of Khoj, and then people who are looking to self-host 2023-11-17 00:26:03 +01:00			`4. Go to [https://app.khoj.dev/](https://app.khoj.dev/) and start searching!`