Skip to main content

Provision

The provisioning process, handled by the provision.sh script, sets up a Drupal site by either restoring an existing database or installing a fresh instance using a profile, followed by running the necessary configuration import and database updates.

The main purpose of the script is to automate the setup of a Drupal site in every environment, ensuring consistency and eliminating manual steps.

Provisioning flow​

Customizing flow​

You can control the provisioning flow using the following environment variables:

VariableDescription
VORTEX_PROVISION_SKIP=1Kill-switch to skip provisioning entirely. Useful in emergencies when any kind of automation needs to be disabled.
VORTEX_PROVISION_TYPE=profileInstall from a Drupal profile instead of importing from a database dump.
VORTEX_PROVISION_OVERRIDE_DB=1Drop an existing database before importing from dump/installing from profile.
VORTEX_PROVISION_POST_OPERATIONS_SKIP=1Skip configuration imports, database updates, and other post-provisioning steps.
VORTEX_PROVISION_USE_MAINTENANCE_MODE=1Enable maintenance mode right after the site is bootstrappable and disable it at the end.
VORTEX_PROVISION_SANITIZE_DB_SKIP=1Disable database sanitization.

Maintenance mode​

During the provisioning process, you may want to enable maintenance mode to prevent users from accessing the site while it is being updated.

To enable maintenance mode, set the VORTEX_PROVISION_USE_MAINTENANCE_MODE=1 environment variable in your .env file to apply it globally or set it in your hosting provider's specific environment.

Database sanitization​

The provision.sh script includes a step to sanitize the database after provisioning. This step is essential for ensuring that sensitive data is not present in non-production environments.

warning

This step does not prevent developers from accessing sensitive data in the database dump directly. If your database has highly sensitive data, consider sanitizing the database dump before it can be downloaded.

To disable database sanitization, set the VORTEX_PROVISION_SANITIZE_DB_SKIP=1 in the .env file or in your hosting provider's specific environment.

Customizing database sanitization​

Use the following environment variables to customize the database sanitization:

VariableDefault valueDescription
VORTEX_PROVISION_SANITIZE_DB_EMAILuser_%uid@your-site-domain.exampleDatabase sanitized account email replacement.
VORTEX_PROVISION_SANITIZE_DB_PASSWORDRandomDatabase sanitized account password replacement.
VORTEX_PROVISION_SANITIZE_DB_REPLACE_USERNAME_WITH_EMAIL0 (disabled)Replace username with mail.
VORTEX_PROVISION_SANITIZE_DB_ADDITIONAL_FILE./scripts/sanitize.sqlPath to file with custom sanitization SQL queries.

Running custom scripts​

The provision.sh script can execute custom scripts or commands after the standard provisioning steps. This feature allows you to automate additional tasks specific to your project (migrations, conditionally enabling modules etc).

To run custom scripts, create a new file in the scripts/custom directory with the provision- prefix and the .sh extension. The script will be automatically sourced and executed after the standard provisioning steps. Make sure the script is executable: chmod +x scripts/custom/provision-10-example.sh.

It is recommended to use a 2-digit suffix to control the order of execution: e.g., provision-10-example.sh, provision-20-another-example.sh.

Expand below to see an example script scripts/custom/provision-10-example.sh script:

Example of a custom script
#!/usr/bin/env bash
##
# Example of the custom per-project command that will run after website is installed.
#
# Clone this file and modify it to your needs or simply remove it.
#
# For ordering multiple commands, use a two-digit suffix for clarity and consistency.
# This approach ensures a clear sequence and avoids potential ordering issues.
#
# Example:
# - provision-10-example.sh
# - provision-20-example.sh
# - provision-30-example.sh
#
# shellcheck disable=SC2086

set -eu
[ "${VORTEX_DEBUG-}" = "1" ] && set -x

# ------------------------------------------------------------------------------

drush() { ./vendor/bin/drush -y "$@"; }

# Perform operations based on the current environment.
if drush php:eval "print \Drupal\core\Site\Settings::get('environment');" | grep -q -e dev -e test -e ci -e local; then
  echo "==> Executing example operations in non-production environment."

  # Below are examples of running operations.

  # Set site name.
  drush php:eval "\Drupal::service('config.factory')->getEditable('system.site')->set('name', 'YOURSITE')->save();"

  # Enable contrib modules.
  drush pm:install admin_toolbar coffee config_split config_update media environment_indicator pathauto redirect shield stage_file_proxy

  #;< SERVICE_REDIS
  drush pm:install redis || true
  #;> SERVICE_REDIS

  #;< SERVICE_CLAMAV
  drush pm:install clamav
  drush config-set clamav.settings mode_daemon_tcpip.hostname clamav
  #;> SERVICE_CLAMAV

  #;< SERVICE_SOLR
  drush pm:install search_api search_api_solr
  #;> SERVICE_SOLR

  # Enable custom site module and run its deployment hooks.
  #
  # Note that deployment hooks for already enabled modules have run in the
  # parent "provision.sh" script.
  drush pm:install ys_core ys_search
  drush deploy:hook

  # Conditionally perform an action if this is a "fresh" database.
  if [ "${VORTEX_PROVISION_OVERRIDE_DB:-0}" = "1" ]; then
    echo "  > Fresh database detected. Performing additional example operations."
  else
    echo "  > Existing database detected. Performing additional example operations."
  fi

  echo "==> Finished executing example operations in non-production environment."
fi

Conditional execution​

You may choose to only perform an action based on a specific environment (the value of $settings['environment'] is populated by the Drupal settings file):

if drush php:eval "print \Drupal\core\Site\Settings::get('environment');" | grep -q -e dev -e ci -e local; then
  echo "==> Executing example operations in DEV, CI or Local environment."
fi

You may also conditionally perform an action based on whether the database is freshly imported or not:

if [ "${VORTEX_PROVISION_OVERRIDE_DB:-0}" = "1" ]; then
  echo "  > Fresh database detected."
else
  echo "  > Existing database detected."
fi