Reference
Environment variables
The variables that providersFromEnv() and forgesFromEnv() read.
providersFromEnv() and forgesFromEnv() from forges/env read variables named FORGES_<KIND>_<FIELD>. Add _<SUFFIX> to a name to configure another instance of the same forge. See Configure from the environment.
Kinds
GITHUB, GITLAB, BITBUCKET, FORGEJO, GITEA, GITEE, AZURE_DEVOPS, CURSOR_ORIGIN, TANGLED and PUSHIN.
Fields
| Field | Description |
|---|---|
TOKEN | A token credential |
USERNAME, PASSWORD | Basic credentials for Bitbucket and Azure DevOps |
APP_ID, PRIVATE_KEY, INSTALLATION_ID | App credentials. GitHub and Cursor Origin. Write line breaks in PRIVATE_KEY as \n |
IDENTIFIER, PASSWORD, PDS | Tangled app password credentials, and the PDS to use |
ORGANIZATION | Azure DevOps organisation. Required for that forge |
BASE_URL | The API base URL of the instance |
INSTANCE, INSTANCE_VERSION | The host to use in refs, and the version of the instance |
API_URL, NOTIFICATIONS_URL | Tangled service URLs |
WEBHOOK_SECRET | The secret used to verify deliveries |
READ_ONLY | 1 or true creates the provider with readOnly: true |
ENABLED | 1 or true creates an anonymous provider when no credential is set. 0 or false skips the set |
DEMO_REPO | A repository as owner/name, for tools that need one to show. GitLab owners can contain slashes. A set with a DEMO_REPO is anonymous when it has no credential |
What each forge needs
| Forge | Credentials |
|---|---|
| GitHub | TOKEN, or APP_ID and PRIVATE_KEY |
| GitLab, Forgejo, Gitea, Gitee, pushin.eu | TOKEN |
| Bitbucket | TOKEN, or USERNAME and PASSWORD |
| Azure DevOps | ORGANIZATION, and TOKEN, or USERNAME and PASSWORD |
| Cursor Origin | TOKEN, or APP_ID and PRIVATE_KEY |
| Tangled | None for reads. IDENTIFIER and PASSWORD for writes |
Without a credential, a set is skipped unless ENABLED is on. Cursor Origin cannot be anonymous, and Tangled has no skip condition.