sij/khoj
1
0
Fork 0
mirror of https://github.com/khoj-ai/khoj.git synced 2024-11-23 23:48:56 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 16
khoj/docs/github_integration.md
sabaimran 7688228b9c Update docs to reflect new setup processes and instructions based on rearchitecture 
- Most important updates include the depedency requirement to setup Postgres when running/setting Khoj up locally
- Add instructiosn for Docker
- Shift to recommend desktop client and update instructions for how to configure Khoj for user
2023-11-16 12:56:42 -08:00

1.2 KiB
Raw Blame History

🧑🏾‍💻 Setup the 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 http://localhost:42110/config 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) from Github with repo and admin:org scopes at least.
  2. Navigate to http://localhost:42110/config/content-source/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 http://localhost:42110/ and start searching!