Skip to main content

Source Control environment variables

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.

AZURE_REPOS_USER​

The admin user or service account for the Azure DevOps organization.

AZURE_REPOS_USER=retool

AZURE_REPOS_PERSONAL_ACCESS_TOKEN​

The user's personal access token, under https://dev.azure.com/{AZURE_REPOS_USER}/_usersSettings/tokens.

AZURE_REPOS_PERSONAL_ACCESS_TOKEN=mpoqd2zy7jklzfbhmuzev46vbbcpkeeqminb4wcvwigsrldasdfa

AZURE_REPOS_ORGANIZATION​

The name of the Azure DevOps organization.

AZURE_REPOS_ORGANIZATION=my-organization-name

AZURE_REPOS_REPO​

The name of the Azure Repos repository.

AZURE_REPOS_REPO=retool

AZURE_REPOS_MAIN_BRANCH​

The default branch for the Azure Repos repository.

AZURE_REPOS_MAIN_BRANCH=main

BITBUCKET_USER​

The Bitbucket username.

BITBUCKET_USER=retool

BITBUCKET_APP_PASSWORD​

The Bitbucket app password.

BITBUCKET_APP_PASSWORD=loDJlwRetoolTYXOFbO

BITBUCKET_WORKSPACE​

The name of the Bitbucket workspace.

BITBUCKET_WORKSPACE=retool-space

BITBUCKET_REPO​

The name of the Bitbucket repository.

BITBUCKET_REPO=retool-apps

BITBUCKET_MAIN_BRANCH​

The default branch for the Bitbucket repository.

BITBUCKET_MAIN_BRANCH=main

CODE_COMMIT_AWS_ACCESS_KEY_ID​

The AWS CodeCommit Access Key ID.

CODE_COMMIT_AWS_ACCESS_KEY_ID=AKIAWS3BACWHP6QW6VB2

CODE_COMMIT_AWS_SECRET_ACCESS_KEY​

The AWS CodeCommit Secret Access Key.

CODE_COMMIT_AWS_SECRET_ACCESS_KEY=loDJlwRetoolTYXOFbO

CODE_COMMIT_AWS_DEFAULT_REGION​

The AWS CodeCommit repository region.

CODE_COMMIT_AWS_DEFAULT_REGION=us-east-1

CODE_COMMIT_REPOSITORY_NAME​

The name of the AWS CodeCommit repository.

CODE_COMMIT_REPOSITORY_NAME=retool-apps

CODE_COMMIT_MAIN_BRANCH​

The default branch for the AWS CodeCommit repository.

CODE_COMMIT_MAIN_BRANCH=main

CODE_COMMIT_HTTPS_USERNAME​

The AWS CodeCommit HTTPS username.

CODE_COMMIT_HTTPS_USERNAME=retool-https-username

CODE_COMMIT_HTTPS_PASSWORD​

The AWS CodeCommit HTTPS password.

CODE_COMMIT_HTTPS_PASSWORD=retool-https-password

GITHUB_APP_ID​

The GitHub App ID.

GITHUB_APP_ID=12345

GITHUB_APP_INSTALLATION_ID​

The GitHub App installation ID.

GITHUB_APP_INSTALLATION_ID=54321

GITHUB_APP_PRIVATE_KEY​

The base64-encoded value of the generated GitHub private key. This value should only span one line.

If you use Kubernetes Secrets, you must base64-encode this value twice.

GITHUB_APP_PRIVATE_KEY=...

GITLAB_URL​

The base GitLab URL.

Cloud
GITLAB_URL=https://gitlab.com
Self-managed
GITLAB_URL=https://gitlab.example.com

GITLAB_PROJECT_ACCESS_TOKEN​

The GitLab project access token for authentication.

GITLAB_PROJECT_ACCESS_TOKEN=glpat-123xyzabc456

GITLAB_PROJECT_ID​

The GitLab project ID.

GITLAB_PROJECT_ID=12345

GITLAB_MAIN_BRANCH​

The default branch for the GitLab project.

GITLAB_MAIN_BRANCH=main

GITLAB_ORGANIZATION_NAME​

The GitLab organization name. This can be a username if the GitLab project is not part of an organization.

GITLAB_ORGANIZATION_NAME=company

GITLAB_REPOSITORY_NAME​

The GitLab repository name.

GITLAB_REPOSITORY_NAME=product-dev

GITLAB_PROJECT_SLUG​

The GitLab project's URL PATH.

GITLAB_PROJECT_SLUG=company/eng/product-dev

VERSION_CONTROL_LOCKED​

When set to true, creates a read-only instance of Retool where:

  • New apps cannot be created
  • Existing apps cannot be edited
  • Existing apps cannot be marked as protected

This setting does not affect protected resources.

VERSION_CONTROL_LOCKED=true