Source Control environment variables
Reference documentation of environment variables for Source Control.
Source Control environment variables available for use with Self-hosted Retool deployments. You can also set these variables from the Source Control settings page or with the Retool API.
Only configure environment variables when needed. You can configure many environment variables from your organization's Settings rather than directly editing your deployment's configuration file.
You must restart your instance after setting any variables for them to take effect.
All properties for this object with supported data types or values. You can write JavaScript almost anywhere in Retool to manipulate or read property values.
AZURE_REPOS_MAIN_BRANCH
The main branch for the Azure Repos repository.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
AZURE_REPOS_ORGANIZATION
The Azure DevOps organization name.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
AZURE_REPOS_PERSONAL_ACCESS_TOKEN
The personal access token for the Azure DevOps organization user.
| Type | string | ||||
| Format | Authentication Key | ||||
| Mutability |
|
Examples
AZURE_REPOS_REPO
The Azure DevOps repository name.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
AZURE_REPOS_USER
The username or service account for the for Azure DevOps organization.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
BITBUCKET_APP_PASSWORD
The app password for the Bitbucket user.
| Type | string | ||||
| Format | Password | ||||
| Mutability |
|
Examples
BITBUCKET_MAIN_BRANCH
The main branch for the Bitbucket repository.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
BITBUCKET_REPO
The Bitbucket repository name.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
BITBUCKET_USER
The Bitbucket username.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
BITBUCKET_WORKSPACE
The Bitbucket workspace name.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
CODE_COMMIT_AWS_ACCESS_KEY_ID
The AWS access key ID for the IAM user.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
CODE_COMMIT_AWS_DEFAULT_REGION
The AWS region for the CodeCommit repository.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
CODE_COMMIT_AWS_SECRET_ACCESS_KEY
The AWS secret access key for the IAM user.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
CODE_COMMIT_HTTPS_PASSWORD
The password for HTTPS authentication with the CodeCommit repository.
| Type | string | ||||
| Format | Password | ||||
| Mutability |
|
Examples
CODE_COMMIT_HTTPS_USERNAME
The username for HTTPS authentication with the CodeCommit repository.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
CODE_COMMIT_MAIN_BRANCH
The main branch for the CodeCommit repository.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
CODE_COMMIT_REPOSITORY_NAME
The CodeCommit repository name.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
DISABLE_GIT_SYNCING
Whether to disable Git syncing.
| Type | boolean | ||||
| Mutability |
|
Examples
DISABLE_SOURCE_CONTROL_SYNCING
Whether to disable Source Control syncing changes with the repository. This only pauses the syncing process and protected items are unaffected.
| Type | boolean | ||||
| Mutability |
|
Examples
GITHUB_APP_ID
The GitHub App ID for the GitHub repository.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
GITHUB_APP_INSTALLATION_ID
The GitHub App installation ID for the GitHub repository.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
GITHUB_APP_PRIVATE_KEY
The GitHub App private key for the GitHub repository, formatted as a single-line. If you use Kubernetes Secrets, you must base64-encode this value twice.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
GITLAB_MAIN_BRANCH
The main branch for the GitLab repository.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
GITLAB_ORGANIZATION_NAME
The GitLab organization name.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
GITLAB_PROJECT_ACCESS_TOKEN
The project access token for the GitLab repository.
| Type | string | ||||
| Format | Authentication Key | ||||
| Mutability |
|
Examples
GITLAB_PROJECT_ID
The GitLab project ID.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
GITLAB_PROJECT_SLUG
The path of the GitLab project URL.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
GITLAB_REPOSITORY_NAME
The GitLab repository name.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
GITLAB_URL
The GitLab URL for the GitLab repository.
| Type | string | ||||
| Format | Plain Text | ||||
| Mutability |
|
Examples
VERSION_CONTROL_LOCKED
Whether to enable version control and create a read-only Retool instance. If enabled, users cannot create, edit, or protect apps and workflows. Users with edit or own permissions are still permitted to create new releases.
| Type | boolean | ||||
| Mutability |
|