Skip to main content

Variables

Vortex uses environment variables to configure scripts without the need to change the code to alter behavior.

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.

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

.env and .env.local files​

Only required variables are listed in .env to keep it concise. There are more optional variables set in scripts with sensible defaults. These are documented below - add them to your .env file as needed to override the defaults.

The .env.local file is intended to store local overrides and sensitive information like passwords and API keys. This file is ignored by Git and should not be committed to the repository. It is a good practice to store local overrides and sensitive information in .env.local to keep them separate from the main .env file.

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

Naming conventions​

All variables used by Vortex scripts start with the VORTEX_ prefix to differentiate them from other environment variables.

All Drupal-specific environment variables start with the DRUPAL_ prefix.

Any other third-party service variables (like COMPOSER_TOKEN or NEWRELIC_API_KEY) are used as-is.

Default values​

All required variables used by Vortex scripts have checks in place to ensure they are set before proceeding. If a required variable is missing, the script will fail with a clear error message.

All optional variables used by Vortex scripts have default values defined within the scripts. This ensures that scripts can run out-of-the-box without requiring extensive configuration.

Variables without values provided or set in scripts are considered defects in the template implementation and should be reported. This is because in Shell scripts not having a value or having an empty value may lead to unexpected behavior in when these values are evaluated in conditions. Moreover, having empty or unset values do not allow to have a reliable multi-level override mechanism for variables.

For example, a variable can have a default value in the script, be overridden in the .env file, and further overridden in the CI/hosting for all environments, and then additionally overridden for a specific environment.

Boolean variables​

Boolean variables use 1 for true and 0 for false values to ensure consistency across different environments.

We do not use true/false, yes/no, or other variations to make value truly cross-platform (some systems may interpret true and false differently).

Variables list​

The list below is automatically generated with Shellvar from all Shell scripts.

NameDescriptionDefault valueDefined or used in
AHOY_CONFIRM_RESPONSESet to y to suppress Ahoy prompts.UNDEFINED.env.local.example
AHOY_CONFIRM_WAIT_SKIPWhen 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.1.env.local.example
COMPOSE_PROJECT_NAMEDocker 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.		UNDEFINEDENVIRONMENT
DATABASE_CHARSETLocal database charset.

Variable is not used in hosting environment.		utf8mb4docker-compose.yml
DATABASE_COLLATIONLocal database collation.

Variable is not used in hosting environment.		utf8mb4_general_cidocker-compose.yml
DATABASE_DATABASEDatabase name.UNDEFINEDLAGOON ENVIRONMENT
DATABASE_NAMELocal database name.

Variable is not used in hosting environment.		drupaldocker-compose.yml
DRUPAL_ADMIN_EMAILDrupal admin email. May need to be reset if database was sanitized.UNDEFINED.env
DRUPAL_CLAMAV_ENABLEDEnable ClamAV integration.1.env
DRUPAL_CLAMAV_MODEClamAV mode.

Run ClamAV in either daemon mode by setting it to 0 (or 'daemon') or in executable mode by setting it to 1.		daemon.env
DRUPAL_CONFIG_PATHDrupal 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.		../config/default.env
DRUPAL_ENVIRONMENTOverride detected Drupal environment type.

Used in the application to override the automatically detected environment type.		UNDEFINEDENVIRONMENT
DRUPAL_MAINTENANCE_THEMEDrupal maintenance theme name.your_site_theme.env
DRUPAL_PRIVATE_FILESPath to private files.${DRUPAL_PUBLIC_FILES}/privatedocker-compose.yml
DRUPAL_PROFILEDrupal profile name.standard.env, scripts/vortex/provision.sh
DRUPAL_PUBLIC_FILESPath to public files../${WEBROOT}/sites/default/filesdocker-compose.yml
DRUPAL_REDIS_ENABLEDEnable Redis integration. See settings.redis.php for details.1.env
DRUPAL_SHIELD_PRINTShield message.Restricted access..env
DRUPAL_SITE_EMAILDrupal site email.webmaster@example.comscripts/vortex/provision.sh, .env
DRUPAL_SITE_NAMEDrupal site name.Example sitescripts/vortex/provision.sh, .env
DRUPAL_STAGE_FILE_PROXY_ORIGINStage file proxy origin.

If using Shield, the HTTP authentication credentials will be automatically added to the origin URL.		https://www.your-site-domain.example.env
DRUPAL_TEMPORARY_FILESPath to temporary files.${DRUPAL_PRIVATE_FILES}/tmpdocker-compose.yml
DRUPAL_THEMEDrupal theme name.your_site_theme.env
DRUPAL_TRUSTED_HOSTSTrusted 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.		your-site-domain.example,www.your-site-domain.example.env
LAGOON_PROJECTLagoon project name. May be different from $VORTEX_PROJECT.

Update drush/sites/lagoon.site.yml if you update this value.		your_site.env
MIGRATION_FEEDBACKFeedback frequency for migration progress.50scripts/custom/provision-20-migration.sh
MIGRATION_IMPORT_LIMITLimit the number of entities to import. Set to 'all' to import all.50scripts/custom/provision-20-migration.sh
MIGRATION_ROLLBACK_SKIPSkip rollback of migrations before import.1scripts/custom/provision-20-migration.sh
MIGRATION_SKIPSkip all migrations.0scripts/custom/provision-20-migration.sh
MIGRATION_SOURCE_DB_IMPORTImport migration source database. Set to 1 to import, 0 to skip.0scripts/custom/provision-20-migration.sh
MIGRATION_SOURCE_DB_PROBE_TABLETable name to probe in the source database to verify it is not corrupted.categoriesscripts/custom/provision-20-migration.sh
MIGRATION_UPDATEUpdate already imported entities during migration.0scripts/custom/provision-20-migration.sh
NEWRELIC_ENABLEDEnable New Relic in Lagoon environment.

Set as project-wide variable.		UNDEFINEDLAGOON ENVIRONMENT
NEWRELIC_LICENSENew Relic license.

Set as project-wide variable.		UNDEFINEDLAGOON ENVIRONMENT
PACKAGE_TOKENGitHub 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-tokenUNDEFINED.env.local.example
RENOVATE_DEPENDENCY_DASHBOARDWhether to enable self-hosted Renovate bot dashboard.falseCI config
RENOVATE_DRY_RUNWhether to allow self-hosted Renovate bot make changes to the repository.falseCI config
RENOVATE_GIT_AUTHORCommit author for self-hosted Renovate bot.'Renovate Self Hosted <renovatebot@your-site-domain.example>'CI config
RENOVATE_REPOSITORIESRenovate repositories to manage. Set as "organization/repository".UNDEFINEDCI config
RENOVATE_TOKENSelf-hosted Renovate bot token. Create a GitHub token with a permission to write to a repository.UNDEFINEDCI config
TARGET_ENV_REMAPSpecial variable to remap target env to the sub-domain prefix based on UI name.${target_env}scripts/vortex/task-purge-cache-acquia.sh
TZThe timezone used within the containers.UTC.env
VORTEX_ACQUIA_APP_NAMEAcquia application name.UNDEFINED.env
VORTEX_ACQUIA_KEYAcquia Cloud API key.UNDEFINED.env.local.example
VORTEX_ACQUIA_SECRETAcquia Cloud API secret.UNDEFINED.env.local.example
VORTEX_CI_ARTIFACTSDirectory to store test artifacts in CI./tmp/artifactsCI config
VORTEX_CI_BEHAT_IGNORE_FAILUREIgnore Behat test failures.UNDEFINEDCI config
VORTEX_CI_BEHAT_PROFILETest Behat profile to use in CI. If not set, the default profile will be used.UNDEFINEDCI config
VORTEX_CI_CODE_COVERAGE_PR_COMMENT_SKIPSkip posting code coverage report as a PR comment.UNDEFINEDCI config
VORTEX_CI_CODE_COVERAGE_THRESHOLDCode coverage threshold percentage. Build fails if coverage is below this value.90CI config
VORTEX_CI_COMPOSER_AUDIT_IGNORE_FAILUREIgnore composer audit failures.UNDEFINEDCI config
VORTEX_CI_COMPOSER_NORMALIZE_IGNORE_FAILUREIgnore composer normalize failures.UNDEFINEDCI config
VORTEX_CI_COMPOSER_VALIDATE_IGNORE_FAILUREIgnore composer validate failures.UNDEFINEDCI config
VORTEX_CI_DCLINT_IGNORE_FAILUREIgnore DCLint failures.UNDEFINEDCI config
VORTEX_CI_GHERKIN_LINT_IGNORE_FAILUREIgnore Gherkin Lint failures.UNDEFINEDCI config
VORTEX_CI_HADOLINT_IGNORE_FAILUREIgnore Hadolint failures.UNDEFINEDCI config
VORTEX_CI_NODEJS_LINT_IGNORE_FAILUREIgnore NodeJS linters failures.UNDEFINEDCI config
VORTEX_CI_PHPCS_IGNORE_FAILUREIgnore PHPCS failures.UNDEFINEDCI config
VORTEX_CI_PHPMD_IGNORE_FAILUREIgnore PHPMD failures.UNDEFINEDCI config
VORTEX_CI_PHPSTAN_IGNORE_FAILUREIgnore PHPStan failures.UNDEFINEDCI config
VORTEX_CI_PHPUNIT_IGNORE_FAILUREIgnore PHPUnit test failures.UNDEFINEDCI config
VORTEX_CI_RECTOR_IGNORE_FAILUREIgnore Rector failures.UNDEFINEDCI config
VORTEX_CI_TEST_RESULTSDirectory to store test results in CI./tmp/testsCI config
VORTEX_CI_TWIG_CS_FIXER_IGNORE_FAILUREIgnore Twig CS Fixer failures.UNDEFINEDCI config
VORTEX_CONTAINER_REGISTRYContainer registry name.

Provide port, if required as <server_name>:<port>.		docker.io.env
VORTEX_CONTAINER_REGISTRY_PASSThe password (token) to log into the container registry.UNDEFINED.env.local.example
VORTEX_CONTAINER_REGISTRY_USERThe username to log into the container registry.UNDEFINED.env.local.example
VORTEX_DB_DIRDatabase dump directory.

The directory is used to store the database dump files for import and export.		./.data.env, scripts/custom/provision-20-migration.sh
VORTEX_DB_FILEDatabase dump file name.

The file is used to import the database into an empty database container.		db.sql.env
VORTEX_DB_IMAGE_BASEName 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.		UNDEFINED.env
VORTEX_DEBUGSet to 1 to print debug information in Vortex scripts.UNDEFINED.env.local.example
VORTEX_DEPLOY_ACTIONDeployment 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).		UNDEFINEDscripts/vortex/deploy.sh
VORTEX_DEPLOY_ALLOW_SKIPFlag to allow skipping of a deployment using additional flags.UNDEFINEDscripts/vortex/deploy.sh, CI config
VORTEX_DEPLOY_ARTIFACT_DST_BRANCHRemote repository branch. Can be a specific branch or a token. @see https://github.com/drevops/git-artifact#token-support[branch]scripts/vortex/deploy-artifact.sh
VORTEX_DEPLOY_ARTIFACT_GIT_REMOTERemote repository to push code to.UNDEFINEDscripts/vortex/deploy-artifact.sh
VORTEX_DEPLOY_ARTIFACT_GIT_USER_EMAILName of the user who will be committing to a remote repository.UNDEFINEDscripts/vortex/deploy-artifact.sh
VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAMEEmail address of the user who will be committing to a remote repository.Deployment Robotscripts/vortex/deploy-artifact.sh
VORTEX_DEPLOY_ARTIFACT_LOGDeployment log file name.${VORTEX_DEPLOY_ARTIFACT_ROOT}/deployment_log.txtscripts/vortex/deploy-artifact.sh
VORTEX_DEPLOY_ARTIFACT_ROOTThe root directory where the deployment script should run from. Defaults to the current directory.$(pwd)scripts/vortex/deploy-artifact.sh
VORTEX_DEPLOY_ARTIFACT_SRCSource of the code to be used for artifact building.UNDEFINEDscripts/vortex/deploy-artifact.sh
VORTEX_DEPLOY_ARTIFACT_SSH_FILEDefault SSH file used if custom fingerprint is not provided.${HOME}/.ssh/id_rsascripts/vortex/deploy-artifact.sh
VORTEX_DEPLOY_ARTIFACT_SSH_FINGERPRINTSSH key fingerprint used to connect to remote.${VORTEX_DEPLOY_SSH_FINGERPRINT}scripts/vortex/deploy-artifact.sh
VORTEX_DEPLOY_BRANCHDeployment branch name.UNDEFINEDscripts/vortex/deploy.sh
VORTEX_DEPLOY_CONTAINER_REGISTRYContainer registry name.

Provide port, if required as <server_name>:<port>.		docker.ioscripts/vortex/deploy-container-registry.sh
VORTEX_DEPLOY_CONTAINER_REGISTRY_IMAGE_TAGThe tag of the container image.latestscripts/vortex/deploy-container-registry.sh
VORTEX_DEPLOY_CONTAINER_REGISTRY_MAPComma-separated map of container services and images to use for deployment in format "service1=org/image1,service2=org/image2".UNDEFINEDscripts/vortex/deploy-container-registry.sh, scripts/vortex/export-db.sh
VORTEX_DEPLOY_CONTAINER_REGISTRY_PASSThe password to login into the container registry.${VORTEX_CONTAINER_REGISTRY_PASS}scripts/vortex/deploy-container-registry.sh
VORTEX_DEPLOY_CONTAINER_REGISTRY_USERThe username to login into the container registry.${VORTEX_CONTAINER_REGISTRY_USER}scripts/vortex/deploy-container-registry.sh
VORTEX_DEPLOY_LAGOON_ACTIONDeployment 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).		createscripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_BRANCHThe Lagoon branch to deploy.${VORTEX_DEPLOY_BRANCH}scripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_FAIL_ENV_LIMIT_EXCEEDEDFlag 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.0scripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_INSTANCEThe Lagoon instance name to interact with.amazeeioscripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_INSTANCE_GRAPHQLThe Lagoon instance GraphQL endpoint to interact with.https://api.lagoon.amazeeio.cloud/graphqlscripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_INSTANCE_HOSTNAMEThe Lagoon instance hostname to interact with.ssh.lagoon.amazeeio.cloudscripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_INSTANCE_PORTThe Lagoon instance port to interact with.32222scripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_LAGOONCLI_FORCE_INSTALLFlag to force the installation of Lagoon CLI.${VORTEX_LAGOONCLI_FORCE_INSTALL}scripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_LAGOONCLI_PATHLocation of the Lagoon CLI binary./tmpscripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_LAGOONCLI_VERSIONLagoon CLI version to use.v0.32.0scripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_PRThe PR number to deploy.${VORTEX_DEPLOY_PR}scripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_PROJECTThe Lagoon project to perform deployment for.${LAGOON_PROJECT}scripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_PR_BASE_BRANCHThe PR base branch (the branch the PR is raised against). Defaults to 'develop'.developscripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_PR_HEADThe PR head branch to deploy.${VORTEX_DEPLOY_PR_HEAD}scripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_SSH_FILEDefault SSH file used if custom fingerprint is not provided.${HOME}/.ssh/id_rsascripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_LAGOON_SSH_FINGERPRINTSSH key fingerprint used to connect to remote. If not used, the currently loaded default SSH key (the key used for code checkout) will be used or deployment will fail with an error if the default SSH key is not loaded. In most cases, the default SSH key does not work (because it is a read-only key used by CircleCI to checkout code from git), so you should add another deployment key.${VORTEX_DEPLOY_SSH_FINGERPRINT}scripts/vortex/deploy-lagoon.sh
VORTEX_DEPLOY_MODEDeployment mode.

Values can be one of: branch, tag.		branchscripts/vortex/deploy-lagoon.sh, scripts/vortex/deploy.sh
VORTEX_DEPLOY_PRDeployment pull request number without "pr-" prefix.UNDEFINEDscripts/vortex/deploy.sh
VORTEX_DEPLOY_SKIPSkip all deployments.UNDEFINEDCI config
VORTEX_DEPLOY_TYPESDeployment occurs when tests pass in the CI environment. @see https://www.vortextemplate.com/docs/deploymentartifact.env, scripts/vortex/deploy.sh
VORTEX_DEPLOY_WEBHOOK_METHODWebhook call method.GETscripts/vortex/deploy-webhook.sh
VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUSThe status code of the expected response.200scripts/vortex/deploy-webhook.sh
VORTEX_DEPLOY_WEBHOOK_URLThe URL of the webhook to call.UNDEFINEDscripts/vortex/deploy-webhook.sh
VORTEX_DOCTOR_CHECK_BOOTSTRAPUNDEFINEDscripts/vortex/doctor.sh
VORTEX_DOCTOR_CHECK_CONTAINERS0scripts/vortex/doctor.sh
VORTEX_DOCTOR_CHECK_MINIMALCheck minimal Doctor requirements.0scripts/vortex/doctor.sh
VORTEX_DOCTOR_CHECK_PORTUNDEFINEDscripts/vortex/doctor.sh
VORTEX_DOCTOR_CHECK_PYGMYUNDEFINEDscripts/vortex/doctor.sh
VORTEX_DOCTOR_CHECK_SSHUNDEFINEDscripts/vortex/doctor.sh
VORTEX_DOCTOR_CHECK_TOOLS1scripts/vortex/doctor.sh
VORTEX_DOCTOR_CHECK_WEBSERVERUNDEFINEDscripts/vortex/doctor.sh
VORTEX_DOWNLOAD_DB2_ACQUIA_DB_NAMEAcquia database name to download the second database from.your_site.env
VORTEX_DOWNLOAD_DB2_ENVIRONMENTEnvironment to download the second database from.

Applies to hosting environments.		prod.env
VORTEX_DOWNLOAD_DB2_FILESecond database dump file name.db2.sql.env, scripts/custom/provision-20-migration.sh
VORTEX_DOWNLOAD_DB2_FTP_FILESecond database dump FTP file name.db2.sql.env
VORTEX_DOWNLOAD_DB2_FTP_HOSTSecond database dump FTP host.UNDEFINED.env
VORTEX_DOWNLOAD_DB2_FTP_PORTSecond database dump FTP port.21.env
VORTEX_DOWNLOAD_DB2_S3_BUCKETAWS S3 bucket name for second database download.UNDEFINED.env
VORTEX_DOWNLOAD_DB2_S3_REGIONAWS S3 region.ap-southeast-2.env
VORTEX_DOWNLOAD_DB2_SOURCESecond database download source.url.env
VORTEX_DOWNLOAD_DB2_URLSecond database dump file sourced from a URL.

HTTP Basic Authentication credentials should be embedded into the value.		UNDEFINED.env
VORTEX_DOWNLOAD_DB_ACQUIA_APP_NAMEApplication name. Used to discover UUID.${VORTEX_ACQUIA_APP_NAME}scripts/vortex/download-db-acquia.sh
VORTEX_DOWNLOAD_DB_ACQUIA_BACKUP_MAX_WAITMaximum time in seconds to wait for backup completion.600scripts/vortex/download-db-acquia.sh
VORTEX_DOWNLOAD_DB_ACQUIA_BACKUP_WAIT_INTERVALInterval in seconds to wait between backup status checks.10scripts/vortex/download-db-acquia.sh
VORTEX_DOWNLOAD_DB_ACQUIA_DB_DIRDirectory where DB dumps are stored../.datascripts/vortex/download-db-acquia.sh
VORTEX_DOWNLOAD_DB_ACQUIA_DB_FILEDatabase dump file name.db.sqlscripts/vortex/download-db-acquia.sh
VORTEX_DOWNLOAD_DB_ACQUIA_DB_NAMEAcquia database name to download the database from.your_site.env, scripts/vortex/download-db-acquia.sh
VORTEX_DOWNLOAD_DB_ACQUIA_KEYAcquia Cloud API key.${VORTEX_ACQUIA_KEY}scripts/vortex/download-db-acquia.sh
VORTEX_DOWNLOAD_DB_ACQUIA_SECRETAcquia Cloud API secret.${VORTEX_ACQUIA_SECRET}scripts/vortex/download-db-acquia.sh
VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRYContainer registry name.

Provide port, if required as <server_name>:<port>.		docker.ioscripts/vortex/download-db-container-registry.sh
VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_DB_DIRDirectory with database dump file../.datascripts/vortex/download-db-container-registry.sh
VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_IMAGEThe container image containing database passed in a form of <org>/<repository>.${VORTEX_DB_IMAGE}scripts/vortex/download-db-container-registry.sh
VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_IMAGE_BASEThe base container image used as a fallback when the archive does not exist.${VORTEX_DB_IMAGE_BASE}scripts/vortex/download-db-container-registry.sh
VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_PASSThe password to login into the container registry.${VORTEX_CONTAINER_REGISTRY_PASS}scripts/vortex/download-db-container-registry.sh
VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_USERThe username to login into the container registry.${VORTEX_CONTAINER_REGISTRY_USER}scripts/vortex/download-db-container-registry.sh
VORTEX_DOWNLOAD_DB_DIRDirectory with database dump file../.datascripts/vortex/download-db.sh
VORTEX_DOWNLOAD_DB_ENVIRONMENTEnvironment 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.		prod.env, scripts/vortex/download-db-acquia.sh, scripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_FILEDatabase dump file name.db.sqlscripts/vortex/download-db.sh
VORTEX_DOWNLOAD_DB_FORCEAlways override existing downloaded DB dump.1.env.local.example, scripts/vortex/download-db.sh
VORTEX_DOWNLOAD_DB_FRESHFlag to download a fresh copy of the database by triggering a new backup.UNDEFINEDscripts/vortex/download-db-acquia.sh, scripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_FTP_DB_DIRDirectory with database dump file../.datascripts/vortex/download-db-ftp.sh
VORTEX_DOWNLOAD_DB_FTP_DB_FILEDatabase dump file name.db.sqlscripts/vortex/download-db-ftp.sh
VORTEX_DOWNLOAD_DB_FTP_FILEDatabase dump FTP file name.db.sql.env, scripts/vortex/download-db-ftp.sh
VORTEX_DOWNLOAD_DB_FTP_HOSTDatabase dump FTP host.UNDEFINED.env, scripts/vortex/download-db-ftp.sh
VORTEX_DOWNLOAD_DB_FTP_PASSDatabase dump FTP password.UNDEFINED.env.local.example, scripts/vortex/download-db-ftp.sh
VORTEX_DOWNLOAD_DB_FTP_PORTDatabase dump FTP port.21.env, scripts/vortex/download-db-ftp.sh
VORTEX_DOWNLOAD_DB_FTP_USERDatabase dump FTP user.UNDEFINED.env.local.example, scripts/vortex/download-db-ftp.sh
VORTEX_DOWNLOAD_DB_LAGOON_DB_DIRDirectory where DB dumps are stored on the host../.datascripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_LAGOON_DB_FILEDatabase dump file name on the host.db.sqlscripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_LAGOON_PROJECTLagoon project name.${LAGOON_PROJECT}scripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_LAGOON_REMOTE_DIRRemote DB dump directory location./tmpscripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_LAGOON_REMOTE_FILERemote DB dump file name. Cached by the date suffix.db_$(date +%Y%m%d).sqlscripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_LAGOON_REMOTE_FILE_CLEANUPWildcard file name to cleanup previously created dump files.

Cleanup runs only if the variable is set and $VORTEX_DOWNLOAD_DB_LAGOON_REMOTE_FILE does not exist.		db_*.sqlscripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_LAGOON_SSH_HOSTThe SSH host of the Lagoon environment.ssh.lagoon.amazeeio.cloudscripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_LAGOON_SSH_PORTThe SSH port of the Lagoon environment.32222scripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_LAGOON_SSH_USERThe SSH user of the Lagoon environment.${VORTEX_DOWNLOAD_DB_LAGOON_PROJECT}-${VORTEX_DOWNLOAD_DB_ENVIRONMENT}scripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_PROCEEDProceed with download.1scripts/vortex/download-db.sh
VORTEX_DOWNLOAD_DB_S3_ACCESS_KEYAWS access key for S3 database download.UNDEFINED.env.local.example, scripts/vortex/download-db-s3.sh
VORTEX_DOWNLOAD_DB_S3_BUCKETAWS S3 bucket name for database download.UNDEFINED.env, scripts/vortex/download-db-s3.sh
VORTEX_DOWNLOAD_DB_S3_DB_DIRDirectory with database dump file../.datascripts/vortex/download-db-s3.sh
VORTEX_DOWNLOAD_DB_S3_DB_FILEDatabase dump file name.db.sqlscripts/vortex/download-db-s3.sh
VORTEX_DOWNLOAD_DB_S3_PREFIXS3 prefix (path within the bucket).${S3_PREFIX}scripts/vortex/download-db-s3.sh
VORTEX_DOWNLOAD_DB_S3_REGIONAWS S3 region.ap-southeast-2.env, scripts/vortex/download-db-s3.sh
VORTEX_DOWNLOAD_DB_S3_SECRET_KEYAWS secret key for S3 database download.UNDEFINED.env.local.example, scripts/vortex/download-db-s3.sh
VORTEX_DOWNLOAD_DB_SOURCEDatabase download source.url.env, scripts/vortex/download-db.sh
VORTEX_DOWNLOAD_DB_SSH_FILEDefault SSH file used if custom fingerprint is not provided.${HOME}/.ssh/id_rsascripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_SSH_FINGERPRINTSSH key fingerprint used to connect to a remote.UNDEFINEDscripts/vortex/download-db-lagoon.sh
VORTEX_DOWNLOAD_DB_UNZIP_PASSWORDPassword for unzipping password-protected zip files.UNDEFINEDscripts/vortex/download-db-url.sh
VORTEX_DOWNLOAD_DB_URLDatabase dump file sourced from a URL.

HTTP Basic Authentication credentials should be embedded into the value.		UNDEFINED.env, scripts/vortex/download-db-url.sh
VORTEX_DOWNLOAD_DB_URL_DB_DIRDirectory with database dump file../.datascripts/vortex/download-db-url.sh
VORTEX_DOWNLOAD_DB_URL_DB_FILEDatabase dump file name.db.sqlscripts/vortex/download-db-url.sh
VORTEX_EXPORT_DB_CONTAINER_REGISTRYContainer registry name.docker.ioscripts/vortex/export-db-image.sh
VORTEX_EXPORT_DB_CONTAINER_REGISTRY_DEPLOY_PROCEEDProceed with container image deployment after it was exported.UNDEFINEDCI config
VORTEX_EXPORT_DB_FILE_DIRDirectory with database dump file../.datascripts/vortex/export-db-file.sh
VORTEX_EXPORT_DB_IMAGEContainer image to store in a form of <org>/<repository>.UNDEFINEDscripts/vortex/export-db-image.sh, scripts/vortex/export-db.sh
VORTEX_EXPORT_DB_IMAGE_ARCHIVE_FILEContainer image archive file name.UNDEFINEDscripts/vortex/export-db-image.sh
VORTEX_EXPORT_DB_IMAGE_DIRDirectory with database image archive file.${VORTEX_DB_DIR}scripts/vortex/export-db-image.sh
VORTEX_EXPORT_DB_SERVICE_NAMEThe service name to capture.databasescripts/vortex/export-db-image.sh
VORTEX_FRONTEND_BUILD_SKIPSkip building of the frontend.UNDEFINED.env
VORTEX_INSTALLER_INTERACTIVERun installer in interactive mode.0scripts/vortex/update-vortex.sh
VORTEX_INSTALLER_PATHThe path to the installer script. If set, this will override the VORTEX_INSTALLER_URL.UNDEFINEDscripts/vortex/update-vortex.sh
VORTEX_INSTALLER_TEMPLATE_REPOVortex 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.		https://github.com/drevops/vortex.git#stablescripts/vortex/update-vortex.sh
VORTEX_INSTALLER_URLThe URL of the installer script.https://www.vortextemplate.com/installscripts/vortex/update-vortex.sh
VORTEX_INSTALLER_URL_CACHE_BUSTCache busting parameter for the installer URL.$(date +%s)scripts/vortex/update-vortex.sh
VORTEX_LAGOON_PRODUCTION_BRANCHDedicated branch to identify the production environment.main.env
VORTEX_LOGIN_CONTAINER_REGISTRYContainer registry name.

Provide port, if required as <server_name>:<port>.		docker.ioscripts/vortex/login-container-registry.sh
VORTEX_LOGIN_CONTAINER_REGISTRY_DOCKER_CONFIGPath to Docker configuration directory.${HOME}/.dockerscripts/vortex/login-container-registry.sh
VORTEX_LOGIN_CONTAINER_REGISTRY_PASSThe password to login into the container registry.

If not provided, the script will skip the login step.		${VORTEX_CONTAINER_REGISTRY_PASS}scripts/vortex/login-container-registry.sh
VORTEX_LOGIN_CONTAINER_REGISTRY_USERThe username to login into the container registry.

If not provided, the script will skip the login step.		${VORTEX_CONTAINER_REGISTRY_USER}scripts/vortex/login-container-registry.sh
VORTEX_LOGIN_UNBLOCK_ADMINFlag to unblock admin.1scripts/vortex/login.sh
VORTEX_LOGOUT_BLOCK_ADMINFlag to block or unblock admin.1scripts/vortex/logout.sh
VORTEX_NOTIFY_BRANCHNotification git branch name.UNDEFINEDscripts/vortex/notify.sh
VORTEX_NOTIFY_CHANNELSThe channels of the notifications.

A combination of comma-separated values: email,slack,newrelic,github,jira,webhook		email.env, scripts/vortex/notify.sh
VORTEX_NOTIFY_EMAIL_ENVIRONMENT_URLEmail notification environment URL.${VORTEX_NOTIFY_ENVIRONMENT_URL}scripts/vortex/notify-email.sh
VORTEX_NOTIFY_EMAIL_EVENTEmail notification event type. Can be 'pre_deployment' or 'post_deployment'.post_deploymentscripts/vortex/notify-email.sh
VORTEX_NOTIFY_EMAIL_FROMAn email address to send notifications from.

Applies to email notifications.		webmaster@your-site-domain.example.env, scripts/vortex/notify-email.sh
VORTEX_NOTIFY_EMAIL_LABELEmail notification deployment label (branch name, PR number, or custom identifier).${VORTEX_NOTIFY_LABEL}scripts/vortex/notify-email.sh
VORTEX_NOTIFY_EMAIL_LOGIN_URLEmail notification login URL.${VORTEX_NOTIFY_LOGIN_URL}scripts/vortex/notify-email.sh
VORTEX_NOTIFY_EMAIL_MESSAGEEmail notification message template. Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url%UNDEFINEDscripts/vortex/notify-email.sh
VORTEX_NOTIFY_EMAIL_PROJECTEmail notification project name.${VORTEX_NOTIFY_PROJECT}scripts/vortex/notify-email.sh
VORTEX_NOTIFY_EMAIL_RECIPIENTSEmail 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.comJane Doe, to2@example.com
VORTEX_NOTIFY_ENVIRONMENT_URLNotification environment URL (where the site was deployed).UNDEFINEDscripts/vortex/notify.sh
VORTEX_NOTIFY_EVENTNotification event type.

Can be 'pre_deployment' or 'post_deployment'.		post_deploymentscripts/vortex/notify.sh
VORTEX_NOTIFY_GITHUB_BRANCHGitHub notification git branch name. This will be used as the 'ref' parameter in GitHub's Deployment API.${VORTEX_NOTIFY_BRANCH}scripts/vortex/notify-github.sh
VORTEX_NOTIFY_GITHUB_ENVIRONMENT_TYPEGitHub notification environment type. Used as the 'environment' parameter in GitHub's Deployment API. Defaults to VORTEX_NOTIFY_LABEL (e.g. "PR-123" or branch name) for unique per-PR/branch environments. This prevents cross-PR deployment interference where deploying one PR would mark another PR's deployment as inactive.PRscripts/vortex/notify-github.sh
VORTEX_NOTIFY_GITHUB_ENVIRONMENT_URLGitHub notification deployment environment URL.${VORTEX_NOTIFY_ENVIRONMENT_URL}scripts/vortex/notify-github.sh
VORTEX_NOTIFY_GITHUB_EVENTGitHub notification event type. Can be 'pre_deployment' or 'post_deployment'.${VORTEX_NOTIFY_EVENT}scripts/vortex/notify-github.sh
VORTEX_NOTIFY_GITHUB_REPOSITORYGitHub notification repository in owner/repo format.UNDEFINEDscripts/vortex/notify-github.sh
VORTEX_NOTIFY_GITHUB_TOKENGitHub notification personal access token.${GITHUB_TOKEN}scripts/vortex/notify-github.sh, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT
VORTEX_NOTIFY_JIRA_ASSIGNEE_EMAILJIRA notification assignee email address.

If left empty - no assignment will be performed.		UNDEFINEDscripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_BRANCHJIRA notification git branch name (used for issue extraction).${VORTEX_NOTIFY_BRANCH}scripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_ENDPOINTJIRA notification API endpoint.https://jira.atlassian.comscripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_ENVIRONMENT_URLJIRA notification environment URL.${VORTEX_NOTIFY_ENVIRONMENT_URL}scripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_EVENTJIRA notification event type. Can be 'pre_deployment' or 'post_deployment'.post_deploymentscripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_LABELJIRA notification deployment label (human-readable identifier for display).${VORTEX_NOTIFY_LABEL}scripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_LOGIN_URLJIRA notification login URL.${VORTEX_NOTIFY_LOGIN_URL}scripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_MESSAGEJIRA notification message template (will be converted to ADF format). Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url%UNDEFINEDscripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_PROJECTJIRA notification project name.${VORTEX_NOTIFY_PROJECT}scripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_TOKENJIRA notification API token.

@see https://www.vortextemplate.com/docs/deployment/notifications#jira		UNDEFINEDscripts/vortex/notify-jira.sh, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT
VORTEX_NOTIFY_JIRA_TRANSITIONJIRA notification state to transition to.

If left empty - no transition will be performed.		UNDEFINEDscripts/vortex/notify-jira.sh
VORTEX_NOTIFY_JIRA_USER_EMAILJIRA user email address.user@example.com.env, scripts/vortex/notify-jira.sh
VORTEX_NOTIFY_LABELNotification deployment label (human-readable identifier for display).UNDEFINEDscripts/vortex/notify.sh
VORTEX_NOTIFY_LOGIN_URLNotification login URL (defaults to ENVIRONMENT_URL/user/login if not provided).UNDEFINEDscripts/vortex/notify.sh
VORTEX_NOTIFY_NEWRELIC_APIKEYNewRelic API key, usually of type 'USER'.

@see https://www.vortextemplate.com/docs/deployment/notifications#new-relic		UNDEFINEDACQUIA ENVIRONMENT, LAGOON ENVIRONMENT
VORTEX_NOTIFY_NEWRELIC_APPIDNew Relic notification application ID (auto-discovered if not provided).

Will be discovered automatically from application name if not provided.		UNDEFINEDscripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_APP_NAMENew Relic notification application name as it appears in the dashboard.${VORTEX_NOTIFY_NEWRELIC_PROJECT}-${VORTEX_NOTIFY_NEWRELIC_LABEL}scripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_CHANGELOGNew Relic notification deployment changelog. Defaults to the description.UNDEFINEDscripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_DESCRIPTIONNew Relic notification deployment description template. Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url%UNDEFINEDscripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_ENABLEDFlag to enable New Relic notifications. Set to "true" (not "1") in environments where New Relic is configured.${NEWRELIC_ENABLED}scripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_ENDPOINTNew Relic notification API endpoint.https://api.newrelic.com/v2scripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_ENVIRONMENT_URLNew Relic notification environment URL.${VORTEX_NOTIFY_ENVIRONMENT_URL}scripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_EVENTNew Relic notification event type. Can be 'pre_deployment' or 'post_deployment'.post_deploymentscripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_LABELNew Relic notification deployment label (human-readable identifier for display).${VORTEX_NOTIFY_LABEL}scripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_LOGIN_URLNew Relic notification login URL.${VORTEX_NOTIFY_LOGIN_URL}scripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_PROJECTNew Relic notification project name.${VORTEX_NOTIFY_PROJECT}scripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_REVISIONNew Relic notification deployment revision. If not provided, will use SHA if available, otherwise auto-generated.UNDEFINEDscripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_SHANew Relic notification git commit SHA.${VORTEX_NOTIFY_SHA}scripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_USERNew Relic notification user performing deployment.Deployment robotscripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_NEWRELIC_USER_KEYNew Relic notification User API Key.

To obtain your User API Key: 1. Log in to New Relic 2. Click on your profile icon (bottom left) 3. Go to "API keys" 4. Create or copy an existing "User key" 5. The key format is: NRAK-XXXXXXXXXXXXXXXXXXXXXX

@see https://docs.newrelic.com/docs/apis/intro-apis/new-relic-api-keys/#user-key @see https://www.vortextemplate.com/docs/deployment/notifications#new-relic		${NEWRELIC_USER_KEY}scripts/vortex/notify-newrelic.sh
VORTEX_NOTIFY_PROJECTNotification project name.${VORTEX_PROJECT}scripts/vortex/notify.sh
VORTEX_NOTIFY_PR_NUMBERNotification pull request number.UNDEFINEDscripts/vortex/notify.sh
VORTEX_NOTIFY_SHANotification git commit SHA.UNDEFINEDscripts/vortex/notify.sh
VORTEX_NOTIFY_SKIPNotification skip flag.UNDEFINEDscripts/vortex/notify.sh
VORTEX_NOTIFY_SLACK_CHANNELSlack notification target channel (optional, overrides webhook default). Format: #channel-name or @usernameUNDEFINEDscripts/vortex/notify-slack.sh
VORTEX_NOTIFY_SLACK_ENVIRONMENT_URLSlack notification environment URL.${VORTEX_NOTIFY_ENVIRONMENT_URL}scripts/vortex/notify-slack.sh
VORTEX_NOTIFY_SLACK_EVENTSlack notification event type. Can be 'pre_deployment' or 'post_deployment'.post_deploymentscripts/vortex/notify-slack.sh
VORTEX_NOTIFY_SLACK_ICON_EMOJISlack notification bot icon emoji (optional).:rocket:scripts/vortex/notify-slack.sh
VORTEX_NOTIFY_SLACK_LABELSlack notification deployment label (branch name, PR number, or custom identifier).${VORTEX_NOTIFY_LABEL}scripts/vortex/notify-slack.sh
VORTEX_NOTIFY_SLACK_LOGIN_URLSlack notification login URL.${VORTEX_NOTIFY_LOGIN_URL}scripts/vortex/notify-slack.sh
VORTEX_NOTIFY_SLACK_MESSAGESlack notification message template (for fallback text). Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url%UNDEFINEDscripts/vortex/notify-slack.sh
VORTEX_NOTIFY_SLACK_PROJECTSlack notification project name.${VORTEX_NOTIFY_PROJECT}scripts/vortex/notify-slack.sh
VORTEX_NOTIFY_SLACK_USERNAMESlack notification bot display name (optional).Deployment Botscripts/vortex/notify-slack.sh
VORTEX_NOTIFY_SLACK_WEBHOOKSlack notification webhook URL. The incoming Webhook URL from your Slack app configuration. @see https://www.vortextemplate.com/docs/deployment/notifications#slackUNDEFINEDscripts/vortex/notify-slack.sh, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT
VORTEX_NOTIFY_WEBHOOK_ENVIRONMENT_URLWebhook notification environment URL.${VORTEX_NOTIFY_ENVIRONMENT_URL}scripts/vortex/notify-webhook.sh
VORTEX_NOTIFY_WEBHOOK_EVENTWebhook notification event type. Can be 'pre_deployment' or 'post_deployment'.post_deploymentscripts/vortex/notify-webhook.sh
VORTEX_NOTIFY_WEBHOOK_HEADERSWebhook notification pipe-separated headers. Separate multiple headers with a pipe `. Example: Content-type: application/jsonAuthorization: Bearer API_KEY`.
VORTEX_NOTIFY_WEBHOOK_LABELWebhook notification deployment label (branch name, PR number, or custom identifier).${VORTEX_NOTIFY_LABEL}scripts/vortex/notify-webhook.sh
VORTEX_NOTIFY_WEBHOOK_LOGIN_URLWebhook notification login URL.${VORTEX_NOTIFY_LOGIN_URL}scripts/vortex/notify-webhook.sh
VORTEX_NOTIFY_WEBHOOK_METHODWebhook notification HTTP method like POST, GET, PUT.POSTscripts/vortex/notify-webhook.sh
VORTEX_NOTIFY_WEBHOOK_PAYLOADWebhook notification JSON payload. Available tokens: %message%, %project%, %label%, %timestamp%, %environment_url%, %login_url%UNDEFINEDscripts/vortex/notify-webhook.sh
VORTEX_NOTIFY_WEBHOOK_PROJECTWebhook notification project name.${VORTEX_NOTIFY_PROJECT}scripts/vortex/notify-webhook.sh
VORTEX_NOTIFY_WEBHOOK_RESPONSE_STATUSWebhook notification expected HTTP status.200scripts/vortex/notify-webhook.sh
VORTEX_NOTIFY_WEBHOOK_URLWebhook URL to send notifications to.UNDEFINED.env, scripts/vortex/notify-webhook.sh, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT
VORTEX_PROJECTProject name.

Drives internal naming within the codebase. Does not affect the names of containers and development URL - those depend on the project directory and can be overridden with $COMPOSE_PROJECT_NAME.		your_site.env, scripts/vortex/info.sh
VORTEX_PROVISION_ACQUIA_SKIPSkip Drupal site provisioning in Acquia environment.UNDEFINEDACQUIA ENVIRONMENT
VORTEX_PROVISION_DBProvision database dump file. If not set, it will be auto-discovered from the VORTEX_DB_DIR directory using the VORTEX_DB_FILE name.UNDEFINEDscripts/vortex/provision.sh
VORTEX_PROVISION_DB_DIRDirectory with database dump file../.datascripts/vortex/provision.sh
VORTEX_PROVISION_DB_FILEDatabase dump file name.db.sqlscripts/vortex/provision.sh
VORTEX_PROVISION_DB_IMAGEName of the pre-built database container image.${VORTEX_DB_IMAGE}scripts/vortex/provision.sh
VORTEX_PROVISION_FALLBACK_TO_PROFILEFallback to profile installation if the database dump is not available.

When enabled and the provision type is set to "database", the site will be installed from the profile if the database dump file or container image is not available.		UNDEFINED.env, scripts/vortex/provision.sh
VORTEX_PROVISION_OVERRIDE_DBOverwrite a database if it exists.

Usually set to 0 in deployed environments and can be temporary set to 1 for a specific deployment. Set this to 1 in .env.local to override when developing locally.		UNDEFINED.env, .env.local.example, scripts/vortex/provision.sh
VORTEX_PROVISION_POST_OPERATIONS_SKIPFlag to skip running of operations after site provision is complete. Useful to only import the database from file (or install from profile) and not perform any additional operations. For example, when need to capture database state before any updates ran (for example, DB caching in CI).0scripts/vortex/provision.sh
VORTEX_PROVISION_SANITIZE_DB_ADDITIONAL_FILEPath to file with custom sanitization SQL queries.

To skip custom sanitization, remove the file defined in VORTEX_PROVISION_SANITIZE_DB_ADDITIONAL_FILE variable from the codebase.		./scripts/sanitize.sqlscripts/vortex/provision-sanitize-db.sh
VORTEX_PROVISION_SANITIZE_DB_EMAILSanitization email pattern.

Applied if database sanitization is enabled. @see https://www.vortextemplate.com/docs/drupal/provision#database-sanitization		user_%uid@your-site-domain.example.env, scripts/vortex/provision-sanitize-db.sh
VORTEX_PROVISION_SANITIZE_DB_PASSWORDDatabase sanitized account password replacement.${RANDOM}${RANDOM}${RANDOM}${RANDOM}scripts/vortex/provision-sanitize-db.sh, .env
VORTEX_PROVISION_SANITIZE_DB_REPLACE_USERNAME_WITH_EMAILReplace username with mail.0scripts/vortex/provision-sanitize-db.sh, .env
VORTEX_PROVISION_SANITIZE_DB_SKIPSkip database sanitization.

Database sanitization is enabled by default in all non-production environments and is always skipped in the production environment. @see https://www.vortextemplate.com/docs/drupal/provision#database-sanitization		UNDEFINED.env, scripts/vortex/provision.sh
VORTEX_PROVISION_SCRIPTS_DIRDirectory with custom provision scripts../scripts/customscripts/vortex/provision.sh
VORTEX_PROVISION_SKIPFlag to skip site provisioning.UNDEFINEDscripts/vortex/provision.sh
VORTEX_PROVISION_TYPESet to 'profile' to install a site from profile instead of the database dump.database.env, scripts/vortex/provision.sh
VORTEX_PROVISION_USE_MAINTENANCE_MODEPut the site into a maintenance mode during site provisioning.1.env, scripts/vortex/provision.sh
VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATEVerify that configuration was not changed by database updates. If enabled and config files are present, the provision will fail if database update hooks modify active configuration, preventing drush config:import from silently overwriting those changes.UNDEFINED.env, scripts/vortex/provision.sh
VORTEX_PURGE_CACHE_ACQUIA_SKIPSkip purging of edge cache in Acquia environment.UNDEFINEDACQUIA ENVIRONMENT
VORTEX_RELEASE_VERSION_SCHEMEVersioning scheme used for releases.

Can be one of: calver, semver, other @see https://www.vortextemplate.com/docs/releasing		calver.env
VORTEX_SHOW_LOGINShow one-time login link.UNDEFINEDscripts/vortex/info.sh
VORTEX_SSH_DISABLE_STRICT_HOST_KEY_CHECKINGDisable strict host key checking in SSH.0scripts/vortex/setup-ssh.sh
VORTEX_SSH_FILEDefault SSH key file.${HOME}/.ssh/id_rsascripts/vortex/doctor.sh
VORTEX_SSH_PREFIXPrefix used to load SSH key from prefixes environment variables:
- VORTEX_${VORTEX_SSH_PREFIX}SSH_FINGERPRINT - the variable name with the
SSH key fingerprint value.
- VORTEX${VORTEX_SSH_PREFIX}_SSH_FILE - the variable name with the SSH
key file path.		UNDEFINEDscripts/vortex/setup-ssh.sh
VORTEX_SSH_REMOVE_ALL_KEYSRemove all SSH keys from the SSH agent before loading the new one.0scripts/vortex/setup-ssh.sh
VORTEX_TASK_COPY_DB_ACQUIA_APP_NAMEApplication name. Used to discover UUID.${VORTEX_ACQUIA_APP_NAME}scripts/vortex/task-copy-db-acquia.sh
VORTEX_TASK_COPY_DB_ACQUIA_DSTDestination environment name to copy DB to.UNDEFINEDscripts/vortex/task-copy-db-acquia.sh
VORTEX_TASK_COPY_DB_ACQUIA_KEYAcquia Cloud API key.${VORTEX_ACQUIA_KEY}scripts/vortex/task-copy-db-acquia.sh
VORTEX_TASK_COPY_DB_ACQUIA_NAMEDatabase name to copy.UNDEFINEDscripts/vortex/task-copy-db-acquia.sh
VORTEX_TASK_COPY_DB_ACQUIA_SECRETAcquia Cloud API secret.${VORTEX_ACQUIA_SECRET}scripts/vortex/task-copy-db-acquia.sh
VORTEX_TASK_COPY_DB_ACQUIA_SKIPSkip copying of database between Acquia environment.UNDEFINEDACQUIA ENVIRONMENT
VORTEX_TASK_COPY_DB_ACQUIA_SRCSource environment name to copy DB from.UNDEFINEDscripts/vortex/task-copy-db-acquia.sh
VORTEX_TASK_COPY_DB_ACQUIA_STATUS_INTERVALInterval in seconds to check task status.10scripts/vortex/task-copy-db-acquia.sh
VORTEX_TASK_COPY_DB_ACQUIA_STATUS_RETRIESNumber of status retrieval retries. If this limit reached and task has not yet finished, the task is considered failed.600scripts/vortex/task-copy-db-acquia.sh
VORTEX_TASK_COPY_FILES_ACQUIA_APP_NAMEApplication name. Used to discover UUID.${VORTEX_ACQUIA_APP_NAME}scripts/vortex/task-copy-files-acquia.sh
VORTEX_TASK_COPY_FILES_ACQUIA_DSTDestination environment name to copy to.UNDEFINEDscripts/vortex/task-copy-files-acquia.sh
VORTEX_TASK_COPY_FILES_ACQUIA_KEYAcquia Cloud API key.${VORTEX_ACQUIA_KEY}scripts/vortex/task-copy-files-acquia.sh
VORTEX_TASK_COPY_FILES_ACQUIA_SECRETAcquia Cloud API secret.${VORTEX_ACQUIA_SECRET}scripts/vortex/task-copy-files-acquia.sh
VORTEX_TASK_COPY_FILES_ACQUIA_SKIPSkip copying of files between Acquia environment.UNDEFINEDACQUIA ENVIRONMENT
VORTEX_TASK_COPY_FILES_ACQUIA_SRCSource environment name to copy from.UNDEFINEDscripts/vortex/task-copy-files-acquia.sh
VORTEX_TASK_COPY_FILES_ACQUIA_STATUS_INTERVALInterval in seconds to check task status.10scripts/vortex/task-copy-files-acquia.sh
VORTEX_TASK_COPY_FILES_ACQUIA_STATUS_RETRIESNumber of status retrieval retries. If this limit reached and task has not yet finished, the task is considered failed.300scripts/vortex/task-copy-files-acquia.sh
VORTEX_TASK_CUSTOM_LAGOON_BRANCHThe Lagoon branch to run the task on.UNDEFINEDscripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_CLI_FORCE_INSTALLFlag to force the installation of Lagoon CLI.UNDEFINEDscripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_CLI_PATHLocation of the Lagoon CLI binary./tmpscripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_CLI_VERSIONLagoon CLI version to use.v0.32.0scripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_COMMANDThe task command to execute.UNDEFINEDscripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_INSTANCEThe Lagoon instance name to interact with.amazeeioscripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_INSTANCE_GRAPHQLThe Lagoon instance GraphQL endpoint to interact with.https://api.lagoon.amazeeio.cloud/graphqlscripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_INSTANCE_HOSTNAMEThe Lagoon instance hostname to interact with.ssh.lagoon.amazeeio.cloudscripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_INSTANCE_PORTThe Lagoon instance port to interact with.32222scripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_NAMEThe task name.Automation taskscripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_PROJECTThe Lagoon project to run tasks for.${LAGOON_PROJECT}scripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_SSH_FILEDefault SSH file used if custom fingerprint is not provided.${HOME}/.ssh/id_rsascripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_CUSTOM_LAGOON_SSH_FINGERPRINTSSH key fingerprint used to connect to a remote.UNDEFINEDscripts/vortex/task-custom-lagoon.sh
VORTEX_TASK_PURGE_CACHE_ACQUIA_APP_NAMEApplication name. Used to discover UUID.${VORTEX_ACQUIA_APP_NAME}scripts/vortex/task-purge-cache-acquia.sh
VORTEX_TASK_PURGE_CACHE_ACQUIA_DOMAINS_FILEFile with a list of domains that should be purged.domains.txtscripts/vortex/task-purge-cache-acquia.sh
VORTEX_TASK_PURGE_CACHE_ACQUIA_ENVAn environment name to purge cache for.UNDEFINEDscripts/vortex/task-purge-cache-acquia.sh
VORTEX_TASK_PURGE_CACHE_ACQUIA_KEYAcquia Cloud API key.${VORTEX_ACQUIA_KEY}scripts/vortex/task-purge-cache-acquia.sh
VORTEX_TASK_PURGE_CACHE_ACQUIA_SECRETAcquia Cloud API secret.${VORTEX_ACQUIA_SECRET}scripts/vortex/task-purge-cache-acquia.sh
VORTEX_TASK_PURGE_CACHE_ACQUIA_STATUS_INTERVALInterval in seconds to check task status.10scripts/vortex/task-purge-cache-acquia.sh
VORTEX_TASK_PURGE_CACHE_ACQUIA_STATUS_RETRIESNumber of status retrieval retries. If this limit reached and task has not yet finished, the task is considered failed.300scripts/vortex/task-purge-cache-acquia.sh
VORTEX_UNBLOCK_ADMINUnblock admin account when logging in.1.env
VORTEX_UPLOAD_DB_S3_ACCESS_KEYAWS access key.${S3_ACCESS_KEY}scripts/vortex/upload-db-s3.sh
VORTEX_UPLOAD_DB_S3_BUCKETS3 bucket name.${S3_BUCKET}scripts/vortex/upload-db-s3.sh
VORTEX_UPLOAD_DB_S3_DB_DIRDirectory with database dump file../.datascripts/vortex/upload-db-s3.sh
VORTEX_UPLOAD_DB_S3_DB_FILEDatabase dump file name.db.sqlscripts/vortex/upload-db-s3.sh
VORTEX_UPLOAD_DB_S3_PREFIXS3 prefix (path within the bucket).${S3_PREFIX}scripts/vortex/upload-db-s3.sh
VORTEX_UPLOAD_DB_S3_REGIONS3 region.${S3_REGION}scripts/vortex/upload-db-s3.sh
VORTEX_UPLOAD_DB_S3_REMOTE_FILERemote database dump file name.db.sqlscripts/vortex/upload-db-s3.sh
VORTEX_UPLOAD_DB_S3_SECRET_KEYAWS secret key.${S3_SECRET_KEY}scripts/vortex/upload-db-s3.sh
VORTEX_UPLOAD_DB_S3_STORAGE_CLASSS3 storage class.STANDARDscripts/vortex/upload-db-s3.sh
VORTEX_VAR_PREFIX${_vortex_var_prefix_default}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-s3.sh, scripts/vortex/download-db-url.sh, scripts/vortex/download-db.sh
WEBROOTName of the web root directory containing a Drupal codebase.web.env, scripts/vortex/download-db-lagoon.sh, scripts/vortex/info.sh, scripts/vortex/provision.sh, scripts/vortex/reset.sh

Variable list generated with Shellvar - Utility to work with shell variables