GitHub repository
Import documentation from a GitHub repository using narrowly scoped read access.
Before you start
You need permission to manage CogLake connectors and access to the repository. Use a separate read-only credential for private repositories. The connector reads supported repository files; it does not run the project, import issue discussions or change repository content.
1. Prepare access
For a fine-grained personal access token, select the intended repository and grant Contents: read. Follow any approval required by the repository's organization. A public repository can be reachable without a token, but provider request limits still apply. See GitHub's permission reference.
Do not grant write or organization-administration permissions just to synchronize documentation. Set and track a suitable token expiry.
2. Configure CogLake
Open Administration → Connections → Connectors → Add connector and select GitHub repository.
| Field | Example or meaning |
|---|---|
| Repository URL | https://github.com/example/team-handbook |
| Read-only access token | The token value, entered only in its secret field |
| Branch, tag or commit | Leave empty for the default branch; choose a branch for ongoing updates |
| Import directory | For example, docs — relative to the repository root |
Use the repository root, not a file or branch URL. Do not put a token in the URL. A fixed commit intentionally remains a snapshot.
3. Save and verify
- 1Test connection
- 2Choose sync and scope
- 3Grant CogLake role access
- 4Save and sync
- 5Search a known phrase
Start with a small documentation directory. Wait for processing, open a known README or note and search for a distinctive phrase. Verify access with a member who should see it and one who should not.
Updates and limitations
Subsequent syncs can pick up changes in a moving branch. Removed or excluded files cease to be part of the synchronized knowledge after a successful update. Generated dependencies, secret-bearing files and unsupported entries may be skipped. The connector is not a complete repository backup; binary objects, submodules and externally stored content must not be assumed to be imported.
If the test fails, check the token's repository selection, approval and expiry, then confirm the branch and path exist. For rate limits, wait rather than issuing repeated imports. See connector troubleshooting.