Skip to main content

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.

AZURE_REPOS_MAIN_BRANCH​

string

The main branch for the Azure Repos repository.

Example
AZURE_REPOS_MAIN_BRANCH=main

AZURE_REPOS_ORGANIZATION​

string

The Azure DevOps organization name.

Example
AZURE_REPOS_ORGANIZATION=my-organization

AZURE_REPOS_PERSONAL_ACCESS_TOKEN​

string

The personal access token for the Azure DevOps organization user.

Example
AZURE_REPOS_PERSONAL_ACCESS_TOKEN=mpoqd2zy7jklzfbhmuzev46vbbcpkeeqminb4wcvwigsrldasdfa

AZURE_REPOS_REPO​

string

The Azure DevOps repository name.

Example
AZURE_REPOS_REPO=my-repo

AZURE_REPOS_USER​

string

The username or service account for the for Azure DevOps organization.

Example
AZURE_REPOS_USER=retool

BITBUCKET_APP_PASSWORD​

string

The app password for the Bitbucket user.

Example
BITBUCKET_APP_PASSWORD=mpoqd2zy7jklzfbhmuzev46vbbcpkeeqminb4wcvwigsrldasdfa

BITBUCKET_MAIN_BRANCH​

string

The main branch for the Bitbucket repository.

Example
BITBUCKET_MAIN_BRANCH=main

BITBUCKET_REPO​

string

The Bitbucket repository name.

Example
BITBUCKET_REPO=my-repo

BITBUCKET_USER​

string

The Bitbucket username.

Example
BITBUCKET_USER=retool

BITBUCKET_WORKSPACE​

string

The Bitbucket workspace name.

Example
BITBUCKET_WORKSPACE=my-workspace

CODE_COMMIT_AWS_ACCESS_KEY_ID​

string

The AWS access key ID for the IAM user.

Example
CODE_COMMIT_AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE

CODE_COMMIT_AWS_DEFAULT_REGION​

string

The AWS region for the CodeCommit repository.

Example
CODE_COMMIT_AWS_DEFAULT_REGION=us-west-2

CODE_COMMIT_AWS_SECRET_ACCESS_KEY​

string

The AWS secret access key for the IAM user.

Example
CODE_COMMIT_AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

CODE_COMMIT_HTTPS_PASSWORD​

string

The password for HTTPS authentication with the CodeCommit repository.

Example
CODE_COMMIT_HTTPS_PASSWORD=mpoqd2zy7jklzfbhmuzev46vbbcpkeeqminb4wcvwigsrldasdfa

CODE_COMMIT_HTTPS_USERNAME​

string

The username for HTTPS authentication with the CodeCommit repository.

Example
CODE_COMMIT_HTTPS_USERNAME=retool

CODE_COMMIT_MAIN_BRANCH​

string

The main branch for the CodeCommit repository.

Example
CODE_COMMIT_MAIN_BRANCH=main

CODE_COMMIT_REPOSITORY_NAME​

string

The CodeCommit repository name.

Example
CODE_COMMIT_REPOSITORY_NAME=my-repo

DISABLE_GIT_SYNCING​

boolean

Whether to disable Git syncing.

Default value is false.

Example
DISABLE_GIT_SYNCING=true

DISABLE_SOURCE_CONTROL_SYNCING​

boolean

Whether to disable Source Control syncing changes with the repository. This only pauses the syncing process and protected items are unaffected.

Default value is false.

Example
DISABLE_SOURCE_CONTROL_SYNCING=true

GITHUB_APP_ID​

string

The GitHub App ID for the GitHub repository.

Example
GITHUB_APP_ID=12345

GITHUB_APP_INSTALLATION_ID​

string

The GitHub App installation ID for the GitHub repository.

Example
GITHUB_APP_INSTALLATION_ID=12345

GITHUB_APP_PRIVATE_KEY​

string

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.

Example
GITHUB_APP_PRIVATE_KEY=-----BEGIN PRIVATE KEY-----
MIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQDf7Zz7z7z7z7z7

GITLAB_MAIN_BRANCH​

string

The main branch for the GitLab repository.

Example
GITLAB_MAIN_BRANCH=main

GITLAB_ORGANIZATION_NAME​

string

The GitLab organization name.

Example
GITLAB_ORGANIZATION_NAME=my-organization

GITLAB_PROJECT_ACCESS_TOKEN​

string

The project access token for the GitLab repository.

Example
GITLAB_PROJECT_ACCESS_TOKEN=mpoqd2zy7jklzfbhmuzev46vbbcpkeeqminb4wcvwigsrldasdfa

GITLAB_PROJECT_ID​

string

The GitLab project ID.

Example
GITLAB_PROJECT_ID=123

GITLAB_PROJECT_SLUG​

string

The path of the GitLab project URL.

Example
GITLAB_PROJECT_SLUG=company/eng/product-dev

GITLAB_REPOSITORY_NAME​

string

The GitLab repository name.

Example
GITLAB_REPOSITORY_NAME=my-repo

GITLAB_URL​

string

The GitLab URL for the GitLab repository.

Example
GITLAB_URL=https://gitlab.com

VERSION_CONTROL_LOCKED​

boolean

Whether to enable version control and create a read-only Retool instance. If enabled, users cannot create, edit, or protect apps and workflows.

Default value is false.

Example
VERSION_CONTROL_LOCKED=true