Variables

Vortex uses environment variables to configure workflows without code changes.

There are two main types of variables:

Project Configuration Variables are set once during project setup and remain constant throughout the project lifecycle. These are typically configured in the .env file, or within the CI or hosting provider environments.

Workflow Control Variables can be changed during the project lifecycle to alter workflow behavior. For example, changing how deployment behaves or skipping a certain code branch deployment within CI.

Override order (bottom values win)

default value in container taken from image
default value in docker-compose.yml
value in .env (last value wins)
value in .env.local (last value wins)
value from environment

Variables list

`AHOY_CONFIRM_RESPONSE`

Set to y to suppress Ahoy prompts.

Default value: UNDEFINED

Defined in: .env.local.example

`AHOY_CONFIRM_WAIT_SKIP`

When Ahoy prompts are suppressed ($AHOY_CONFIRM_RESPONSE is 1), the command
will wait for 3 seconds before proceeding.
Set this variable to "1" to skip the wait.

Default value: 1

Defined in: .env.local.example

`COMPOSE_PROJECT_NAME`

Docker Compose project name.

Sets the project name for a Docker Compose project. Influences container and
network names.

Defaults to the name of the project directory.

Default value: UNDEFINED

Defined in: ENVIRONMENT

`DATABASE_CHARSET`

Local database charset.

Variable is not used in hosting environment.

Default value: utf8mb4

Defined in: docker-compose.yml

`DATABASE_COLLATION`

Local database collation.

Variable is not used in hosting environment.

Default value: utf8mb4_general_ci

Defined in: docker-compose.yml

`DATABASE_DATABASE`

Database name.

Default value: UNDEFINED

Defined in: LAGOON ENVIRONMENT

`DATABASE_HOST`

Local database host.

Variable is not used in hosting environment.

Default value: database

Defined in: docker-compose.yml, scripts/vortex/info.sh

`DATABASE_NAME`

Local database name.

Variable is not used in hosting environment.

Default value: drupal

Defined in: docker-compose.yml

`DATABASE_PASSWORD`

Local database password.

Variable is not used in hosting environment.

Default value: drupal

Defined in: docker-compose.yml, scripts/vortex/info.sh

`DATABASE_PORT`

Local database port.

Variable is not used in hosting environment.

Default value: 3306

Defined in: docker-compose.yml, scripts/vortex/info.sh

`DATABASE_USERNAME`

Local database user.

Variable is not used in hosting environment.

Default value: drupal

Defined in: docker-compose.yml, scripts/vortex/info.sh

`DOCKER_CONFIG`

Path to Docker configuration directory.

Default value: ${HOME}/.docker

Defined in: scripts/vortex/login-container-registry.sh

`DRUPAL_ADMIN_EMAIL`

Drupal admin email. May need to be reset if database was sanitized.

Default value: UNDEFINED

Defined in: .env

`DRUPAL_CLAMAV_ENABLED`

Enable ClamAV integration.

Default value: 1

Defined in: .env

`DRUPAL_CLAMAV_MODE`

ClamAV mode.

Run ClamAV in either daemon mode by setting it to 0 (or 'daemon') or in
executable mode by setting it to 1.

Default value: daemon

Defined in: .env

`DRUPAL_CONFIG_PATH`

Drupal configuration directory.

Path from the web root directory to the configuration directory.
If not set, the default location is inside a randomly-named directory in the
public files path.

Default value: ../config/default

Defined in: .env

`DRUPAL_ENVIRONMENT`

Override detected Drupal environment type.

Used in the application to override the automatically detected environment type.

Default value: UNDEFINED

Defined in: ENVIRONMENT

`DRUPAL_MAINTENANCE_THEME`

Drupal maintenance theme name.

Default value: your_site_theme

Defined in: .env

`DRUPAL_PRIVATE_FILES`

Path to private files.

Default value: ${DRUPAL_PUBLIC_FILES}/private

Defined in: docker-compose.yml

`DRUPAL_PROFILE`

Drupal profile name.

Default value: standard

Defined in: .env, scripts/vortex/provision.sh

`DRUPAL_PUBLIC_FILES`

Path to public files.

Default value: ./${WEBROOT}/sites/default/files

Defined in: docker-compose.yml

`DRUPAL_REDIS_ENABLED`

Enable Redis/Valkey integration.
See settings.redis.php for details.

Default value: 1

Defined in: .env

`DRUPAL_SHIELD_PRINT`

Shield message.

Default value: Restricted access.

Defined in: .env

`DRUPAL_SITE_EMAIL`

Drupal site email.
Used only when installing from profile.

Default value: webmaster@your-site-domain.example

Defined in: .env, scripts/vortex/provision.sh

`DRUPAL_SITE_NAME`

Drupal site name.
Used only when installing from profile.

Default value: ${VORTEX_PROJECT}

Defined in: .env, scripts/vortex/provision.sh

`DRUPAL_STAGE_FILE_PROXY_ORIGIN`

Stage file proxy origin.

If using Shield, the HTTP authentication credentials will be automatically
added to the origin URL.

Default value: https://www.your-site-domain.example

Defined in: .env

`DRUPAL_TEMPORARY_FILES`

Path to temporary files.

Default value: ${DRUPAL_PRIVATE_FILES}/tmp

Defined in: docker-compose.yml

`DRUPAL_THEME`

Drupal theme name.

Default value: your_site_theme

Defined in: .env

`DRUPAL_TRUSTED_HOSTS`

Trusted host patterns.

Comma-separated list of domains for trusted host patterns. These domains will
be added to the trusted host patterns alongside any other routes defined by
the hosting provider.

Default value: your-site-domain.example,www.your-site-domain.example

Defined in: .env

`LAGOON_PROJECT`

Lagoon project name. May be different from $VORTEX_PROJECT.

Update drush/sites/lagoon.site.yml if you update this value.

Default value: your_site

Defined in: .env, scripts/vortex/deploy-lagoon.sh, scripts/vortex/download-db-lagoon.sh

`NEWRELIC_ENABLED`

Enable New Relic in Lagoon environment.

Set as project-wide variable.

Default value: UNDEFINED

Defined in: LAGOON ENVIRONMENT

`NEWRELIC_LICENSE`

New Relic license.

Set as project-wide variable.

Default value: UNDEFINED

Defined in: LAGOON ENVIRONMENT

`PACKAGE_TOKEN`

GitHub token used to overcome API rate limits or access private repositories.
@see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token

Default value: UNDEFINED

Defined in: .env.local.example

`RENOVATE_DEPENDENCY_DASHBOARD`

Whether to enable self-hosted Renovate bot dashboard.

Default value: false

Defined in: CI config

`RENOVATE_DRY_RUN`

Whether to allow self-hosted Renovate bot make changes to the repository.

Default value: false

Defined in: CI config

`RENOVATE_GIT_AUTHOR`

Commit author for self-hosted Renovate bot.

Default value: 'Renovate Self Hosted <renovatebot@your-site-domain.example>'

Defined in: CI config

`RENOVATE_REPOSITORIES`

Renovate repositories to manage.
Set as "organization/repository".

Default value: UNDEFINED

Defined in: CI config

`RENOVATE_TOKEN`

Self-hosted Renovate bot token.
Create a GitHub token with a permission to write to a repository.

Default value: UNDEFINED

Defined in: CI config

`TARGET_ENV_REMAP`

Special variable to remap target env to the sub-domain prefix based on UI name.

Default value: ${target_env}

Defined in: scripts/vortex/task-purge-cache-acquia.sh

`TZ`

The timezone used within the containers.

Default value: UTC

Defined in: .env

`VORTEX_ACQUIA_APP_NAME`

Acquia application name.

Default value: UNDEFINED

Defined in: .env, scripts/vortex/download-db-acquia.sh, scripts/vortex/task-copy-db-acquia.sh, scripts/vortex/task-copy-files-acquia.sh, scripts/vortex/task-purge-cache-acquia.sh

`VORTEX_ACQUIA_KEY`

Acquia Cloud API key.

Default value: UNDEFINED

Defined in: .env.local.example, scripts/vortex/download-db-acquia.sh, scripts/vortex/task-copy-db-acquia.sh, scripts/vortex/task-copy-files-acquia.sh, scripts/vortex/task-purge-cache-acquia.sh

`VORTEX_ACQUIA_SECRET`

Acquia Cloud API secret.

Default value: UNDEFINED

`VORTEX_CI_ARTIFACTS`

Directory to store test artifacts in CI.

Default value: /tmp/artifacts

Defined in: CI config

`VORTEX_CI_BEHAT_IGNORE_FAILURE`

Ignore Behat test failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_BEHAT_PROFILE`

Test Behat profile to use in CI. If not set, the default profile will be used.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_COMPOSER_NORMALIZE_IGNORE_FAILURE`

Ignore composer normalize failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_COMPOSER_VALIDATE_IGNORE_FAILURE`

Ignore composer validate failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_DCLINT_IGNORE_FAILURE`

Ignore DCLint failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_GHERKIN_LINT_IGNORE_FAILURE`

Ignore Gherkin Lint failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_HADOLINT_IGNORE_FAILURE`

Ignore Hadolint failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_NODEJS_LINT_IGNORE_FAILURE`

Ignore NodeJS linters failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_PHPCS_IGNORE_FAILURE`

Ignore PHPCS failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_PHPMD_IGNORE_FAILURE`

Ignore PHPMD failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_PHPSTAN_IGNORE_FAILURE`

Ignore PHPStan failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_PHPUNIT_IGNORE_FAILURE`

Ignore PHPUnit test failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_RECTOR_IGNORE_FAILURE`

Ignore Rector failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CI_TEST_RESULTS`

Directory to store test results in CI.

Default value: /tmp/tests

Defined in: CI config

`VORTEX_CI_TWIG_CS_FIXER_IGNORE_FAILURE`

Ignore Twig CS Fixer failures.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_CONTAINER_REGISTRY`

Container registry name.

Provide port, if required as <server_name>:<port>.

Default value: docker.io

Defined in: .env, scripts/vortex/login-container-registry.sh

`VORTEX_CONTAINER_REGISTRY_PASS`

The password (token) to log into the container registry.

Default value: ${DOCKER_PASS}

Defined in: .env.local.example, scripts/vortex/login-container-registry.sh

`VORTEX_CONTAINER_REGISTRY_USER`

The username to log into the container registry.

Default value: ${DOCKER_USER}

Defined in: .env.local.example, scripts/vortex/login-container-registry.sh

`VORTEX_DB_DIR`

Database dump directory.

The directory is used to store the database dump files for import and export.

Default value: ./.data

Defined in: .env, scripts/vortex/download-db-acquia.sh, scripts/vortex/download-db-container-registry.sh, scripts/vortex/download-db-ftp.sh, scripts/vortex/download-db-lagoon.sh, scripts/vortex/download-db-url.sh, scripts/vortex/download-db.sh, scripts/vortex/provision.sh

`VORTEX_DB_DOWNLOAD_ACQUIA_DB_NAME`

Acquia database name to download the database from.

Default value: your_site

Defined in: .env, scripts/vortex/download-db-acquia.sh

`VORTEX_DB_DOWNLOAD_ENVIRONMENT`

Environment to download the database from.

Applies to hosting environments.
Note that depending on the hosting provider, this variable may represent
a branch name or an environment name.

Default value: prod

Defined in: .env, scripts/vortex/download-db-acquia.sh, scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_FORCE`

Always override existing downloaded DB dump.

Default value: 1

Defined in: .env.local.example, .env.local.example, scripts/vortex/download-db.sh

`VORTEX_DB_DOWNLOAD_FTP_FILE`

Database dump FTP file name.

Default value: db.sql

Defined in: .env, scripts/vortex/download-db-ftp.sh

`VORTEX_DB_DOWNLOAD_FTP_HOST`

Database dump FTP host.

Default value: UNDEFINED

Defined in: .env, scripts/vortex/download-db-ftp.sh

`VORTEX_DB_DOWNLOAD_FTP_PASS`

Database dump FTP password.

Default value: UNDEFINED

Defined in: .env.local.example, scripts/vortex/download-db-ftp.sh

`VORTEX_DB_DOWNLOAD_FTP_PORT`

Database dump FTP port.

Default value: 21

Defined in: .env, scripts/vortex/download-db-ftp.sh

`VORTEX_DB_DOWNLOAD_FTP_USER`

Database dump FTP user.

Default value: UNDEFINED

Defined in: .env.local.example, scripts/vortex/download-db-ftp.sh

`VORTEX_DB_DOWNLOAD_LAGOON_REMOTE_DIR`

Remote DB dump directory location.

Default value: /tmp

Defined in: scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_LAGOON_REMOTE_FILE`

Remote DB dump file name. Cached by the date suffix.

Default value: db_$(date +%Y%m%d).sql

Defined in: scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_LAGOON_REMOTE_FILE_CLEANUP`

Wildcard file name to cleanup previously created dump files.

Cleanup runs only if the variable is set and $VORTEX_DB_DOWNLOAD_LAGOON_REMOTE_FILE
does not exist.

Default value: db_*.sql

Defined in: scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_LAGOON_SSH_HOST`

The SSH host of the Lagoon environment.

Default value: ssh.lagoon.amazeeio.cloud

Defined in: scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_LAGOON_SSH_PORT`

The SSH port of the Lagoon environment.

Default value: 32222

Defined in: scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_LAGOON_SSH_USER`

The SSH user of the Lagoon environment.

Default value: ${LAGOON_PROJECT}-${VORTEX_DB_DOWNLOAD_ENVIRONMENT}

Defined in: scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_NO_CACHE`

Flag to download a fresh copy of the database.

Default value: UNDEFINED

Defined in: scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_PROCEED`

Proceed with download.

Default value: 1

Defined in: scripts/vortex/download-db.sh

`VORTEX_DB_DOWNLOAD_SOURCE`

Database download source.

Default value: url

Defined in: .env, scripts/vortex/download-db.sh

`VORTEX_DB_DOWNLOAD_SSH_FILE`

Default SSH file used if custom fingerprint is not provided.

Default value: ${HOME}/.ssh/id_rsa

Defined in: scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_SSH_FINGERPRINT`

SSH key fingerprint used to connect to a remote.

Default value: UNDEFINED

Defined in: scripts/vortex/download-db-lagoon.sh

`VORTEX_DB_DOWNLOAD_UNZIP_PASSWORD`

Password for unzipping password-protected zip files.

Default value: UNDEFINED

Defined in: scripts/vortex/download-db-url.sh

`VORTEX_DB_DOWNLOAD_URL`

Database dump file sourced from a URL.

HTTP Basic Authentication credentials should be embedded into the value.

Default value: UNDEFINED

Defined in: .env, scripts/vortex/download-db-url.sh

`VORTEX_DB_EXPORT_CONTAINER_REGISTRY`

Container registry name.

Default value: docker.io

Defined in: scripts/vortex/export-db-image.sh

`VORTEX_DB_EXPORT_FILE_DIR`

Directory with database dump file.

Default value: ./.data

Defined in: scripts/vortex/export-db-file.sh

`VORTEX_DB_EXPORT_IMAGE`

Container image to store in a form of <org>/<repository>.

Default value: UNDEFINED

Defined in: scripts/vortex/export-db-image.sh, scripts/vortex/export-db.sh

`VORTEX_DB_EXPORT_IMAGE_ARCHIVE_FILE`

Container image archive file name.

Default value: UNDEFINED

Defined in: scripts/vortex/export-db-image.sh

`VORTEX_DB_EXPORT_IMAGE_DIR`

Directory with database image archive file.

Default value: ${VORTEX_DB_DIR}

Defined in: scripts/vortex/export-db-image.sh

`VORTEX_DB_EXPORT_SERVICE_NAME`

The service name to capture.

Default value: database

Defined in: scripts/vortex/export-db-image.sh

`VORTEX_DB_FILE`

Database dump file name.

The file is used to import the database into an empty database container.

Default value: db.sql

Defined in: .env, scripts/vortex/download-db-acquia.sh, scripts/vortex/download-db-ftp.sh, scripts/vortex/download-db-lagoon.sh, scripts/vortex/download-db-url.sh, scripts/vortex/provision.sh

`VORTEX_DB_IMAGE`

Name of the database container image to use.

See https://github.com/drevops/mariadb-drupal-data to seed your DB image.

Default value: UNDEFINED

Defined in: .env, scripts/vortex/download-db-container-registry.sh, scripts/vortex/export-db.sh, scripts/vortex/info.sh, scripts/vortex/provision.sh

`VORTEX_DB_IMAGE_BASE`

Name of the database fall-back container image to use.

If the image specified in $VORTEX_DB_IMAGE does not exist and base
image was provided - it will be used as a "clean slate" for the database.

Default value: UNDEFINED

Defined in: .env, scripts/vortex/download-db-container-registry.sh

`VORTEX_DEBUG`

Set to 1 to print debug information in Vortex scripts.

Default value: UNDEFINED

Defined in: .env.local.example

`VORTEX_DEPLOY_ACTION`

Deployment action.

Values can be one of: deploy, deploy_override_db, destroy.

deploy: Deploy code and preserve database in the environment.
deploy_override_db: Deploy code and override database in the environment.
destroy: Destroy the environment (if the provider supports it).

Default value: create

Defined in: scripts/vortex/deploy-lagoon.sh, scripts/vortex/deploy.sh

`VORTEX_DEPLOY_ALLOW_SKIP`

Flag to allow skipping of a deployment using additional flags.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy.sh

`VORTEX_DEPLOY_ARTIFACT_DST_BRANCH`

Remote repository branch. Can be a specific branch or a token.
@see https://github.com/drevops/git-artifact#token-support

Default value: [branch]

Defined in: scripts/vortex/deploy-artifact.sh

`VORTEX_DEPLOY_ARTIFACT_GIT_REMOTE`

Remote repository to push code to.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-artifact.sh

`VORTEX_DEPLOY_ARTIFACT_GIT_USER_EMAIL`

Name of the user who will be committing to a remote repository.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-artifact.sh

`VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAME`

Email address of the user who will be committing to a remote repository.

Default value: Deployment Robot

Defined in: scripts/vortex/deploy-artifact.sh

`VORTEX_DEPLOY_ARTIFACT_LOG`

Deployment log file name.

Default value: ${VORTEX_DEPLOY_ARTIFACT_ROOT}/deployment_log.txt

Defined in: scripts/vortex/deploy-artifact.sh

`VORTEX_DEPLOY_ARTIFACT_ROOT`

The root directory where the deployment script should run from. Defaults to
the current directory.

Default value: $(pwd)

Defined in: scripts/vortex/deploy-artifact.sh

`VORTEX_DEPLOY_ARTIFACT_SRC`

Source of the code to be used for artifact building.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-artifact.sh

`VORTEX_DEPLOY_BRANCH`

The Lagoon branch to deploy.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-lagoon.sh, scripts/vortex/deploy.sh

`VORTEX_DEPLOY_CONTAINER_REGISTRY`

Container registry name.

Provide port, if required as <server_name>:<port>.

Default value: docker.io

Defined in: scripts/vortex/deploy-container-registry.sh

`VORTEX_DEPLOY_CONTAINER_REGISTRY_IMAGE_TAG`

The tag of the container image.

Default value: latest

Defined in: scripts/vortex/deploy-container-registry.sh

`VORTEX_DEPLOY_CONTAINER_REGISTRY_MAP`

Comma-separated map of container services and images to use for deployment in
format "service1=org/image1,service2=org/image2".

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-container-registry.sh, scripts/vortex/export-db.sh

`VORTEX_DEPLOY_CONTAINER_REGISTRY_PASS`

The password to login into the container registry.

Default value: ${VORTEX_CONTAINER_REGISTRY_PASS}

Defined in: scripts/vortex/deploy-container-registry.sh

`VORTEX_DEPLOY_CONTAINER_REGISTRY_USER`

The username to login into the container registry.

Default value: ${VORTEX_CONTAINER_REGISTRY_USER}

Defined in: scripts/vortex/deploy-container-registry.sh

`VORTEX_DEPLOY_LAGOON_FAIL_ENV_LIMIT_EXCEEDED`

Flag to control failure behavior when Lagoon environment limits are exceeded.
When set to 0, the deployment will exit with success instead of failure.
When set to 1, the deployment will fail.

Default value: 0

Defined in: scripts/vortex/deploy-lagoon.sh

`VORTEX_DEPLOY_LAGOON_INSTANCE`

The Lagoon instance name to interact with.

Default value: amazeeio

Defined in: scripts/vortex/deploy-lagoon.sh

`VORTEX_DEPLOY_LAGOON_INSTANCE_GRAPHQL`

The Lagoon instance GraphQL endpoint to interact with.

Default value: https://api.lagoon.amazeeio.cloud/graphql

Defined in: scripts/vortex/deploy-lagoon.sh

`VORTEX_DEPLOY_LAGOON_INSTANCE_HOSTNAME`

The Lagoon instance hostname to interact with.

Default value: ssh.lagoon.amazeeio.cloud

Defined in: scripts/vortex/deploy-lagoon.sh

`VORTEX_DEPLOY_LAGOON_INSTANCE_PORT`

The Lagoon instance port to interact with.

Default value: 32222

Defined in: scripts/vortex/deploy-lagoon.sh

`VORTEX_DEPLOY_MODE`

Deployment mode.

Values can be one of: branch, tag.

Default value: branch

Defined in: scripts/vortex/deploy.sh

`VORTEX_DEPLOY_PR`

The PR number to deploy.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-lagoon.sh, scripts/vortex/deploy.sh

`VORTEX_DEPLOY_PR_BASE_BRANCH`

The PR base branch (the branch the PR is raised against). Defaults to 'develop'.

Default value: develop

Defined in: scripts/vortex/deploy-lagoon.sh

`VORTEX_DEPLOY_PR_HEAD`

The PR head branch to deploy.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-lagoon.sh

`VORTEX_DEPLOY_SKIP`

Skip all deployments.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_DEPLOY_SSH_FILE`

Default SSH file used if custom fingerprint is not provided.

Default value: ${HOME}/.ssh/id_rsa

Defined in: scripts/vortex/deploy-artifact.sh, scripts/vortex/deploy-lagoon.sh

`VORTEX_DEPLOY_SSH_FINGERPRINT`

SSH key fingerprint used to connect to remote.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-artifact.sh, scripts/vortex/deploy-lagoon.sh

`VORTEX_DEPLOY_TYPES`

Deployment occurs when tests pass in the CI environment.
@see https://www.vortextemplate.com/docs/workflows/deployment

Default value: artifact

Defined in: .env, scripts/vortex/deploy.sh

`VORTEX_DEPLOY_WEBHOOK_METHOD`

Webhook call method.

Default value: GET

Defined in: scripts/vortex/deploy-webhook.sh

`VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS`

The status code of the expected response.

Default value: 200

Defined in: scripts/vortex/deploy-webhook.sh

`VORTEX_DEPLOY_WEBHOOK_URL`

The URL of the webhook to call.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-webhook.sh

`VORTEX_DOCTOR_CHECK_BOOTSTRAP`

Default value: UNDEFINED

Defined in: scripts/vortex/doctor.sh

`VORTEX_DOCTOR_CHECK_CONTAINERS`

Default value: 0

Defined in: scripts/vortex/doctor.sh

`VORTEX_DOCTOR_CHECK_MINIMAL`

Check minimal Doctor requirements.

Default value: 0

Defined in: scripts/vortex/doctor.sh

`VORTEX_DOCTOR_CHECK_PORT`

Default value: UNDEFINED

Defined in: scripts/vortex/doctor.sh

`VORTEX_DOCTOR_CHECK_PYGMY`

Default value: UNDEFINED

Defined in: scripts/vortex/doctor.sh

`VORTEX_DOCTOR_CHECK_SSH`

Default value: UNDEFINED

Defined in: scripts/vortex/doctor.sh

`VORTEX_DOCTOR_CHECK_TOOLS`

Default value: 1

Defined in: scripts/vortex/doctor.sh

`VORTEX_DOCTOR_CHECK_WEBSERVER`

Default value: UNDEFINED

Defined in: scripts/vortex/doctor.sh

`VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY`

Container registry name.

Provide port, if required as <server_name>:<port>.

Default value: docker.io

Defined in: scripts/vortex/download-db-container-registry.sh

`VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_PASS`

The password to login into the container registry.

Default value: ${VORTEX_CONTAINER_REGISTRY_PASS}

Defined in: scripts/vortex/download-db-container-registry.sh

`VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_USER`

The username to login into the container registry.

Default value: ${VORTEX_CONTAINER_REGISTRY_USER}

Defined in: scripts/vortex/download-db-container-registry.sh

`VORTEX_EXPORT_DB_CONTAINER_REGISTRY_DEPLOY_PROCEED`

Proceed with container image deployment after it was exported.

Default value: UNDEFINED

Defined in: CI config

`VORTEX_FRONTEND_BUILD_SKIP`

Skip building of the frontend.

Default value: UNDEFINED

Defined in: .env

`VORTEX_INSTALLER_PATH`

The path to the installer script.
If set, this will override the VORTEX_INSTALLER_URL.

Default value: UNDEFINED

Defined in: scripts/vortex/update-vortex.sh

`VORTEX_INSTALLER_TEMPLATE_REPO`

Vortex remote or local template repo URI, optionally including reference.

Examples:
https://github.com/drevops/vortex.git # Will auto-discover the latest stable tag from remote repo.
https://github.com/drevops/vortex.git@stable # Will auto-discover the latest stable tag from remote repo.
https://github.com/drevops/vortex.git@`1`.`2`.`3` # Will use specific release from remote repo.
https://github.com/drevops/vortex.git@abcd123 # Will use specific commit from remote repo.
file:///local/path/to/vortex.git # Will auto-discover the latest stable tag from local repo.
file:///local/path/to/vortex.git@stable # Will auto-discover the latest stable tag from local repo.
file:///local/path/to/vortex.git@1.2.3 # Will use specific release from local repo.
file:///local/path/to/vortex.git@abcd123 # Will use specific commit from local repo.
/local/path/to/vortex.git # Will auto-discover the latest stable tag from local repo.
/local/path/to/vortex.git@stable # Will auto-discover the latest stable tag from local repo.
/local/path/to/vortex.git@1.2.3 # Will use specific release from local repo.
/local/path/to/vortex.git@abcd123 # Will use specific commit from local repo.

Default value: https://github.com/drevops/vortex.git@stable

Defined in: scripts/vortex/update-vortex.sh

`VORTEX_INSTALLER_URL`

The URL of the installer script.

Default value: https://www.vortextemplate.com/install

Defined in: scripts/vortex/update-vortex.sh

`VORTEX_INSTALLER_URL_CACHE_BUST`

Cache busting parameter for the installer URL.

Default value: $(date +%s)

Defined in: scripts/vortex/update-vortex.sh

`VORTEX_LAGOONCLI_FORCE_INSTALL`

Flag to force the installation of Lagoon CLI.

Default value: UNDEFINED

Defined in: scripts/vortex/deploy-lagoon.sh, scripts/vortex/task-custom-lagoon.sh

`VORTEX_LAGOONCLI_PATH`

Location of the Lagoon CLI binary.

Default value: /tmp

Defined in: scripts/vortex/deploy-lagoon.sh, scripts/vortex/task-custom-lagoon.sh

`VORTEX_LAGOONCLI_VERSION`

Lagoon CLI version to use.

Default value: v0.32.0

Defined in: scripts/vortex/deploy-lagoon.sh, scripts/vortex/task-custom-lagoon.sh

`VORTEX_LAGOON_PRODUCTION_BRANCH`

Dedicated branch to identify the production environment.

Default value: main

Defined in: .env

`VORTEX_LOCALDEV_URL`

Local development URL.

Based on the $COMPOSE_PROJECT_NAME environment variable, which is set by
Docker Compose to the name of the project directory.

Override only if you need to use a different URL than the default.

Default value: example-site.docker.amazee.io

Defined in: .env.local.example, scripts/vortex/info.sh

`VORTEX_NOTIFY_BRANCH`

Deployment reference branch.

Default value: UNDEFINED

Defined in: scripts/vortex/notify-github.sh, scripts/vortex/notify-jira.sh

`VORTEX_NOTIFY_CHANNELS`

The channels of the notifications.

A combination of comma-separated values: email,newrelic,github,jira

Default value: email

Defined in: .env, scripts/vortex/notify.sh

`VORTEX_NOTIFY_EMAIL_ENVIRONMENT_URL`

Environment URL to notify about.

Default value: ${VORTEX_NOTIFY_ENVIRONMENT_URL}

Defined in: scripts/vortex/notify-email.sh

`VORTEX_NOTIFY_EMAIL_FROM`

An email address to send notifications from.

Applies to email notifications.

Default value: webmaster@your-site-domain.example

Defined in: .env, scripts/vortex/notify-email.sh

`VORTEX_NOTIFY_EMAIL_PROJECT`

Project name to notify.

Default value: ${VORTEX_NOTIFY_PROJECT}

Defined in: scripts/vortex/notify-email.sh

`VORTEX_NOTIFY_EMAIL_PR_NUMBER`

Git reference to notify about.

Default value: ${VORTEX_NOTIFY_PR_NUMBER}

Defined in: scripts/vortex/notify-email.sh

`VORTEX_NOTIFY_EMAIL_RECIPIENTS`

Email address(es) to send notifications to.

Applies to email notifications.

Multiple names can be specified as a comma-separated list of email addresses
with optional names in the format "email|name".
Example: "to1@example.com|Jane Doe, to2@example.com|John Doe"

Default value: webmaster@your-site-domain.example|Webmaster

Defined in: .env, scripts/vortex/notify-email.sh

`VORTEX_NOTIFY_EMAIL_REF`

Git reference to notify about.

Default value: ${VORTEX_NOTIFY_REF}

Defined in: scripts/vortex/notify-email.sh

`VORTEX_NOTIFY_ENVIRONMENT_TYPE`

Deployment environment type: production, uat, dev, pr.

Default value: PR

Defined in: scripts/vortex/notify-github.sh

`VORTEX_NOTIFY_ENVIRONMENT_URL`

Deployment environment URL.

Default value: UNDEFINED

Defined in: scripts/vortex/notify-github.sh, scripts/vortex/notify-jira.sh, scripts/vortex/notify-webhook.sh

`VORTEX_NOTIFY_EVENT`

The event to notify about. Can be 'pre_deployment' or 'post_deployment'.

Default value: UNDEFINED

Defined in: scripts/vortex/notify-github.sh, scripts/vortex/notify.sh

`VORTEX_NOTIFY_GITHUB_TOKEN`

Deployment GitHub token.

Default value: ${GITHUB_TOKEN}

Defined in: scripts/vortex/notify-github.sh

`VORTEX_NOTIFY_JIRA_ASSIGNEE`

Assign the ticket to this account.

If left empty - no assignment will be performed.

Default value: UNDEFINED

Defined in: scripts/vortex/notify-jira.sh

`VORTEX_NOTIFY_JIRA_COMMENT_PREFIX`

Deployment comment prefix.

Default value: Deployed to

Defined in: scripts/vortex/notify-jira.sh

`VORTEX_NOTIFY_JIRA_ENDPOINT`

JIRA API endpoint.

Default value: https://jira.atlassian.com

Defined in: scripts/vortex/notify-jira.sh

`VORTEX_NOTIFY_JIRA_TOKEN`

JIRA token.

Default value: UNDEFINED

Defined in: scripts/vortex/notify-jira.sh

`VORTEX_NOTIFY_JIRA_TRANSITION`

State to move the ticket to.

If left empty - no transition will be performed.

Default value: UNDEFINED

Defined in: scripts/vortex/notify-jira.sh

`VORTEX_NOTIFY_JIRA_USER`

JIRA user.

Default value: UNDEFINED

Defined in: scripts/vortex/notify-jira.sh