Github

The GitHub integration imports code, markdown, and other human-readable from your repositories into your AptEdge instance.

Generate a Github Fine-Grained Personal Access Token

1. Open GitHub Developer Settings

1. Go to your GitHub profile.
2. Click Settings.
3. In the left sidebar, select Developer settings.

2. Create a Fine-Grained Personal Access Token

1. Click Personal access tokens.
2. Select Fine-grained tokens.
3. Click Generate new token.

3. Configure the Token

Fill in the required details:

• Name – Give the token a descriptive name.
• Description – (Optional) Add a description such as AptEdge GitHub Crawler.
• Resource owner – Select the account or organization that owns the repositories.
• Expiration - We recommend setting this to your organizations maximum limit (1 year+).

4. Set Repository Access

• Best Practice: Choose "Only select repositories".

• Select only the specific repositories AptEdge needs to index. This limits your security exposure if the token is ever compromised.

5. Set Permissions

Under Repository permissions, set:

• Contents: Read-only (This allows AptEdge to ingest code and markdown).

• Metadata: Read-only (This is mandatory and usually auto-selected).

• Pull Requests: Read-only (Optional: Only if you want AptEdge to index PR discussions).

6. Generate the Token

1. Click Generate token.
2. Copy and store the token securely, as it will only be shown once.

You can now use this token to authenticate the GitHub crawler with your repositories.

Connect Github in AptEdge

1. Open Integrations

1. Log in to your AptEdge instance.
2. Go to Admin Settings.
3. Select Integrations.

2. Connect GitHub

1. Scroll down to the GitHub integration.
2. Click Connect.

3. Enter Connection Details

Provide the following information:

• Access Token – The GitHub personal access token you generated.
• File Extensions – A comma-separated list of file extensions to import (e.g., .md,.py,.js).
  • Leave this field empty to import all supported file types.
• Repositories / URLs: Enter a comma-separated list of the full URLs of the repositories (e.g., https://github.com/org/repo-name).

4. Authorize the Integration

1. Click Authorize.

Once authorized, AptEdge will begin importing and indexing the selected GitHub content.