Variables
Vortex uses environment variables to configure workflows 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.
Workflow Control Variables can be changed during the project lifecycle to alter workflow behavior. For example, changing how deployment behaves or skipping a certain code branch deployment within CI.
.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 workflows 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 workflows 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 workflows 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 |
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 |
DOCKER_CONFIG | Path to Docker configuration directory. | ${HOME}/.docker | scripts/vortex/login-container-registry.sh |
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_ENVIRONMENT | Override detected Drupal environment type. Used in the application to override the automatically detected environment type. | UNDEFINED | ENVIRONMENT |
DRUPAL_MAINTENANCE_THEME | Drupal maintenance theme name. | your_site_theme | .env |
DRUPAL_PRIVATE_FILES | Path to private files. | ${DRUPAL_PUBLIC_FILES}/private | docker-compose.yml |
DRUPAL_PROFILE | Drupal profile name. | standard | .env, scripts/vortex/provision.sh |
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_SHIELD_PRINT | Shield message. | Restricted access. | .env |
DRUPAL_SITE_EMAIL | Drupal site email. | webmaster@example.com | scripts/vortex/provision.sh, .env |
DRUPAL_SITE_NAME | Drupal site name. | Example site | scripts/vortex/provision.sh, .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 |
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, scripts/vortex/deploy-lagoon.sh, scripts/vortex/download-db-lagoon.sh |
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 |
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 |
TARGET_ENV_REMAP | Special variable to remap target env to the sub-domain prefix based on UI name. | ${target_env} | scripts/vortex/task-purge-cache-acquia.sh |
TZ | The timezone used within the containers. | UTC | .env |
VORTEX_ACQUIA_APP_NAME | Acquia application name. | UNDEFINED | .env, scripts/vortex/download-db-acquia.sh, scripts/vortex/task-copy-db-acquia.sh, scripts/vortex/task-copy-files-acquia.sh, scripts/vortex/task-purge-cache-acquia.sh |
VORTEX_ACQUIA_KEY | Acquia Cloud API key. | UNDEFINED | .env.local.example, scripts/vortex/download-db-acquia.sh, scripts/vortex/task-copy-db-acquia.sh, scripts/vortex/task-copy-files-acquia.sh, scripts/vortex/task-purge-cache-acquia.sh |
VORTEX_ACQUIA_SECRET | Acquia Cloud API secret. | UNDEFINED | .env.local.example, scripts/vortex/download-db-acquia.sh, scripts/vortex/task-copy-db-acquia.sh, scripts/vortex/task-copy-files-acquia.sh, scripts/vortex/task-purge-cache-acquia.sh |
VORTEX_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_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_NODEJS_LINT_IGNORE_FAILURE | Ignore NodeJS linters failures. | UNDEFINED | CI config |
VORTEX_CI_PHPCS_IGNORE_FAILURE | Ignore PHPCS failures. | UNDEFINED | CI config |
VORTEX_CI_PHPMD_IGNORE_FAILURE | Ignore PHPMD 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 | scripts/vortex/login-container-registry.sh, .env |
VORTEX_CONTAINER_REGISTRY_PASS | The password (token) to log into the container registry. | ${DOCKER_PASS} | .env.local.example, scripts/vortex/login-container-registry.sh |
VORTEX_CONTAINER_REGISTRY_USER | The username to log into the container registry. | ${DOCKER_USER} | .env.local.example, scripts/vortex/login-container-registry.sh |
VORTEX_DB_DIR | Database dump directory. The directory is used to store the database dump files for import and export. | ./.data | .env, scripts/vortex/download-db-acquia.sh, scripts/vortex/download-db-container-registry.sh, scripts/vortex/download-db-ftp.sh, scripts/vortex/download-db-lagoon.sh, scripts/vortex/download-db-url.sh, scripts/vortex/download-db.sh, scripts/vortex/provision.sh |
VORTEX_DB_DOWNLOAD_ACQUIA_BACKUP_MAX_WAIT | Maximum time in seconds to wait for backup completion. | 600 | scripts/vortex/download-db-acquia.sh |
VORTEX_DB_DOWNLOAD_ACQUIA_BACKUP_WAIT_INTERVAL | Interval in seconds to wait between backup status checks. | 10 | scripts/vortex/download-db-acquia.sh |
VORTEX_DB_DOWNLOAD_ACQUIA_DB_NAME | Acquia database name to download the database from. | your_site | .env, scripts/vortex/download-db-acquia.sh |
VORTEX_DB_DOWNLOAD_ENVIRONMENT | Environment to download the database from. Applies to hosting environments. Note that depending on the hosting provider, this variable may represent a branch name or an environment name. | prod | .env, scripts/vortex/download-db-acquia.sh, scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_FORCE | Always override existing downloaded DB dump. | 1 | .env.local.example, scripts/vortex/download-db.sh |
VORTEX_DB_DOWNLOAD_FRESH | Flag to download a fresh copy of the database by triggering a new backup. | UNDEFINED | scripts/vortex/download-db-acquia.sh, scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_FTP_FILE | Database dump FTP file name. | db.sql | .env, scripts/vortex/download-db-ftp.sh |
VORTEX_DB_DOWNLOAD_FTP_HOST | Database dump FTP host. | UNDEFINED | .env, scripts/vortex/download-db-ftp.sh |
VORTEX_DB_DOWNLOAD_FTP_PASS | Database dump FTP password. | UNDEFINED | .env.local.example, scripts/vortex/download-db-ftp.sh |
VORTEX_DB_DOWNLOAD_FTP_PORT | Database dump FTP port. | 21 | .env, scripts/vortex/download-db-ftp.sh |
VORTEX_DB_DOWNLOAD_FTP_USER | Database dump FTP user. | UNDEFINED | .env.local.example, scripts/vortex/download-db-ftp.sh |
VORTEX_DB_DOWNLOAD_LAGOON_REMOTE_DIR | Remote DB dump directory location. | /tmp | scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_LAGOON_REMOTE_FILE | Remote DB dump file name. Cached by the date suffix. | db_$(date +%Y%m%d).sql | scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_LAGOON_REMOTE_FILE_CLEANUP | Wildcard file name to cleanup previously created dump files. Cleanup runs only if the variable is set and $VORTEX_DB_DOWNLOAD_LAGOON_REMOTE_FILE does not exist. | db_*.sql | scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_LAGOON_SSH_HOST | The SSH host of the Lagoon environment. | ssh.lagoon.amazeeio.cloud | scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_LAGOON_SSH_PORT | The SSH port of the Lagoon environment. | 32222 | scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_LAGOON_SSH_USER | The SSH user of the Lagoon environment. | ${LAGOON_PROJECT}-${VORTEX_DB_DOWNLOAD_ENVIRONMENT} | scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_PROCEED | Proceed with download. | 1 | scripts/vortex/download-db.sh |
VORTEX_DB_DOWNLOAD_SOURCE | Database download source. | url | .env, scripts/vortex/download-db.sh |
VORTEX_DB_DOWNLOAD_SSH_FILE | Default SSH file used if custom fingerprint is not provided. | ${HOME}/.ssh/id_rsa | scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_SSH_FINGERPRINT | SSH key fingerprint used to connect to a remote. | UNDEFINED | scripts/vortex/download-db-lagoon.sh |
VORTEX_DB_DOWNLOAD_UNZIP_PASSWORD | Password for unzipping password-protected zip files. | UNDEFINED | scripts/vortex/download-db-url.sh |
VORTEX_DB_DOWNLOAD_URL | Database dump file sourced from a URL. HTTP Basic Authentication credentials should be embedded into the value. | UNDEFINED | .env, scripts/vortex/download-db-url.sh |
VORTEX_DB_EXPORT_CONTAINER_REGISTRY | Container registry name. | docker.io | scripts/vortex/export-db-image.sh |
VORTEX_DB_EXPORT_FILE_DIR | Directory with database dump file. | ./.data | scripts/vortex/export-db-file.sh |
VORTEX_DB_EXPORT_IMAGE | Container image to store in a form of <org>/<repository>. | UNDEFINED | scripts/vortex/export-db-image.sh, scripts/vortex/export-db.sh |
VORTEX_DB_EXPORT_IMAGE_ARCHIVE_FILE | Container image archive file name. | UNDEFINED | scripts/vortex/export-db-image.sh |
VORTEX_DB_EXPORT_IMAGE_DIR | Directory with database image archive file. | ${VORTEX_DB_DIR} | scripts/vortex/export-db-image.sh |
VORTEX_DB_EXPORT_SERVICE_NAME | The service name to capture. | database | scripts/vortex/export-db-image.sh |
VORTEX_DB_FILE | Database dump file name. The file is used to import the database into an empty database container. | db.sql | .env, scripts/vortex/download-db-acquia.sh, scripts/vortex/download-db-ftp.sh, scripts/vortex/download-db-lagoon.sh, scripts/vortex/download-db-url.sh, scripts/vortex/provision.sh |
VORTEX_DB_IMAGE | The container image containing database passed in a form of <org>/<repository>. | UNDEFINED | scripts/vortex/download-db-container-registry.sh, scripts/vortex/export-db.sh, scripts/vortex/info.sh, scripts/vortex/provision.sh, .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). | create | scripts/vortex/deploy-lagoon.sh, scripts/vortex/deploy.sh |
VORTEX_DEPLOY_ALLOW_SKIP | Flag to allow skipping of a deployment using additional flags. | UNDEFINED | scripts/vortex/deploy.sh, CI config |
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] | scripts/vortex/deploy-artifact.sh |
VORTEX_DEPLOY_ARTIFACT_GIT_REMOTE | Remote repository to push code to. | UNDEFINED | scripts/vortex/deploy-artifact.sh |
VORTEX_DEPLOY_ARTIFACT_GIT_USER_EMAIL | Name of the user who will be committing to a remote repository. | UNDEFINED | scripts/vortex/deploy-artifact.sh |
VORTEX_DEPLOY_ARTIFACT_GIT_USER_NAME | Email address of the user who will be committing to a remote repository. | Deployment Robot | scripts/vortex/deploy-artifact.sh |
VORTEX_DEPLOY_ARTIFACT_LOG | Deployment log file name. | ${VORTEX_DEPLOY_ARTIFACT_ROOT}/deployment_log.txt | scripts/vortex/deploy-artifact.sh |
VORTEX_DEPLOY_ARTIFACT_ROOT | The root directory where the deployment script should run from. Defaults to the current directory. | $(pwd) | scripts/vortex/deploy-artifact.sh |
VORTEX_DEPLOY_ARTIFACT_SRC | Source of the code to be used for artifact building. | UNDEFINED | scripts/vortex/deploy-artifact.sh |
VORTEX_DEPLOY_BRANCH | The Lagoon branch to deploy. | UNDEFINED | scripts/vortex/deploy-lagoon.sh, scripts/vortex/deploy.sh |
VORTEX_DEPLOY_CONTAINER_REGISTRY | Container registry name. Provide port, if required as <server_name>:<port>. | docker.io | scripts/vortex/deploy-container-registry.sh |
VORTEX_DEPLOY_CONTAINER_REGISTRY_IMAGE_TAG | The tag of the container image. | latest | scripts/vortex/deploy-container-registry.sh |
VORTEX_DEPLOY_CONTAINER_REGISTRY_MAP | Comma-separated map of container services and images to use for deployment in format "service1=org/image1,service2=org/image2". | UNDEFINED | scripts/vortex/deploy-container-registry.sh, scripts/vortex/export-db.sh |
VORTEX_DEPLOY_CONTAINER_REGISTRY_PASS | The password to login into the container registry. | ${VORTEX_CONTAINER_REGISTRY_PASS} | scripts/vortex/deploy-container-registry.sh |
VORTEX_DEPLOY_CONTAINER_REGISTRY_USER | The username to login into the container registry. | ${VORTEX_CONTAINER_REGISTRY_USER} | scripts/vortex/deploy-container-registry.sh |
VORTEX_DEPLOY_LAGOON_FAIL_ENV_LIMIT_EXCEEDED | Flag to control failure behavior when Lagoon environment limits are exceeded. When set to 0, the deployment will exit with success instead of failure. When set to 1, the deployment will fail. | 0 | scripts/vortex/deploy-lagoon.sh |
VORTEX_DEPLOY_LAGOON_INSTANCE | The Lagoon instance name to interact with. | amazeeio | scripts/vortex/deploy-lagoon.sh |
VORTEX_DEPLOY_LAGOON_INSTANCE_GRAPHQL | The Lagoon instance GraphQL endpoint to interact with. | https://api.lagoon.amazeeio.cloud/graphql | scripts/vortex/deploy-lagoon.sh |
VORTEX_DEPLOY_LAGOON_INSTANCE_HOSTNAME | The Lagoon instance hostname to interact with. | ssh.lagoon.amazeeio.cloud | scripts/vortex/deploy-lagoon.sh |
VORTEX_DEPLOY_LAGOON_INSTANCE_PORT | The Lagoon instance port to interact with. | 32222 | scripts/vortex/deploy-lagoon.sh |
VORTEX_DEPLOY_MODE | Deployment mode. Values can be one of: branch, tag. | branch | scripts/vortex/deploy.sh |
VORTEX_DEPLOY_PR | The PR number to deploy. | UNDEFINED | scripts/vortex/deploy-lagoon.sh, scripts/vortex/deploy.sh |
VORTEX_DEPLOY_PR_BASE_BRANCH | The PR base branch (the branch the PR is raised against). Defaults to 'develop'. | develop | scripts/vortex/deploy-lagoon.sh |
VORTEX_DEPLOY_PR_HEAD | The PR head branch to deploy. | UNDEFINED | scripts/vortex/deploy-lagoon.sh |
VORTEX_DEPLOY_SKIP | Skip all deployments. | UNDEFINED | CI config |
VORTEX_DEPLOY_SSH_FILE | Default SSH file used if custom fingerprint is not provided. | ${HOME}/.ssh/id_rsa | scripts/vortex/deploy-artifact.sh, scripts/vortex/deploy-lagoon.sh |
VORTEX_DEPLOY_SSH_FINGERPRINT | SSH key fingerprint used to connect to remote. | UNDEFINED | scripts/vortex/deploy-artifact.sh, scripts/vortex/deploy-lagoon.sh |
VORTEX_DEPLOY_TYPES | Deployment occurs when tests pass in the CI environment. @see https://www.vortextemplate.com/docs/workflows/deployment | artifact | .env, scripts/vortex/deploy.sh |
VORTEX_DEPLOY_WEBHOOK_METHOD | Webhook call method. | GET | scripts/vortex/deploy-webhook.sh |
VORTEX_DEPLOY_WEBHOOK_RESPONSE_STATUS | The status code of the expected response. | 200 | scripts/vortex/deploy-webhook.sh |
VORTEX_DEPLOY_WEBHOOK_URL | The URL of the webhook to call. | UNDEFINED | scripts/vortex/deploy-webhook.sh |
VORTEX_DOCTOR_CHECK_BOOTSTRAP | UNDEFINED | scripts/vortex/doctor.sh | |
VORTEX_DOCTOR_CHECK_CONTAINERS | 0 | scripts/vortex/doctor.sh | |
VORTEX_DOCTOR_CHECK_MINIMAL | Check minimal Doctor requirements. | 0 | scripts/vortex/doctor.sh |
VORTEX_DOCTOR_CHECK_PORT | UNDEFINED | scripts/vortex/doctor.sh | |
VORTEX_DOCTOR_CHECK_PYGMY | UNDEFINED | scripts/vortex/doctor.sh | |
VORTEX_DOCTOR_CHECK_SSH | UNDEFINED | scripts/vortex/doctor.sh | |
VORTEX_DOCTOR_CHECK_TOOLS | 1 | scripts/vortex/doctor.sh | |
VORTEX_DOCTOR_CHECK_WEBSERVER | UNDEFINED | scripts/vortex/doctor.sh | |
VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY | Container registry name. Provide port, if required as <server_name>:<port>. | docker.io | scripts/vortex/download-db-container-registry.sh |
VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_PASS | The password to login into the container registry. | ${VORTEX_CONTAINER_REGISTRY_PASS} | scripts/vortex/download-db-container-registry.sh |
VORTEX_DOWNLOAD_DB_CONTAINER_REGISTRY_USER | The username to login into the container registry. | ${VORTEX_CONTAINER_REGISTRY_USER} | scripts/vortex/download-db-container-registry.sh |
VORTEX_EXPORT_DB_CONTAINER_REGISTRY_DEPLOY_PROCEED | Proceed with container image deployment after it was exported. | UNDEFINED | CI config |
VORTEX_FRONTEND_BUILD_SKIP | Skip building of the frontend. | UNDEFINED | .env |
VORTEX_INSTALLER_INTERACTIVE | Run installer in interactive mode. | 0 | scripts/vortex/update-vortex.sh |
VORTEX_INSTALLER_PATH | The path to the installer script. If set, this will override the VORTEX_INSTALLER_URL. | UNDEFINED | scripts/vortex/update-vortex.sh |
VORTEX_INSTALLER_TEMPLATE_REPO | Vortex remote or local template repo URI, optionally including reference. Examples: https://github.com/drevops/vortex.git # Will auto-discover the latest stable tag from remote repo. https://github.com/drevops/vortex.git#stable # Will auto-discover the latest stable tag from remote repo. https://github.com/drevops/vortex.git#`1`.`2`.`3` # Will use specific release from remote repo. https://github.com/drevops/vortex.git#abcd123 # Will use specific commit from remote repo. file:///local/path/to/vortex.git # Will auto-discover the latest stable tag from local repo. file:///local/path/to/vortex.git#stable # Will auto-discover the latest stable tag from local repo. file:///local/path/to/vortex.git# 1.2.3 # Will use specific release from local repo. file:///local/path/to/vortex.git#abcd123 # Will use specific commit from local repo. /local/path/to/vortex.git # Will auto-discover the latest stable tag from local repo. /local/path/to/vortex.git#stable # Will auto-discover the latest stable tag from local repo. /local/path/to/vortex.git#1.2.3 # Will use specific release from local repo. /local/path/to/vortex.git#abcd123 # Will use specific commit from local repo. | https://github.com/drevops/vortex.git#stable | scripts/vortex/update-vortex.sh |
VORTEX_INSTALLER_URL | The URL of the installer script. | https://www.vortextemplate.com/install | scripts/vortex/update-vortex.sh |
VORTEX_INSTALLER_URL_CACHE_BUST | Cache busting parameter for the installer URL. | $(date +%s) | scripts/vortex/update-vortex.sh |
VORTEX_LAGOONCLI_FORCE_INSTALL | Flag to force the installation of Lagoon CLI. | UNDEFINED | scripts/vortex/deploy-lagoon.sh, scripts/vortex/task-custom-lagoon.sh |
VORTEX_LAGOONCLI_PATH | Location of the Lagoon CLI binary. | /tmp | scripts/vortex/deploy-lagoon.sh, scripts/vortex/task-custom-lagoon.sh |
VORTEX_LAGOONCLI_VERSION | Lagoon CLI version to use. | v0.32.0 | scripts/vortex/deploy-lagoon.sh, scripts/vortex/task-custom-lagoon.sh |
VORTEX_LAGOON_PRODUCTION_BRANCH | Dedicated branch to identify the production environment. | main | .env |
VORTEX_NOTIFY_BRANCH | Notification git branch name. | UNDEFINED | scripts/vortex/notify.sh |
VORTEX_NOTIFY_CHANNELS | The 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_URL | Email notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | scripts/vortex/notify-email.sh |
VORTEX_NOTIFY_EMAIL_EVENT | Email notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | scripts/vortex/notify-email.sh |
VORTEX_NOTIFY_EMAIL_FROM | An email address to send notifications from. Applies to email notifications. | webmaster@your-site-domain.example | .env, scripts/vortex/notify-email.sh |
VORTEX_NOTIFY_EMAIL_LABEL | Email notification deployment label (branch name, PR number, or custom identifier). | ${VORTEX_NOTIFY_LABEL} | scripts/vortex/notify-email.sh |
VORTEX_NOTIFY_EMAIL_LOGIN_URL | Email notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | scripts/vortex/notify-email.sh |
VORTEX_NOTIFY_EMAIL_MESSAGE | Email notification message template. Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url% | UNDEFINED | scripts/vortex/notify-email.sh |
VORTEX_NOTIFY_EMAIL_PROJECT | Email notification project name. | ${VORTEX_NOTIFY_PROJECT} | scripts/vortex/notify-email.sh |
VORTEX_NOTIFY_EMAIL_RECIPIENTS | Email address(es) to send notifications to. Applies to email notifications. Multiple names can be specified as a comma-separated list of email addresses with optional names in the format "email | name". Example: "to1@example.com | Jane Doe, to2@example.com |
VORTEX_NOTIFY_ENVIRONMENT_URL | Notification environment URL (where the site was deployed). | UNDEFINED | scripts/vortex/notify.sh |
VORTEX_NOTIFY_EVENT | Notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | scripts/vortex/notify.sh |
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} | scripts/vortex/notify-github.sh |
VORTEX_NOTIFY_GITHUB_ENVIRONMENT_TYPE | GitHub notification environment type: production, uat, dev, pr. Used as the 'environment' parameter in GitHub's Deployment API. | PR | scripts/vortex/notify-github.sh |
VORTEX_NOTIFY_GITHUB_ENVIRONMENT_URL | GitHub notification deployment environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | scripts/vortex/notify-github.sh |
VORTEX_NOTIFY_GITHUB_EVENT | GitHub notification event type. Can be 'pre_deployment' or 'post_deployment'. | ${VORTEX_NOTIFY_EVENT} | scripts/vortex/notify-github.sh |
VORTEX_NOTIFY_GITHUB_REPOSITORY | GitHub notification repository in owner/repo format. | UNDEFINED | scripts/vortex/notify-github.sh |
VORTEX_NOTIFY_GITHUB_TOKEN | GitHub notification personal access token. | ${GITHUB_TOKEN} | scripts/vortex/notify-github.sh, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT |
VORTEX_NOTIFY_JIRA_ASSIGNEE_EMAIL | JIRA notification assignee email address. If left empty - no assignment will be performed. | UNDEFINED | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_BRANCH | JIRA notification git branch name (used for issue extraction). | ${VORTEX_NOTIFY_BRANCH} | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_ENDPOINT | JIRA notification API endpoint. | https://jira.atlassian.com | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_ENVIRONMENT_URL | JIRA notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_EVENT | JIRA notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_LABEL | JIRA notification deployment label (human-readable identifier for display). | ${VORTEX_NOTIFY_LABEL} | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_LOGIN_URL | JIRA notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_MESSAGE | JIRA notification message template (will be converted to ADF format). Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url% | UNDEFINED | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_PROJECT | JIRA notification project name. | ${VORTEX_NOTIFY_PROJECT} | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_TOKEN | JIRA notification API token. @see https://www.vortextemplate.com/docs/workflows/notifications#jira | UNDEFINED | scripts/vortex/notify-jira.sh, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT |
VORTEX_NOTIFY_JIRA_TRANSITION | JIRA notification state to transition to. If left empty - no transition will be performed. | UNDEFINED | scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_JIRA_USER_EMAIL | JIRA user email address. | user@example.com | .env, scripts/vortex/notify-jira.sh |
VORTEX_NOTIFY_LABEL | Notification deployment label (human-readable identifier for display). | UNDEFINED | scripts/vortex/notify.sh |
VORTEX_NOTIFY_LOGIN_URL | Notification login URL (defaults to ENVIRONMENT_URL/user/login if not provided). | UNDEFINED | scripts/vortex/notify.sh |
VORTEX_NOTIFY_NEWRELIC_APIKEY | NewRelic API key, usually of type 'USER'. @see https://www.vortextemplate.com/docs/workflows/notifications#new-relic | UNDEFINED | ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT |
VORTEX_NOTIFY_NEWRELIC_APPID | New Relic notification application ID (auto-discovered if not provided). Will be discovered automatically from application name if not provided. | UNDEFINED | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_APP_NAME | New 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_CHANGELOG | New Relic notification deployment changelog. Defaults to the description. | UNDEFINED | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_DESCRIPTION | New Relic notification deployment description template. Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url% | UNDEFINED | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_ENDPOINT | New Relic notification API endpoint. | https://api.newrelic.com/v2 | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_ENVIRONMENT_URL | New Relic notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_EVENT | New Relic notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_LABEL | New Relic notification deployment label (human-readable identifier for display). | ${VORTEX_NOTIFY_LABEL} | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_LOGIN_URL | New Relic notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_PROJECT | New Relic notification project name. | ${VORTEX_NOTIFY_PROJECT} | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_REVISION | New Relic notification deployment revision. If not provided, will use SHA if available, otherwise auto-generated. | UNDEFINED | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_SHA | New Relic notification git commit SHA. | ${VORTEX_NOTIFY_SHA} | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_NEWRELIC_USER | New Relic notification user performing deployment. | Deployment robot | scripts/vortex/notify-newrelic.sh |
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/workflows/notifications#new-relic | ${NEWRELIC_USER_KEY} | scripts/vortex/notify-newrelic.sh |
VORTEX_NOTIFY_PROJECT | Notification project name. | ${VORTEX_PROJECT} | scripts/vortex/notify.sh |
VORTEX_NOTIFY_PR_NUMBER | Notification pull request number. | UNDEFINED | scripts/vortex/notify.sh |
VORTEX_NOTIFY_SHA | Notification git commit SHA. | UNDEFINED | scripts/vortex/notify.sh |
VORTEX_NOTIFY_SKIP | Notification skip flag. | UNDEFINED | scripts/vortex/notify.sh |
VORTEX_NOTIFY_SLACK_CHANNEL | Slack notification target channel (optional, overrides webhook default). Format: #channel-name or @username | UNDEFINED | scripts/vortex/notify-slack.sh |
VORTEX_NOTIFY_SLACK_ENVIRONMENT_URL | Slack notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | scripts/vortex/notify-slack.sh |
VORTEX_NOTIFY_SLACK_EVENT | Slack notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | scripts/vortex/notify-slack.sh |
VORTEX_NOTIFY_SLACK_ICON_EMOJI | Slack notification bot icon emoji (optional). | :rocket: | scripts/vortex/notify-slack.sh |
VORTEX_NOTIFY_SLACK_LABEL | Slack notification deployment label (branch name, PR number, or custom identifier). | ${VORTEX_NOTIFY_LABEL} | scripts/vortex/notify-slack.sh |
VORTEX_NOTIFY_SLACK_LOGIN_URL | Slack notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | scripts/vortex/notify-slack.sh |
VORTEX_NOTIFY_SLACK_MESSAGE | Slack notification message template (for fallback text). Available tokens: %project%, %label%, %timestamp%, %environment_url%, %login_url% | UNDEFINED | scripts/vortex/notify-slack.sh |
VORTEX_NOTIFY_SLACK_PROJECT | Slack notification project name. | ${VORTEX_NOTIFY_PROJECT} | scripts/vortex/notify-slack.sh |
VORTEX_NOTIFY_SLACK_USERNAME | Slack notification bot display name (optional). | Deployment Bot | scripts/vortex/notify-slack.sh |
VORTEX_NOTIFY_SLACK_WEBHOOK | Slack notification webhook URL. The incoming Webhook URL from your Slack app configuration. @see https://www.vortextemplate.com/docs/workflows/notifications#slack | UNDEFINED | scripts/vortex/notify-slack.sh, ACQUIA ENVIRONMENT, LAGOON ENVIRONMENT |
VORTEX_NOTIFY_WEBHOOK_ENVIRONMENT_URL | Webhook notification environment URL. | ${VORTEX_NOTIFY_ENVIRONMENT_URL} | scripts/vortex/notify-webhook.sh |
VORTEX_NOTIFY_WEBHOOK_EVENT | Webhook notification event type. Can be 'pre_deployment' or 'post_deployment'. | post_deployment | scripts/vortex/notify-webhook.sh |
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} | scripts/vortex/notify-webhook.sh |
VORTEX_NOTIFY_WEBHOOK_LOGIN_URL | Webhook notification login URL. | ${VORTEX_NOTIFY_LOGIN_URL} | scripts/vortex/notify-webhook.sh |
VORTEX_NOTIFY_WEBHOOK_METHOD | Webhook notification HTTP method like POST, GET, PUT. | POST | scripts/vortex/notify-webhook.sh |
VORTEX_NOTIFY_WEBHOOK_PAYLOAD | Webhook notification JSON payload. Available tokens: %message%, %project%, %label%, %timestamp%, %environment_url%, %login_url% | UNDEFINED | scripts/vortex/notify-webhook.sh |
VORTEX_NOTIFY_WEBHOOK_PROJECT | Webhook notification project name. | ${VORTEX_NOTIFY_PROJECT} | scripts/vortex/notify-webhook.sh |
VORTEX_NOTIFY_WEBHOOK_RESPONSE_STATUS | Webhook notification expected HTTP status. | 200 | scripts/vortex/notify-webhook.sh |
VORTEX_NOTIFY_WEBHOOK_URL | Webhook URL to send notifications to. | UNDEFINED | .env, scripts/vortex/notify-webhook.sh, 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, scripts/vortex/info.sh |
VORTEX_PROVISION_ACQUIA_SKIP | Skip Drupal site provisioning in Acquia environment. | UNDEFINED | ACQUIA ENVIRONMENT |
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 | scripts/vortex/provision.sh |
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, scripts/vortex/provision.sh |
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 | scripts/vortex/provision.sh |
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 | scripts/vortex/provision-sanitize-db.sh |
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, scripts/vortex/provision-sanitize-db.sh |
VORTEX_PROVISION_SANITIZE_DB_PASSWORD | Database sanitized account password replacement. | ${RANDOM}${RANDOM}${RANDOM}${RANDOM} | scripts/vortex/provision-sanitize-db.sh, .env |
VORTEX_PROVISION_SANITIZE_DB_REPLACE_USERNAME_WITH_EMAIL | Replace username with mail. | 0 | scripts/vortex/provision-sanitize-db.sh, .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, scripts/vortex/provision.sh |
VORTEX_PROVISION_SCRIPTS_DIR | Directory with custom provision scripts. | ./scripts/custom | scripts/vortex/provision.sh |
VORTEX_PROVISION_SKIP | Flag to skip site provisioning. | UNDEFINED | scripts/vortex/provision.sh |
VORTEX_PROVISION_TYPE | Set to 'profile' to install a site from profile instead of the database dump. | database | .env, scripts/vortex/provision.sh |
VORTEX_PROVISION_USE_MAINTENANCE_MODE | Put the site into a maintenance mode during site provisioning. | 1 | .env, scripts/vortex/provision.sh |
VORTEX_PURGE_CACHE_ACQUIA_SKIP | Skip purging of edge cache in Acquia environment. | UNDEFINED | ACQUIA ENVIRONMENT |
VORTEX_RELEASE_VERSION_SCHEME | Versioning scheme used for releases. Can be one of: calver, semver, other @see https://www.vortextemplate.com/docs/workflows/releasing | calver | .env |
VORTEX_SHOW_LOGIN | Show one-time login link. | UNDEFINED | scripts/vortex/info.sh |
VORTEX_SSH_DISABLE_STRICT_HOST_KEY_CHECKING | Disable strict host key checking in SSH. | 0 | scripts/vortex/setup-ssh.sh |
VORTEX_SSH_FILE | Default SSH key file. | ${HOME}/.ssh/id_rsa | scripts/vortex/doctor.sh |
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 | scripts/vortex/setup-ssh.sh |
VORTEX_SSH_REMOVE_ALL_KEYS | Remove all SSH keys from the SSH agent before loading the new one. | 0 | scripts/vortex/setup-ssh.sh |
VORTEX_TASK_COPY_DB_ACQUIA_DST | Destination environment name to copy DB to. | UNDEFINED | scripts/vortex/task-copy-db-acquia.sh |
VORTEX_TASK_COPY_DB_ACQUIA_NAME | Database name to copy. | UNDEFINED | scripts/vortex/task-copy-db-acquia.sh |
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 | scripts/vortex/task-copy-db-acquia.sh |
VORTEX_TASK_COPY_DB_ACQUIA_STATUS_INTERVAL | Interval in seconds to check task status. | 10 | scripts/vortex/task-copy-db-acquia.sh |
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 | scripts/vortex/task-copy-db-acquia.sh |
VORTEX_TASK_COPY_FILES_ACQUIA_DST | Destination environment name to copy to. | UNDEFINED | scripts/vortex/task-copy-files-acquia.sh |
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 | scripts/vortex/task-copy-files-acquia.sh |
VORTEX_TASK_COPY_FILES_ACQUIA_STATUS_INTERVAL | Interval in seconds to check task status. | 10 | scripts/vortex/task-copy-files-acquia.sh |
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. | 300 | scripts/vortex/task-copy-files-acquia.sh |
VORTEX_TASK_LAGOON_BRANCH | The Lagoon branch to run the task on. | UNDEFINED | scripts/vortex/task-custom-lagoon.sh |
VORTEX_TASK_LAGOON_COMMAND | The task command to execute. | UNDEFINED | scripts/vortex/task-custom-lagoon.sh |
VORTEX_TASK_LAGOON_INSTANCE | The Lagoon instance name to interact with. | amazeeio | scripts/vortex/task-custom-lagoon.sh |
VORTEX_TASK_LAGOON_INSTANCE_GRAPHQL | The Lagoon instance GraphQL endpoint to interact with. | https://api.lagoon.amazeeio.cloud/graphql | scripts/vortex/task-custom-lagoon.sh |
VORTEX_TASK_LAGOON_INSTANCE_HOSTNAME | The Lagoon instance hostname to interact with. | ssh.lagoon.amazeeio.cloud | scripts/vortex/task-custom-lagoon.sh |
VORTEX_TASK_LAGOON_INSTANCE_PORT | The Lagoon instance port to interact with. | 32222 | scripts/vortex/task-custom-lagoon.sh |
VORTEX_TASK_LAGOON_NAME | The task name. | Automation task | scripts/vortex/task-custom-lagoon.sh |
VORTEX_TASK_LAGOON_PROJECT | The Lagoon project to run tasks for. | ${LAGOON_PROJECT} | scripts/vortex/task-custom-lagoon.sh |
VORTEX_TASK_PURGE_CACHE_ACQUIA_DOMAINS_FILE | File with a list of domains that should be purged. | domains.txt | scripts/vortex/task-purge-cache-acquia.sh |
VORTEX_TASK_PURGE_CACHE_ACQUIA_ENV | An environment name to purge cache for. | UNDEFINED | scripts/vortex/task-purge-cache-acquia.sh |
VORTEX_TASK_PURGE_CACHE_ACQUIA_STATUS_INTERVAL | Interval in seconds to check task status. | 10 | scripts/vortex/task-purge-cache-acquia.sh |
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. | 300 | scripts/vortex/task-purge-cache-acquia.sh |
VORTEX_TASK_SSH_FILE | Default SSH file used if custom fingerprint is not provided. | ${HOME}/.ssh/id_rsa | scripts/vortex/task-custom-lagoon.sh |
VORTEX_TASK_SSH_FINGERPRINT | SSH key fingerprint used to connect to a remote. | UNDEFINED | scripts/vortex/task-custom-lagoon.sh |
VORTEX_UNBLOCK_ADMIN | Flag to unblock admin. | 1 | scripts/vortex/login.sh, scripts/vortex/logout.sh, .env |
WEBROOT | Name 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