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. The exception is
LOCALDEV_URL, the local development URL, which shares its value with the
unprefixed hosting route (LAGOON_ROUTE) and is therefore used without the
prefix.
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.
| Name | Description | Default value | Defined or used in |
|---|---|---|---|
AHOY_CONFIRM_RESPONSE | Set to y to suppress Ahoy prompts. | UNDEFINED | .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. | 1 | .env.local.example |
CI_FREE_DISK_SPACE | Set to 1 to remove preinstalled toolchains from the GitHub Actions runner and free disk space. | UNDEFINED | CI config |
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. | UNDEFINED | ENVIRONMENT |
DATABASE_CHARSET | Local database charset. Variable is not used in hosting environment. | utf8mb4 | docker-compose.yml |
DATABASE_COLLATION | Local database collation. Variable is not used in hosting environment. | utf8mb4_general_ci | docker-compose.yml |
DATABASE_DATABASE | Database name. | UNDEFINED | LAGOON ENVIRONMENT |
DATABASE_NAME | Local database name. Variable is not used in hosting environment. | drupal | docker-compose.yml |
DRUPAL_ADMIN_EMAIL | Drupal admin email. May need to be reset if database was sanitized. | UNDEFINED | .env |
DRUPAL_CLAMAV_ENABLED | Enable ClamAV integration. | 1 | .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. | daemon | .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. | ../config/default | .env |
DRUPAL_GENERATED_CONTENT_SKIP | Skip content generation. | 0 | scripts/provision-10-enable-dev-modules.sh |
DRUPAL_HASH_SALT | Drupal hash salt. Secures one-time login links, password-reset URLs, and CSRF/form tokens. Set a long, random, unique value for every hosted environment as a platform variable or secret. If not set, a fallback is derived from the database host, which is suitable for local and CI use only. @see https://www.vortextemplate.com/docs/drupal/settings | <generated from database host> | ENVIRONMENT |
DRUPAL_MAINTENANCE_THEME | Drupal maintenance theme name. | your_site_theme | .env |
DRUPAL_MIGRATION_FEEDBACK | Feedback frequency for migration progress. | 50 | scripts/provision-20-migration.sh |
DRUPAL_MIGRATION_IMPORT_LIMIT | Limit the number of entities to import. Set to 'all' to import all. | 50 | scripts/provision-20-migration.sh |
DRUPAL_MIGRATION_ROLLBACK_SKIP | Skip rollback of migrations before import. | 1 | scripts/provision-20-migration.sh |
DRUPAL_MIGRATION_SEARCH_DISABLE | Disable the search server while migrations run. Set to 0 to keep indexing. | 1 | scripts/provision-20-migration.sh |
DRUPAL_MIGRATION_SKIP | Skip all migrations. | 0 | scripts/provision-20-migration.sh |
DRUPAL_MIGRATION_SOURCE_DB_IMPORT | Import migration source database. Set to 1 to import, 0 to skip. | 0 | scripts/provision-20-migration.sh |
DRUPAL_MIGRATION_SOURCE_DB_PROBE_TABLE | Table name to probe in the source database to verify it is not corrupted. | categories | scripts/provision-20-migration.sh |
DRUPAL_MIGRATION_UPDATE | Update already imported entities during migration. | 0 | scripts/provision-20-migration.sh |
DRUPAL_PRIVATE_FILES | Path to private files. | ${DRUPAL_PUBLIC_FILES}/private | docker-compose.yml |
DRUPAL_PROFILE | Drupal profile name. | standard | .env, .vortex/tooling/src/vortex-provision |
DRUPAL_PUBLIC_FILES | Path to public files. | ./${WEBROOT}/sites/default/files | docker-compose.yml |
DRUPAL_REDIS_ENABLED | Enable Redis integration. See settings.redis.php for details. | 1 | .env |
DRUPAL_SEARCH_INDEX_SKIP | Skip search indexing. | 0 | scripts/provision-30-search-index.sh |
DRUPAL_SHIELD_PRINT | Shield message. | Restricted access. | .env |
DRUPAL_SITE_EMAIL | Drupal site email. | webmaster@example.com | .vortex/tooling/src/vortex-provision, .env |
DRUPAL_SITE_NAME | Drupal site name. | Example site | .vortex/tooling/src/vortex-provision, .env |
DRUPAL_STAGE_FILE_PROXY_ORIGIN | Stage 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_FILES | Path to temporary files. | ${DRUPAL_PRIVATE_FILES}/tmp | docker-compose.yml |
DRUPAL_THEME | Drupal theme name. | your_site_theme | .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. | your-site-domain.example,www.your-site-domain.example | .env |
ENVIRONMENT_TYPE | Override detected Drupal environment type. Used in the application to override the automatically detected environment type. | UNDEFINED | ENVIRONMENT |
LAGOON_PROJECT | Lagoon project name. May be different from $VORTEX_PROJECT.Update drush/sites/lagoon.site.yml if you update this value. | your_site | .env |
NEWRELIC_ENABLED | Enable New Relic in Lagoon environment. Set as project-wide variable. | UNDEFINED | LAGOON ENVIRONMENT |
NEWRELIC_LICENSE | New Relic license. Set as project-wide variable. | UNDEFINED | 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 | UNDEFINED | .env.local.example, scripts/vortex-tooling.sh |
RENOVATE_DEPENDENCY_DASHBOARD | Whether to enable self-hosted Renovate bot dashboard. | false | CI config |
RENOVATE_DRY_RUN | Whether to allow self-hosted Renovate bot make changes to the repository. | false | CI config |
RENOVATE_GIT_AUTHOR | Commit author for self-hosted Renovate bot. | 'Renovate Self Hosted <renovatebot@your-site-domain.example>' | CI config |
RENOVATE_REPOSITORIES | Renovate repositories to manage. Set as "organization/repository". | UNDEFINED | CI config |
RENOVATE_TOKEN | Self-hosted Renovate bot token. Create a GitHub token with a permission to write to a repository. | UNDEFINED | CI config |
TZ | The timezone used within the containers. | UTC | .env |
VORTEX_ACQUIA_APP_NAME | Acquia application name. | UNDEFINED | .env |
VORTEX_ACQUIA_KEY | Acquia Cloud API key. | UNDEFINED | .env.local.example |
VORTEX_ACQUIA_SECRET | Acquia Cloud API secret. | UNDEFINED | .env.local.example |
VORTEX_CI_ARTIFACTS | Directory to store test artifacts in CI. | /tmp/artifacts | CI config |
VORTEX_CI_BEHAT_IGNORE_FAILURE | Ignore Behat test failures. | UNDEFINED | CI config |
VORTEX_CI_BEHAT_PROFILE | Test Behat profile to use in CI. If not set, the default profile will be used. | UNDEFINED | CI config |
VORTEX_CI_CODE_COVERAGE_PR_COMMENT_SKIP | Skip posting code coverage report as a PR comment. | UNDEFINED | CI config |
VORTEX_CI_CODE_COVERAGE_THRESHOLD | Code coverage threshold percentage. Build fails if coverage is below this value. | 90 | CI config |
VORTEX_CI_COMPOSER_AUDIT_IGNORE_FAILURE | Ignore composer audit failures. | UNDEFINED | CI config |
VORTEX_CI_COMPOSER_NORMALIZE_IGNORE_FAILURE | Ignore composer normalize failures. | UNDEFINED | CI config |
VORTEX_CI_COMPOSER_VALIDATE_IGNORE_FAILURE | Ignore composer validate failures. | UNDEFINED | CI config |
VORTEX_CI_DCLINT_IGNORE_FAILURE | Ignore DCLint failures. | UNDEFINED | CI config |
VORTEX_CI_GHERKIN_LINT_IGNORE_FAILURE | Ignore Gherkin Lint failures. | UNDEFINED | CI config |
VORTEX_CI_HADOLINT_IGNORE_FAILURE | Ignore Hadolint failures. | UNDEFINED | CI config |
VORTEX_CI_JEST_IGNORE_FAILURE | Ignore Jest test failures. | UNDEFINED | CI config |
VORTEX_CI_NODEJS_LINT_IGNORE_FAILURE | Ignore NodeJS linters failures. | UNDEFINED | CI config |
VORTEX_CI_PHPCS_IGNORE_FAILURE | Ignore PHPCS failures. | UNDEFINED | CI config |
VORTEX_CI_PHPSTAN_IGNORE_FAILURE | Ignore PHPStan failures. | UNDEFINED | CI config |
VORTEX_CI_PHPUNIT_IGNORE_FAILURE | Ignore PHPUnit test failures. | UNDEFINED | CI config |
VORTEX_CI_RECTOR_IGNORE_FAILURE | Ignore Rector failures. | UNDEFINED | CI config |
VORTEX_CI_TEST_RESULTS | Directory to store test results in CI. | /tmp/tests | CI config |
VORTEX_CI_TWIG_CS_FIXER_IGNORE_FAILURE | Ignore Twig CS Fixer failures. | UNDEFINED | CI config |
VORTEX_CONTAINER_REGISTRY | Container registry name. Provide port, if required as <server_name>:<port>. | docker.io | .env |
VORTEX_CONTAINER_REGISTRY_PASS | The password (token) to log into the container registry. | UNDEFINED | .env.local.example |
VORTEX_CONTAINER_REGISTRY_USER | The username to log into the container registry. | UNDEFINED | .env.local.example |
VORTEX_DB_DIR | Database dump directory. The directory is used to store the database dump files for import and export. | ./.data | .env, scripts/provision-20-migration.sh |
VORTEX_DB_FILE | Database dump file name. The file is used to import the database into an empty database container. | db.sql | .env |
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. | UNDEFINED | .env |
VORTEX_DEBUG | Set to 1 to print debug information in Vortex scripts. | UNDEFINED | .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). | UNDEFINED | .vortex/tooling/src/vortex-deploy |
VORTEX_DEPLOY_ALLOW_LABEL | Label that authorizes a pull request deployment. When set to a non-empty label name, a PR deployment proceeds only if the pull request carries that label; PRs without it are skipped. When empty (the default), the gate is inactive. Only applies to PR builds (VORTEX_DEPLOY_PR set); branch and tag deployments are unaffected. | UNDEFINED | .vortex/tooling/src/vortex-deploy, CI config |
VORTEX_DEPLOY_ALLOW_SKIP | Flag to allow skipping of a deployment using additional flags. | UNDEFINED | .vortex/tooling/src/vortex-deploy, CI config |
VORTEX_DEPLOY_ARTIFACT_CLEANUP_AGE | Age in days after which a matching remote branch is considered stale. | 7 | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_CLEANUP_PATTERN | Remote branches eligible for stale branch cleanup after a successful push: comma-separated globs (e.g. "feature/,bugfix/") or a single regex literal. A branch matching any pattern is pruned. Setting this enables cleanup; empty disables it. The just-pushed branch and the remote default branch are kept. | UNDEFINED | .vortex/tooling/src/vortex-deploy-artifact |
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 | [branch] | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_GIT_ARTIFACT_SHA256 | SHA256 checksum of the git-artifact binary. | bff9d061fb757051366d650c35e367d9b024b7146e22fbd831c734ff88f4af4d | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_GIT_ARTIFACT_VERSION | Version of git-artifact to download. | 1.7.0 | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_GIT_REMOTE | Remote repository to push code to. | UNDEFINED | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_GIT_USER_EMAIL | Email address of the user who will be committing to a remote repository. | UNDEFINED | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAME | Name of the user who will be committing to a remote repository. | Deployment Robot | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_LOG | Deployment log file name. | ${VORTEX_DEPLOY_ARTIFACT_ROOT}/deployment_log.txt | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_ROOT | The root directory where the deployment script should run from. Defaults to the current directory. | $(pwd) | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_SRC | Source of the code to be used for artifact building. | UNDEFINED | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_SSH_FILE | Default SSH file used if custom fingerprint is not provided. | ${HOME}/.ssh/id_rsa | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_ARTIFACT_SSH_FINGERPRINT | SSH key fingerprint used to connect to remote. | ${VORTEX_DEPLOY_SSH_FINGERPRINT} | .vortex/tooling/src/vortex-deploy-artifact |
VORTEX_DEPLOY_BRANCH | Deployment branch name. | UNDEFINED | .vortex/tooling/src/vortex-deploy |
VORTEX_DEPLOY_LAGOON_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). | create | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_BRANCH | The Lagoon branch to deploy. | ${VORTEX_DEPLOY_BRANCH} | .vortex/tooling/src/vortex-deploy-lagoon |
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. | 0 | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_INSTANCE | The Lagoon instance name to interact with. | amazeeio | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_INSTANCE_GRAPHQL | The Lagoon instance GraphQL endpoint to interact with. | https://api.lagoon.amazeeio.cloud/graphql | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_INSTANCE_HOSTNAME | The Lagoon instance hostname to interact with. | ssh.lagoon.amazeeio.cloud | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_INSTANCE_PORT | The Lagoon instance port to interact with. | 32222 | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_LAGOONCLI_FORCE_INSTALL | Flag to force the installation of Lagoon CLI. | ${VORTEX_LAGOONCLI_FORCE_INSTALL} | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_LAGOONCLI_PATH | Location of the Lagoon CLI binary. | /tmp | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_LAGOONCLI_VERSION | Lagoon CLI version to use. | v0.32.0 | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_PR | The PR number to deploy. | ${VORTEX_DEPLOY_PR} | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_PROJECT | The Lagoon project to perform deployment for. | ${LAGOON_PROJECT} | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_PR_BASE_BRANCH | The PR base branch (the branch the PR is raised against). Defaults to 'develop'. | develop | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_PR_HEAD | The PR head branch to deploy. | ${VORTEX_DEPLOY_PR_HEAD} | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_SSH_FILE | Default SSH file used if custom fingerprint is not provided. | ${HOME}/.ssh/id_rsa | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_LAGOON_SSH_FINGERPRINT | SSH 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} | .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_MODE | Deployment mode. Values can be one of: branch, tag. | branch | .vortex/tooling/src/vortex-deploy, .vortex/tooling/src/vortex-deploy-lagoon |
VORTEX_DEPLOY_PR | Deployment pull request number without "pr-" prefix. | UNDEFINED | .vortex/tooling/src/vortex-deploy |
VORTEX_DEPLOY_PR_LABELS | Comma-separated list of labels present on the deployed pull request. Populated by the CI provider from the pull request event (for example, in GitHub Actions from "github.event.pull_request.labels"). Consulted by the VORTEX_DEPLOY_ALLOW_LABEL gate. | UNDEFINED | .vortex/tooling/src/vortex-deploy |
VORTEX_DEPLOY_SKIP | Skip all deployments. | UNDEFINED | CI config |
VORTEX_DEPLOY_TYPES | Deployment occurs when tests pass in the CI environment. @see https://www.vortextemplate.com/docs/deployment | artifact | .env, .vortex/tooling/src/vortex-deploy |
VORTEX_DEPLOY_WEBHOOK_METHOD | Webhook call method. | GET | .vortex/tooling/src/vortex-deploy-webhook |
VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS | The status code of the expected response. | 200 | .vortex/tooling/src/vortex-deploy-webhook |
VORTEX_DEPLOY_WEBHOOK_URL | The URL of the webhook to call. | UNDEFINED | .vortex/tooling/src/vortex-deploy-webhook |
VORTEX_DOCTOR_CHECK_BOOTSTRAP | UNDEFINED | .vortex/tooling/src/vortex-doctor | |
VORTEX_DOCTOR_CHECK_CONTAINERS | 0 | .vortex/tooling/src/vortex-doctor | |
VORTEX_DOCTOR_CHECK_MINIMAL | Check minimal Doctor requirements. | 0 | .vortex/tooling/src/vortex-doctor |
VORTEX_DOCTOR_CHECK_PORT | UNDEFINED | .vortex/tooling/src/vortex-doctor | |
VORTEX_DOCTOR_CHECK_PYGMY | UNDEFINED | .vortex/tooling/src/vortex-doctor | |
VORTEX_DOCTOR_CHECK_SSH | UNDEFINED | .vortex/tooling/src/vortex-doctor | |
VORTEX_DOCTOR_CHECK_TOOLS | 1 | .vortex/tooling/src/vortex-doctor | |
VORTEX_DOCTOR_CHECK_WEBSERVER | UNDEFINED | .vortex/tooling/src/vortex-doctor | |
VORTEX_EXPORT_DB_CONTAINER_REGISTRY | Container registry name. | docker.io | .vortex/tooling/src/vortex-export-db-image |
VORTEX_EXPORT_DB_CONTAINER_REGISTRY_PUSH_PROCEED | Proceed with container image push after it was exported. | UNDEFINED | CI config |
VORTEX_EXPORT_DB_FILE_DIR | Directory with database dump file. | ./.data | .vortex/tooling/src/vortex-export-db-file |
VORTEX_EXPORT_DB_FILE_STRUCTURE_TABLES | Tables to export with their structure but without their data. Accepts a comma-separated list where each entry may use the * wildcard. Drupal rebuilds cache tables on demand, so their contents only inflate the dump. Set to an empty value to export the data of every table. | cache* | .vortex/tooling/src/vortex-export-db-file |
VORTEX_EXPORT_DB_IMAGE | Name of the database container image to use. Uncomment to use an image with a DB data loaded into it. @see https://github.com/drevops/mariadb-drupal-data to seed your DB image. | ${VORTEX_DB_IMAGE} | .vortex/tooling/src/vortex-export-db, .vortex/tooling/src/vortex-export-db-image, .vortex/tooling/src/vortex-push-db-image |
VORTEX_EXPORT_DB_IMAGE_ARCHIVE_FILE | Container image archive file name. | UNDEFINED | .vortex/tooling/src/vortex-export-db-image |
VORTEX_EXPORT_DB_IMAGE_DIR | Directory with database image archive file. | ${VORTEX_DB_DIR} | .vortex/tooling/src/vortex-export-db-image |
VORTEX_EXPORT_DB_SERVICE_NAME | The service name to capture. | database | .vortex/tooling/src/vortex-export-db-image |
VORTEX_FETCH_DB2_ACQUIA_DB_NAME | Acquia database name to fetch the second database from. | your_site | .env |
VORTEX_FETCH_DB2_ENVIRONMENT | Environment to fetch the second database from. Applies to hosting environments. | prod | .env |
VORTEX_FETCH_DB2_FILE | Second database dump file name. | db2.sql | .env, scripts/provision-20-migration.sh |
VORTEX_FETCH_DB2_FTP_FILE | Second database dump FTP file name. | db2.sql | .env |
VORTEX_FETCH_DB2_FTP_HOST | Second database dump FTP host. | UNDEFINED | .env |
VORTEX_FETCH_DB2_FTP_PORT | Second database dump FTP port. | 21 | .env |
VORTEX_FETCH_DB2_S3_BUCKET | AWS S3 bucket name for second database fetch. | UNDEFINED | .env |
VORTEX_FETCH_DB2_S3_REGION | AWS S3 region. | ap-southeast-2 | .env |
VORTEX_FETCH_DB2_SOURCE | Second database fetch source. | url | .env |
VORTEX_FETCH_DB2_URL | Second database dump file sourced from a URL. HTTP Basic Authentication credentials should be embedded into the value. | UNDEFINED | .env |
VORTEX_FETCH_DB_ACQUIA_APP_NAME | Application name. Used to discover UUID. | ${VORTEX_ACQUIA_APP_NAME} | .vortex/tooling/src/vortex-fetch-db-acquia |
VORTEX_FETCH_DB_ACQUIA_BACKUP_MAX_WAIT | Maximum time in seconds to wait for backup completion. | 600 | .vortex/tooling/src/vortex-fetch-db-acquia |
VORTEX_FETCH_DB_ACQUIA_BACKUP_WAIT_INTERVAL | Interval in seconds to wait between backup status checks. | 10 | .vortex/tooling/src/vortex-fetch-db-acquia |
VORTEX_FETCH_DB_ACQUIA_DB_DIR | Directory where DB dumps are stored. | ./.data | .vortex/tooling/src/vortex-fetch-db-acquia |
VORTEX_FETCH_DB_ACQUIA_DB_FILE | Database dump file name. | db.sql | .vortex/tooling/src/vortex-fetch-db-acquia |
VORTEX_FETCH_DB_ACQUIA_DB_NAME | Acquia database name to fetch the database from. | your_site | .env, .vortex/tooling/src/vortex-fetch-db-acquia |
VORTEX_FETCH_DB_ACQUIA_KEY | Acquia Cloud API key. | ${VORTEX_ACQUIA_KEY} | .vortex/tooling/src/vortex-fetch-db-acquia |
VORTEX_FETCH_DB_ACQUIA_SECRET | Acquia Cloud API secret. | ${VORTEX_ACQUIA_SECRET} | .vortex/tooling/src/vortex-fetch-db-acquia |
VORTEX_FETCH_DB_CONTAINER_REGISTRY | Container registry name. Provide port, if required as <server_name>:<port>. | docker.io | .vortex/tooling/src/vortex-fetch-db-container-registry |
VORTEX_FETCH_DB_CONTAINER_REGISTRY_DB_DIR | Directory with database dump file. | ./.data | .vortex/tooling/src/vortex-fetch-db-container-registry |
VORTEX_FETCH_DB_CONTAINER_REGISTRY_IMAGE | The container image containing database passed in a form of <org>/<repository>. | UNDEFINED | .vortex/tooling/src/vortex-fetch-db-container-registry |
VORTEX_FETCH_DB_CONTAINER_REGISTRY_IMAGE_BASE | The base container image used as a fallback when the archive does not exist. | UNDEFINED | .vortex/tooling/src/vortex-fetch-db-container-registry |
VORTEX_FETCH_DB_CONTAINER_REGISTRY_PASS | The password to login into the container registry. | ${VORTEX_CONTAINER_REGISTRY_PASS} | .vortex/tooling/src/vortex-fetch-db-container-registry |
VORTEX_FETCH_DB_CONTAINER_REGISTRY_USER | The username to login into the container registry. | ${VORTEX_CONTAINER_REGISTRY_USER} | .vortex/tooling/src/vortex-fetch-db-container-registry |
VORTEX_FETCH_DB_DIR | Directory with database dump file. | ./.data | .vortex/tooling/src/vortex-fetch-db |
VORTEX_FETCH_DB_ENVIRONMENT | Environment to fetch 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, .vortex/tooling/src/vortex-fetch-db-acquia, .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_FILE | Database dump file name. | db.sql | .vortex/tooling/src/vortex-fetch-db |
VORTEX_FETCH_DB_FORCE | Always override existing fetched DB dump. | 1 | .env.local.example, .vortex/tooling/src/vortex-fetch-db, .vortex/tooling/src/vortex-fetch-db-container-registry |
VORTEX_FETCH_DB_FRESH | Flag to fetch a fresh copy of the database by triggering a new backup. | UNDEFINED | .vortex/tooling/src/vortex-fetch-db-acquia, .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_FTP_DB_DIR | Directory with database dump file. | ./.data | .vortex/tooling/src/vortex-fetch-db-ftp |
VORTEX_FETCH_DB_FTP_DB_FILE | Database dump file name. | db.sql | .vortex/tooling/src/vortex-fetch-db-ftp |
VORTEX_FETCH_DB_FTP_FILE | Database dump FTP file name. | db.sql | .env, .vortex/tooling/src/vortex-fetch-db-ftp |
VORTEX_FETCH_DB_FTP_HOST | Database dump FTP host. | UNDEFINED | .env, .vortex/tooling/src/vortex-fetch-db-ftp |
VORTEX_FETCH_DB_FTP_PASS | Database dump FTP password. | UNDEFINED | .env.local.example, .vortex/tooling/src/vortex-fetch-db-ftp |
VORTEX_FETCH_DB_FTP_PORT | Database dump FTP port. | 21 | .env, .vortex/tooling/src/vortex-fetch-db-ftp |
VORTEX_FETCH_DB_FTP_USER | Database dump FTP user. | UNDEFINED | .env.local.example, .vortex/tooling/src/vortex-fetch-db-ftp |
VORTEX_FETCH_DB_LAGOON_DB_DIR | Directory where DB dumps are stored on the host. | ./.data | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_LAGOON_DB_FILE | Database dump file name on the host. | db.sql | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_LAGOON_PROJECT | Lagoon project name. | ${LAGOON_PROJECT} | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_LAGOON_REMOTE_DIR | Remote DB dump directory location. | /tmp | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_LAGOON_REMOTE_FILE | Remote DB dump file name. Cached by the date suffix. | db_$(date +%Y%m%d).sql | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_LAGOON_REMOTE_FILE_CLEANUP | Wildcard file name to cleanup previously created dump files. Cleanup runs only if the variable is set and $VORTEX_FETCH_DB_LAGOON_REMOTE_FILE does not exist. | db_*.sql | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_LAGOON_SSH_HOST | The SSH host of the Lagoon environment. | ssh.lagoon.amazeeio.cloud | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_LAGOON_SSH_PORT | The SSH port of the Lagoon environment. | 32222 | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_LAGOON_SSH_USER | The SSH user of the Lagoon environment. | ${VORTEX_FETCH_DB_LAGOON_PROJECT}-${VORTEX_FETCH_DB_ENVIRONMENT} | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_PROCEED | Proceed with fetch. | 1 | .vortex/tooling/src/vortex-fetch-db |
VORTEX_FETCH_DB_S3_ACCESS_KEY | AWS access key for S3 database fetch. | UNDEFINED | .env.local.example, .vortex/tooling/src/vortex-fetch-db-s3 |
VORTEX_FETCH_DB_S3_BUCKET | AWS S3 bucket name for database fetch. | UNDEFINED | .env, .vortex/tooling/src/vortex-fetch-db-s3 |
VORTEX_FETCH_DB_S3_DB_DIR | Directory with database dump file. | ./.data | .vortex/tooling/src/vortex-fetch-db-s3 |
VORTEX_FETCH_DB_S3_DB_FILE | Database dump file name. | db.sql | .vortex/tooling/src/vortex-fetch-db-s3 |
VORTEX_FETCH_DB_S3_PREFIX | S3 prefix (path within the bucket). | ${S3_PREFIX} | .vortex/tooling/src/vortex-fetch-db-s3 |
VORTEX_FETCH_DB_S3_REGION | AWS S3 region. | ap-southeast-2 | .env, .vortex/tooling/src/vortex-fetch-db-s3 |
VORTEX_FETCH_DB_S3_SECRET_KEY | AWS secret key for S3 database fetch. | UNDEFINED | .env.local.example, .vortex/tooling/src/vortex-fetch-db-s3 |
VORTEX_FETCH_DB_SOURCE | Database fetch source. | url | .env, .vortex/tooling/src/vortex-fetch-db |
VORTEX_FETCH_DB_SSH_FILE | Default SSH file used if custom fingerprint is not provided. | ${HOME}/.ssh/id_rsa | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_SSH_FINGERPRINT | SSH key fingerprint used to connect to a remote. | UNDEFINED | .vortex/tooling/src/vortex-fetch-db-lagoon |
VORTEX_FETCH_DB_UNZIP_PASSWORD | Password for unzipping password-protected zip files. | UNDEFINED | .vortex/tooling/src/vortex-fetch-db-url |
VORTEX_FETCH_DB_URL | Database dump file sourced from a URL. HTTP Basic Authentication credentials should be embedded into the value. | UNDEFINED | .env, .vortex/tooling/src/vortex-fetch-db-url |
VORTEX_FETCH_DB_URL_DB_DIR | Directory with database dump file. | ./.data | .vortex/tooling/src/vortex-fetch-db-url |
VORTEX_FETCH_DB_URL_DB_FILE | Database dump file name. | db.sql | .vortex/tooling/src/vortex-fetch-db-url |
VORTEX_FRONTEND_BUILD_SKIP | Skip building of the front-end assets inside the container image. Set to 1 to build theme assets on the host or as part of deployment instead of during the container image build. | UNDEFINED | .env |
VORTEX_IMPORT_DB_FILE | Database dump file name. | db.sql | .vortex/tooling/src/vortex-import-db-file |
VORTEX_IMPORT_DB_FILE_DIR | Directory with database dump file. | ./.data | .vortex/tooling/src/vortex-import-db-file |
VORTEX_INSTALLER_INTERACTIVE | Run installer in interactive mode. | 0 | .vortex/tooling/src/vortex-update |
VORTEX_INSTALLER_PATH | The path to the installer script. If set, this will override the VORTEX_INSTALLER_URL. | UNDEFINED | .vortex/tooling/src/vortex-update |
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. | https://github.com/drevops/vortex.git#stable | .vortex/tooling/src/vortex-update |
VORTEX_INSTALLER_URL | The URL of the installer script. Pinned to the major-specific path so an existing project always updates within its own major line. The bare '/install' tracks the active major and would jump a project across a major boundary once the next major is released. | https://www.vortextemplate.com/v1/install | .vortex/tooling/src/vortex-update |
VORTEX_INSTALLER_URL_CACHE_BUST | Cache busting parameter for the installer URL. | $(date +%s) | .vortex/tooling/src/vortex-update |
VORTEX_LAGOON_PRODUCTION_BRANCH | Dedicated branch to identify the production environment. | main | .env |
VORTEX_LOGIN_CONTAINER_REGISTRY | Container registry name. Provide port, if required as <server_name>:<port>. | docker.io | .vortex/tooling/src/vortex-login-container-registry |
VORTEX_LOGIN_CONTAINER_REGISTRY_DOCKER_CONFIG | Path to Docker configuration directory. | ${HOME}/.docker | .vortex/tooling/src/vortex-login-container-registry |
VORTEX_LOGIN_CONTAINER_REGISTRY_PASS | ${VORTEX_CONTAINER_REGISTRY_PASS} | .vortex/tooling/src/vortex-login-container-registry | |
VORTEX_LOGIN_CONTAINER_REGISTRY_USER | The username to login into the container registry. If not provided, the script will skip the login step. | ${VORTEX_CONTAINER_REGISTRY_USER} | .vortex/tooling/src/vortex-login-container-registry |
VORTEX_LOGIN_UNBLOCK_ADMIN | Flag to unblock admin. | 1 | .vortex/tooling/src/vortex-login |
VORTEX_LOGOUT_BLOCK_ADMIN | Flag to block or unblock admin. | 1 | .vortex/tooling/src/vortex-logout |
VORTEX_NOTIFY_BRANCH | Notification git branch name. | UNDEFINED | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_CHANNELS | The channels of the notifications. A combination of comma-separated values: email,slack,newrelic,github,jira,webhook,diffy | email | .env, .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_DIFFY_BRANCH | Diffy notification git branch name. | ${VORTEX_NOTIFY_BRANCH} | .vortex/tooling/src/vortex-notify-diffy |
VORTEX_NOTIFY_DIFFY_BRANCHES | Diffy notification branch filter. Comma-separated list of branch names. When set, the dispatch is only sent for deployments on the listed branches. When empty (default), every deployment is dispatched - the workflow then decides whether to run based on whether the target URL is a PR environment and the associated PR carries the configured label. | UNDEFINED | .vortex/tooling/src/vortex-notify-diffy |
VORTEX_NOTIFY_DIFFY_ENVIRONMENT_URL | Diffy notification target environment URL. The deployed environment that should be compared against the Diffy source environment. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | .vortex/tooling/src/vortex-notify-diffy |
VORTEX_NOTIFY_DIFFY_EVENT | Diffy notification event type. Can be 'pre_deployment' or 'post_deployment'. | ${VORTEX_NOTIFY_EVENT} | .vortex/tooling/src/vortex-notify-diffy |
VORTEX_NOTIFY_DIFFY_EVENT_TYPE | Diffy notification dispatch event type. The GitHub Actions 'repository_dispatch' event type that the test-vr.yml workflow listens for. Override only if the workflow has been renamed. | vr_run | .vortex/tooling/src/vortex-notify-diffy |
VORTEX_NOTIFY_DIFFY_LABEL | Diffy notification deployment label. Used as the diff name visible in the Diffy UI. | ${VORTEX_NOTIFY_LABEL} | .vortex/tooling/src/vortex-notify-diffy |
VORTEX_NOTIFY_DIFFY_REPOSITORY | Diffy notification GitHub repository in owner/repo format. Defaults to the GitHub notification repository. | ${VORTEX_NOTIFY_GITHUB_REPOSITORY} | .vortex/tooling/src/vortex-notify-diffy |
VORTEX_NOTIFY_DIFFY_SOURCE_ENV | Diffy notification source environment name. The Diffy environment (production, staging, development) to use as the baseline. Diffy resolves the URL from its own project configuration. | production | .vortex/tooling/src/vortex-notify-diffy |
VORTEX_NOTIFY_DIFFY_TOKEN | Diffy notification GitHub token. Needs 'repo' scope to call the 'repository_dispatch' API endpoint. Defaults to the GitHub notification token if set, otherwise to GITHUB_TOKEN. | ${GITHUB_TOKEN} | .vortex/tooling/src/vortex-notify-diffy |
VORTEX_NOTIFY_EMAIL_BRANCHES | Email notification branch filter. Comma-separated list of branch names. When set, email notifications are only sent for deployments on the listed branches. When empty, no filtering is applied. | UNDEFINED | .vortex/tooling/src/vortex-notify-email |
VORTEX_NOTIFY_EMAIL_ENVIRONMENT_URL | Email notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | .vortex/tooling/src/vortex-notify-email |
VORTEX_NOTIFY_EMAIL_EVENT | Email notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | .vortex/tooling/src/vortex-notify-email |
VORTEX_NOTIFY_EMAIL_FROM | An email address to send notifications from. Applies to email notifications. | webmaster@your-site-domain.example | .env, .vortex/tooling/src/vortex-notify-email |
VORTEX_NOTIFY_EMAIL_LABEL | Email notification deployment label (branch name, PR number, or custom identifier). | ${VORTEX_NOTIFY_LABEL} | .vortex/tooling/src/vortex-notify-email |
VORTEX_NOTIFY_EMAIL_LOG | Include the deployment log in the message body (0/1). Defaults to VORTEX_NOTIFY_LOG. | 0 | .vortex/tooling/src/vortex-notify-email |
VORTEX_NOTIFY_EMAIL_LOGIN_URL | Email notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | .vortex/tooling/src/vortex-notify-email |
VORTEX_NOTIFY_EMAIL_LOG_FILE | Log file path. Defaults to VORTEX_NOTIFY_LOG_FILE. | ${VORTEX_NOTIFY_LOG_FILE} | .vortex/tooling/src/vortex-notify-email |
VORTEX_NOTIFY_EMAIL_MESSAGE | Email notification message template. Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url%, %deployment_log% | UNDEFINED | .vortex/tooling/src/vortex-notify-email |
VORTEX_NOTIFY_EMAIL_PROJECT | Email notification project name. | ${VORTEX_NOTIFY_PROJECT} | .vortex/tooling/src/vortex-notify-email |
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 |
VORTEX_NOTIFY_ENVIRONMENT_URL | Notification environment URL (where the site was deployed). | UNDEFINED | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_EVENT | Notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_GITHUB_BRANCH | GitHub notification git branch name. This will be used as the 'ref' parameter in GitHub's Deployment API. | ${VORTEX_NOTIFY_BRANCH} | .vortex/tooling/src/vortex-notify-github |
VORTEX_NOTIFY_GITHUB_BRANCHES | GitHub notification branch filter. Comma-separated list of branch names. When set, GitHub notifications are only sent for deployments on the listed branches. When empty, no filtering is applied. | UNDEFINED | .vortex/tooling/src/vortex-notify-github |
VORTEX_NOTIFY_GITHUB_ENVIRONMENT_TYPE | GitHub 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. | PR | .vortex/tooling/src/vortex-notify-github |
VORTEX_NOTIFY_GITHUB_ENVIRONMENT_URL | GitHub notification deployment environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | .vortex/tooling/src/vortex-notify-github |
VORTEX_NOTIFY_GITHUB_EVENT | GitHub notification event type. Can be 'pre_deployment' or 'post_deployment'. | ${VORTEX_NOTIFY_EVENT} | .vortex/tooling/src/vortex-notify-github |
VORTEX_NOTIFY_GITHUB_REPOSITORY | GitHub notification repository in owner/repo format. | UNDEFINED | .vortex/tooling/src/vortex-notify-github |
VORTEX_NOTIFY_GITHUB_TOKEN | GitHub notification personal access token. To obtain a personal access token: 1. Log in to GitHub 2. Go to Settings -> Developer settings -> Personal access tokens 3. Create a token with the 'repo' scope 4. The classic token format is: ghp_XXXXXXXXXXXXXXXXXXXX@see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens | ${GITHUB_TOKEN} | .vortex/tooling/src/vortex-notify-github, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT |
VORTEX_NOTIFY_JIRA_ASSIGNEE_EMAIL | JIRA notification assignee email address. If left empty - no assignment will be performed. | UNDEFINED | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_BRANCH | JIRA notification git branch name (used for issue extraction). | ${VORTEX_NOTIFY_BRANCH} | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_BRANCHES | JIRA notification branch filter. Comma-separated list of branch names. When set, JIRA notifications are only sent for deployments on the listed branches. When empty, no filtering is applied. | UNDEFINED | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_ENDPOINT | JIRA notification API endpoint. | https://jira.atlassian.com | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_ENVIRONMENT_URL | JIRA notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_EVENT | JIRA notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_LABEL | JIRA notification deployment label (human-readable identifier for display). | ${VORTEX_NOTIFY_LABEL} | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_LOG | Include the deployment log in the comment (0/1). Defaults to VORTEX_NOTIFY_LOG. | 0 | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_LOGIN_URL | JIRA notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_LOG_FILE | Log file path. Defaults to VORTEX_NOTIFY_LOG_FILE. | ${VORTEX_NOTIFY_LOG_FILE} | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_MESSAGE | JIRA notification message template (will be converted to ADF format). Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url% | UNDEFINED | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_PROJECT | JIRA notification project name. | ${VORTEX_NOTIFY_PROJECT} | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_TOKEN | JIRA notification API token. To obtain an API token: 1. Log in to your Atlassian account 2. Go to Account settings -> Security -> API tokens 3. Click "Create API token" and copy the generated value@see https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/ @see https://www.vortextemplate.com/docs/deployment/notifications#jira | UNDEFINED | .vortex/tooling/src/vortex-notify-jira, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT |
VORTEX_NOTIFY_JIRA_TRANSITION | JIRA notification state to transition to. If left empty - no transition will be performed. | UNDEFINED | .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_JIRA_USER_EMAIL | JIRA user email address. | user@example.com | .env, .vortex/tooling/src/vortex-notify-jira |
VORTEX_NOTIFY_LABEL | Notification deployment label (human-readable identifier for display). | UNDEFINED | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_LOG | Collect deployment logs into the notification body (0/1). Set in '.env' or per environment. | 0 | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_LOGIN_URL | Notification login URL (defaults to ENVIRONMENT_URL/user/login if not provided). | UNDEFINED | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_LOG_DIR | Directory from which deployment logs are collected. Each producing script writes its own <name>.log here. | /tmp/vortex-logs | .vortex/tooling/src/vortex-notify, .vortex/tooling/src/vortex-provision |
VORTEX_NOTIFY_LOG_FILE | Path of the combined log file passed to the channels, empty when no logs were collected. | .vortex/tooling/src/vortex-notify | |
VORTEX_NOTIFY_NEWRELIC_APIKEY | NewRelic API key, usually of type 'USER'. @see https://www.vortextemplate.com/docs/deployment/notifications#new-relic | UNDEFINED | ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT |
VORTEX_NOTIFY_NEWRELIC_APPID | New Relic notification application ID (auto-discovered from the application name if not provided). | UNDEFINED | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_APP_NAME | New Relic notification application name as it appears in the dashboard. | ${VORTEX_NOTIFY_NEWRELIC_PROJECT}-${VORTEX_NOTIFY_NEWRELIC_LABEL} | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_BRANCHES | New Relic notification branch filter. Comma-separated list of branch names. When set, New Relic notifications are only sent for deployments on the listed branches. When empty, no filtering is applied. | main,master,develop | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_CHANGELOG | New Relic notification deployment changelog. Defaults to the description. | UNDEFINED | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_DESCRIPTION | New Relic notification deployment description template. Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url% | UNDEFINED | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_ENABLED | Flag to enable New Relic notifications. Set to "true" (not "1") in environments where New Relic is configured. | ${NEWRELIC_ENABLED} | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_ENDPOINT | New Relic notification API endpoint. | https://api.newrelic.com/v2 | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_ENVIRONMENT_URL | New Relic notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_EVENT | New Relic notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_LABEL | New Relic notification deployment label (human-readable identifier for display). | ${VORTEX_NOTIFY_LABEL} | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_LOGIN_URL | New Relic notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_PROJECT | New Relic notification project name. | ${VORTEX_NOTIFY_PROJECT} | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_REVISION | New Relic notification deployment revision. If not provided, will use SHA if available, otherwise auto-generated. | UNDEFINED | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_SHA | New Relic notification git commit SHA. | ${VORTEX_NOTIFY_SHA} | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_USER | New Relic notification user performing deployment. | Deployment robot | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_NEWRELIC_USER_KEY | New 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} | .vortex/tooling/src/vortex-notify-newrelic |
VORTEX_NOTIFY_PROJECT | Notification project name. | ${VORTEX_PROJECT} | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_PR_NUMBER | Notification pull request number. | UNDEFINED | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_SHA | Notification git commit SHA. | UNDEFINED | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_SKIP | Notification skip flag. | UNDEFINED | .vortex/tooling/src/vortex-notify |
VORTEX_NOTIFY_SLACK_BRANCHES | Slack notification branch filter. Comma-separated list of branch names. When set, Slack notifications are only sent for deployments on the listed branches. When empty, no filtering is applied. | UNDEFINED | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_CHANNEL | Slack notification target channel (optional, overrides webhook default). Format: #channel-name or @username | UNDEFINED | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_ENVIRONMENT_URL | Slack notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_EVENT | Slack notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_ICON_EMOJI | Slack notification bot icon emoji (optional). | :rocket: | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_LABEL | Slack notification deployment label (branch name, PR number, or custom identifier). | ${VORTEX_NOTIFY_LABEL} | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_LOG | Include the deployment log in the message (0/1). Defaults to VORTEX_NOTIFY_LOG. | 0 | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_LOGIN_URL | Slack notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_LOG_FILE | Log file path. Defaults to VORTEX_NOTIFY_LOG_FILE. | ${VORTEX_NOTIFY_LOG_FILE} | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_MESSAGE | Slack notification message template (for fallback text). Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url% | UNDEFINED | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_PROJECT | Slack notification project name. | ${VORTEX_NOTIFY_PROJECT} | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_USERNAME | Slack notification bot display name (optional). | Deployment Bot | .vortex/tooling/src/vortex-notify-slack |
VORTEX_NOTIFY_SLACK_WEBHOOK | Slack notification webhook URL. The incoming Webhook URL from your Slack app configuration. To obtain a webhook URL: 1. Create or open a Slack app at https://api.slack.com/apps 2. Enable "Incoming Webhooks" for the app 3. Click "Add New Webhook to Workspace" and select a channel 4. The URL format is: https://hooks.slack.com/services/XXX/YYY/ZZZ@see https://www.vortextemplate.com/docs/deployment/notifications#slack | UNDEFINED | .vortex/tooling/src/vortex-notify-slack, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT |
VORTEX_NOTIFY_WEBHOOK_BRANCHES | Webhook notification branch filter. Comma-separated list of branch names. When set, webhook notifications are only sent for deployments on the listed branches. When empty, no filtering is applied. | UNDEFINED | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_ENVIRONMENT_URL | Webhook notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_EVENT | Webhook notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_HEADERS | Webhook notification pipe-separated headers. Separate multiple headers with a pipe ` | . Example: Content-type: application/json | Authorization: Bearer API_KEY`. |
VORTEX_NOTIFY_WEBHOOK_LABEL | Webhook notification deployment label (branch name, PR number, or custom identifier). | ${VORTEX_NOTIFY_LABEL} | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_LOG | Include the deployment log in the payload (0/1). Defaults to VORTEX_NOTIFY_LOG. | 0 | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_LOGIN_URL | Webhook notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_LOG_FILE | Log file path. Defaults to VORTEX_NOTIFY_LOG_FILE. | ${VORTEX_NOTIFY_LOG_FILE} | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_METHOD | Webhook notification HTTP method like POST, GET, PUT. | POST | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_PAYLOAD | Webhook notification JSON payload. Available tokens: %message%, %project%, %label%, %timestamp%, %environment_url%, %login_url%, %deployment_log% | UNDEFINED | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_PROJECT | Webhook notification project name. | ${VORTEX_NOTIFY_PROJECT} | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_RESPONSE_STATUS | Webhook notification expected HTTP status. | 200 | .vortex/tooling/src/vortex-notify-webhook |
VORTEX_NOTIFY_WEBHOOK_URL | Webhook URL to send notifications to. | UNDEFINED | .env, .vortex/tooling/src/vortex-notify-webhook, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT |
VORTEX_PROJECT | Project 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, .vortex/tooling/src/vortex-info |
VORTEX_PROVISION_ACQUIA_SKIP | Skip Drupal site provisioning in Acquia environment. | UNDEFINED | ACQUIA ENVIRONMENT |
VORTEX_PROVISION_CACHE_REBUILD_AFTER_DB_UPDATE_SKIP | Skip cache rebuild after database updates. | 0 | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_CONFIG_IMPORT_REPEAT | Repeat configuration import after the initial import. Useful when update hooks introduce new configuration that affects subsequent configuration imports (e.g., new config_split settings). | 0 | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_DB | Provision database dump file. If not set, it will be auto-discovered from the VORTEX_DB_DIR directory using the VORTEX_DB_FILE name. | UNDEFINED | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_DB_DIR | Directory with database dump file. | ./.data | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_DB_FILE | Database dump file name. | db.sql | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_DB_IMAGE | Name of the pre-built database container image. | ${VORTEX_DB_IMAGE} | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_FALLBACK_TO_PROFILE | Fallback 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, .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_LOG | Write the provision log for collection by deployment notifications (0/1). | 0 | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_OVERRIDE_DB | Overwrite 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, .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_POST_OPERATIONS_SKIP | Flag 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). | 0 | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_SANITIZE_DB_ADDITIONAL_FILE | Path 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.sql | .vortex/tooling/src/vortex-provision-sanitize-db |
VORTEX_PROVISION_SANITIZE_DB_EMAIL | Sanitization 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, .vortex/tooling/src/vortex-provision-sanitize-db |
VORTEX_PROVISION_SANITIZE_DB_PASSWORD | Database sanitized account password replacement. | ${RANDOM}${RANDOM}${RANDOM}${RANDOM} | .vortex/tooling/src/vortex-provision-sanitize-db, .env |
VORTEX_PROVISION_SANITIZE_DB_REPLACE_USERNAME_WITH_EMAIL | Replace username with mail. | 0 | .vortex/tooling/src/vortex-provision-sanitize-db, .env |
VORTEX_PROVISION_SANITIZE_DB_SKIP | Skip 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, .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_SCRIPTS_DIR | Directory with custom provision scripts. | ./scripts | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_SKIP | Flag to skip site provisioning. | UNDEFINED | .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_TYPE | Set to 'profile' to install a site from profile instead of the database dump. | database | .env, .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_USE_MAINTENANCE_MODE | Put the site into a maintenance mode during site provisioning. | 1 | .env, .vortex/tooling/src/vortex-provision |
VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE | Verify 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, .vortex/tooling/src/vortex-provision |
VORTEX_PURGE_CACHE_ACQUIA_SKIP | Skip purging of edge cache in Acquia environment. | UNDEFINED | ACQUIA ENVIRONMENT |
VORTEX_PUSH_CONTAINER_REGISTRY | Container registry name. Provide port, if required as <server_name>:<port>. | docker.io | .vortex/tooling/src/vortex-push-container-registry |
VORTEX_PUSH_CONTAINER_REGISTRY_IMAGE_TAG | The tag of the container image. | latest | .vortex/tooling/src/vortex-push-container-registry |
VORTEX_PUSH_CONTAINER_REGISTRY_MAP | Comma-separated map of container services and images to push in format "service1=org/image1,service2=org/image2". | UNDEFINED | .vortex/tooling/src/vortex-push-container-registry, .vortex/tooling/src/vortex-push-db-image |
VORTEX_PUSH_CONTAINER_REGISTRY_PASS | The password to login into the container registry. | ${VORTEX_CONTAINER_REGISTRY_PASS} | .vortex/tooling/src/vortex-push-container-registry |
VORTEX_PUSH_CONTAINER_REGISTRY_USER | The username to login into the container registry. | ${VORTEX_CONTAINER_REGISTRY_USER} | .vortex/tooling/src/vortex-push-container-registry |
VORTEX_PUSH_DB_S3_ACCESS_KEY | AWS access key. | ${S3_ACCESS_KEY} | .vortex/tooling/src/vortex-push-db-s3 |
VORTEX_PUSH_DB_S3_BUCKET | S3 bucket name. | ${S3_BUCKET} | .vortex/tooling/src/vortex-push-db-s3 |
VORTEX_PUSH_DB_S3_DB_DIR | Directory with database dump file. | ./.data | .vortex/tooling/src/vortex-push-db-s3 |
VORTEX_PUSH_DB_S3_DB_FILE | Database dump file name. | db.sql | .vortex/tooling/src/vortex-push-db-s3 |
VORTEX_PUSH_DB_S3_PREFIX | S3 prefix (path within the bucket). | ${S3_PREFIX} | .vortex/tooling/src/vortex-push-db-s3 |
VORTEX_PUSH_DB_S3_REGION | S3 region. | ${S3_REGION} | .vortex/tooling/src/vortex-push-db-s3 |
VORTEX_PUSH_DB_S3_REMOTE_FILE | Remote database dump file name. | db.sql | .vortex/tooling/src/vortex-push-db-s3 |
VORTEX_PUSH_DB_S3_SECRET_KEY | AWS secret key. | ${S3_SECRET_KEY} | .vortex/tooling/src/vortex-push-db-s3 |
VORTEX_PUSH_DB_S3_STORAGE_CLASS | S3 storage class. | STANDARD | .vortex/tooling/src/vortex-push-db-s3 |
VORTEX_RELEASE_VERSION_SCHEME | Versioning scheme used for releases. Can be one of: calver, semver, other @see https://www.vortextemplate.com/docs/releasing | calver | .env |
VORTEX_SHOW_LOGIN | Show one-time login link. | UNDEFINED | .vortex/tooling/src/vortex-info |
VORTEX_SSH_DISABLE_STRICT_HOST_KEY_CHECKING | Disable strict host key checking in SSH. | 0 | .vortex/tooling/src/vortex-setup-ssh |
VORTEX_SSH_FILE | Default SSH key file. | ${HOME}/.ssh/id_rsa | .vortex/tooling/src/vortex-doctor |
VORTEX_SSH_KNOWN_HOSTS | Pinned SSH host keys as 'known_hosts' entries (newline-separated). When set, the entries are written to the SSH 'known_hosts' file and strict host key checking is kept enabled. This is the secure alternative to disabling strict checking and takes precedence over VORTEX_SSH_DISABLE_STRICT_HOST_KEY_CHECKING. | UNDEFINED | .vortex/tooling/src/vortex-setup-ssh |
VORTEX_SSH_PREFIX | Prefix used to load SSH key from prefixes environment variables: - VORTEX_ ${VORTEX_SSH_PREFIX}SSH_FINGERPRINT - the variable name with theSSH key fingerprint value. - VORTEX ${VORTEX_SSH_PREFIX}_SSH_FILE - the variable name with the SSHkey file path. | UNDEFINED | .vortex/tooling/src/vortex-setup-ssh |
VORTEX_SSH_REMOVE_ALL_KEYS | Remove all SSH keys from the SSH agent before loading the new one. | 0 | .vortex/tooling/src/vortex-setup-ssh |
VORTEX_TASK_COPY_DB_ACQUIA_APP_NAME | Application name. Used to discover UUID. | ${VORTEX_ACQUIA_APP_NAME} | .vortex/tooling/src/vortex-task-copy-db-acquia |
VORTEX_TASK_COPY_DB_ACQUIA_DST | Destination environment name to copy DB to. | UNDEFINED | .vortex/tooling/src/vortex-task-copy-db-acquia |
VORTEX_TASK_COPY_DB_ACQUIA_KEY | Acquia Cloud API key. | ${VORTEX_ACQUIA_KEY} | .vortex/tooling/src/vortex-task-copy-db-acquia |
VORTEX_TASK_COPY_DB_ACQUIA_NAME | Database name to copy. | UNDEFINED | .vortex/tooling/src/vortex-task-copy-db-acquia |
VORTEX_TASK_COPY_DB_ACQUIA_SECRET | Acquia Cloud API secret. | ${VORTEX_ACQUIA_SECRET} | .vortex/tooling/src/vortex-task-copy-db-acquia |
VORTEX_TASK_COPY_DB_ACQUIA_SKIP | Skip copying of database between Acquia environment. | UNDEFINED | ACQUIA ENVIRONMENT |
VORTEX_TASK_COPY_DB_ACQUIA_SRC | Source environment name to copy DB from. | UNDEFINED | .vortex/tooling/src/vortex-task-copy-db-acquia |
VORTEX_TASK_COPY_DB_ACQUIA_STATUS_INTERVAL | Interval in seconds to check task status. | 10 | .vortex/tooling/src/vortex-task-copy-db-acquia |
VORTEX_TASK_COPY_DB_ACQUIA_STATUS_RETRIES | Number of status retrieval retries. If this limit reached and task has not yet finished, the task is considered failed. | 600 | .vortex/tooling/src/vortex-task-copy-db-acquia |
VORTEX_TASK_COPY_FILES_ACQUIA_APP_NAME | Application name. Used to discover UUID. | ${VORTEX_ACQUIA_APP_NAME} | .vortex/tooling/src/vortex-task-copy-files-acquia |
VORTEX_TASK_COPY_FILES_ACQUIA_DST | Destination environment name to copy to. | UNDEFINED | .vortex/tooling/src/vortex-task-copy-files-acquia |
VORTEX_TASK_COPY_FILES_ACQUIA_KEY | Acquia Cloud API key. | ${VORTEX_ACQUIA_KEY} | .vortex/tooling/src/vortex-task-copy-files-acquia |
VORTEX_TASK_COPY_FILES_ACQUIA_SECRET | Acquia Cloud API secret. | ${VORTEX_ACQUIA_SECRET} | .vortex/tooling/src/vortex-task-copy-files-acquia |
VORTEX_TASK_COPY_FILES_ACQUIA_SKIP | Skip copying of files between Acquia environment. | UNDEFINED | ACQUIA ENVIRONMENT |
VORTEX_TASK_COPY_FILES_ACQUIA_SRC | Source environment name to copy from. | UNDEFINED | .vortex/tooling/src/vortex-task-copy-files-acquia |
VORTEX_TASK_COPY_FILES_ACQUIA_STATUS_INTERVAL | Interval in seconds to check task status. | 10 | .vortex/tooling/src/vortex-task-copy-files-acquia |
VORTEX_TASK_COPY_FILES_ACQUIA_STATUS_RETRIES | Number of status retrieval retries. If this limit reached and task has not yet finished, the task is considered failed. | 600 | .vortex/tooling/src/vortex-task-copy-files-acquia |
VORTEX_TASK_CUSTOM_LAGOON_BRANCH | The Lagoon branch to run the task on. | UNDEFINED | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_CLI_FORCE_INSTALL | Flag to force the installation of Lagoon CLI. | UNDEFINED | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_CLI_PATH | Location of the Lagoon CLI binary. | /tmp | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_CLI_VERSION | Lagoon CLI version to use. | v0.32.0 | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_COMMAND | The task command to execute. | UNDEFINED | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_INSTANCE | The Lagoon instance name to interact with. | amazeeio | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_INSTANCE_GRAPHQL | The Lagoon instance GraphQL endpoint to interact with. | https://api.lagoon.amazeeio.cloud/graphql | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_INSTANCE_HOSTNAME | The Lagoon instance hostname to interact with. | ssh.lagoon.amazeeio.cloud | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_INSTANCE_PORT | The Lagoon instance port to interact with. | 32222 | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_NAME | The task name. | Automation task | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_PROJECT | The Lagoon project to run tasks for. | ${LAGOON_PROJECT} | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_SSH_FILE | Default SSH file used if custom fingerprint is not provided. | ${HOME}/.ssh/id_rsa | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_CUSTOM_LAGOON_SSH_FINGERPRINT | SSH key fingerprint used to connect to a remote. | UNDEFINED | .vortex/tooling/src/vortex-task-custom-lagoon |
VORTEX_TASK_PLATFORM | Hosting platform to run the operation for. | ${VORTEX_PLATFORM} | .vortex/tooling/src/vortex-task |
VORTEX_TASK_PURGE_CACHE_ACQUIA_APP_NAME | Application name. Used to discover UUID. | ${VORTEX_ACQUIA_APP_NAME} | .vortex/tooling/src/vortex-task-purge-cache-acquia |
VORTEX_TASK_PURGE_CACHE_ACQUIA_DOMAINS_FILE | File with a list of domains that should be purged. | domains.txt | .vortex/tooling/src/vortex-task-purge-cache-acquia |
VORTEX_TASK_PURGE_CACHE_ACQUIA_ENV | An environment name to purge cache for. | UNDEFINED | .vortex/tooling/src/vortex-task-purge-cache-acquia |
VORTEX_TASK_PURGE_CACHE_ACQUIA_KEY | Acquia Cloud API key. | ${VORTEX_ACQUIA_KEY} | .vortex/tooling/src/vortex-task-purge-cache-acquia |
VORTEX_TASK_PURGE_CACHE_ACQUIA_SECRET | Acquia Cloud API secret. | ${VORTEX_ACQUIA_SECRET} | .vortex/tooling/src/vortex-task-purge-cache-acquia |
VORTEX_TASK_PURGE_CACHE_ACQUIA_STATUS_INTERVAL | Interval in seconds to check task status. | 10 | .vortex/tooling/src/vortex-task-purge-cache-acquia |
VORTEX_TASK_PURGE_CACHE_ACQUIA_STATUS_RETRIES | Number of status retrieval retries. If this limit reached and task has not yet finished, the task is considered failed. | 600 | .vortex/tooling/src/vortex-task-purge-cache-acquia |
VORTEX_UNBLOCK_ADMIN | Unblock admin account when logging in. | 1 | .env |
WEBROOT | Name of the web root directory containing a Drupal codebase. | web | .env, .vortex/tooling/src/vortex-fetch-db-lagoon, .vortex/tooling/src/vortex-info, .vortex/tooling/src/vortex-provision, .vortex/tooling/src/vortex-reset |
Variable list generated with Shellvar - Utility to work with shell variables