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.
Environment variables take effect only once the change is applied to your deployment, and where you set them depends on how Retool was deployed.
- Terraform blueprints. Set the variable in
retool_helm_extra_valuesinmain.tf, then runterraform apply. Editing Helm values directly on a blueprint-managed instance is overwritten by the next apply. - Helm. Set the variable in your
values.yaml, then runhelm upgrade. That command restarts the affected pods as part of applying the new values, so restarting pods without re-running it doesn't pick up the change. - Docker Compose. Set the variable in
docker.env, then runsudo docker compose up -d.
AZURE_REPOS_MAIN_BRANCH
The main branch for the Azure Repos repository.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
AZURE_REPOS_MAIN_BRANCH=main
AZURE_REPOS_ORGANIZATION
The Azure DevOps organization name.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
AZURE_REPOS_ORGANIZATION=my-organization
AZURE_REPOS_PERSONAL_ACCESS_TOKEN
The personal access token for the Azure DevOps organization user.
| Type | string |
| Format | Authentication Key |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
AZURE_REPOS_PERSONAL_ACCESS_TOKEN=mpoqd2zy7jklzfbhmuzev46vbbcpkeeqminb4wcvwigsrldasdfa
AZURE_REPOS_REPO
The Azure DevOps repository name.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
AZURE_REPOS_REPO=my-repo
AZURE_REPOS_USER
The username or service account for the for Azure DevOps organization.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
AZURE_REPOS_USER=retool
BITBUCKET_APP_PASSWORD
The app password for the Bitbucket user.
| Type | string |
| Format | Password |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
BITBUCKET_APP_PASSWORD=mpoqd2zy7jklzfbhmuzev46vbbcpkeeqminb4wcvwigsrldasdfa
BITBUCKET_MAIN_BRANCH
The main branch for the Bitbucket repository.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
BITBUCKET_MAIN_BRANCH=main
BITBUCKET_REPO
The Bitbucket repository name.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
BITBUCKET_REPO=my-repo
BITBUCKET_USER
The Bitbucket username.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
BITBUCKET_USER=retool
BITBUCKET_WORKSPACE
The Bitbucket workspace name.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
BITBUCKET_WORKSPACE=my-workspace
CODE_COMMIT_AWS_ACCESS_KEY_ID
The AWS access key ID for the IAM user.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CODE_COMMIT_AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
CODE_COMMIT_AWS_DEFAULT_REGION
The AWS region for the CodeCommit repository.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CODE_COMMIT_AWS_DEFAULT_REGION=us-west-2
CODE_COMMIT_AWS_SECRET_ACCESS_KEY
The AWS secret access key for the IAM user.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CODE_COMMIT_AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
CODE_COMMIT_HTTPS_PASSWORD
The password for HTTPS authentication with the CodeCommit repository.
| Type | string |
| Format | Password |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CODE_COMMIT_HTTPS_PASSWORD=mpoqd2zy7jklzfbhmuzev46vbbcpkeeqminb4wcvwigsrldasdfa
CODE_COMMIT_HTTPS_USERNAME
The username for HTTPS authentication with the CodeCommit repository.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CODE_COMMIT_HTTPS_USERNAME=retool
CODE_COMMIT_MAIN_BRANCH
The main branch for the CodeCommit repository.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CODE_COMMIT_MAIN_BRANCH=main
CODE_COMMIT_REPOSITORY_NAME
The CodeCommit repository name.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
CODE_COMMIT_REPOSITORY_NAME=my-repo
DISABLE_GIT_SYNCING
Whether to disable Git syncing.
| Type | boolean |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | false |
Examples
DISABLE_GIT_SYNCING=true
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 |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | false |
Examples
DISABLE_SOURCE_CONTROL_SYNCING=true
GITLAB_MAIN_BRANCH
The main branch for the GitLab repository.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
GITLAB_MAIN_BRANCH=main
GITLAB_ORGANIZATION_NAME
The GitLab organization name.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
GITLAB_ORGANIZATION_NAME=my-organization
GITLAB_PROJECT_ACCESS_TOKEN
The project access token for the GitLab repository.
| Type | string |
| Format | Authentication Key |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
GITLAB_PROJECT_ACCESS_TOKEN=mpoqd2zy7jklzfbhmuzev46vbbcpkeeqminb4wcvwigsrldasdfa
GITLAB_PROJECT_ID
The GitLab project ID.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
GITLAB_PROJECT_ID=123
GITLAB_PROJECT_SLUG
The path of the GitLab project URL.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
GITLAB_PROJECT_SLUG=company/eng/product-dev
GITLAB_REPOSITORY_NAME
The GitLab repository name.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
GITLAB_REPOSITORY_NAME=my-repo
GITLAB_URL
The GitLab URL for the GitLab repository.
| Type | string |
| Format | Plain Text |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | null |
Examples
GITLAB_URL=https://gitlab.com
VERSION_CONTROL_LOCKED
Whether to enable version control and create a read-only Retool instance. If enabled, users cannot create, edit, or protect all elements (apps, workflows, resources, etc). Users with edit or own permissions are still permitted to create new releases. Admins can still delete unprotected elements.
| Type | boolean |
| Configurability | Update the deployment's configuration file. |
| Required | Optional |
| Default | false |
Examples
VERSION_CONTROL_LOCKED=true