11# #
22# Project environment variables.
33#
4- # This is a single location where defined variables control how the stack
5- # operates and should be the primary place for modifications. Avoid overriding
4+ # This is a single location where variables control how the project stack
5+ # operates. It should be the primary place for modifications. Avoid overriding
66# values in scripts or configuration files to simplify future updates and
77# centralize changes.
88#
9- # Values must be scalar and cannot reference another variable.
10- # Do not enclose values in double quotes unless they include spaces.
9+ # A value must be scalar and cannot reference another variable.
10+ # Do not enclose a value in double quotes unless it includes spaces.
1111#
1212# To apply any changes made to this file, run `docker-compose up cli -d` or
1313# `ahoy up cli`.
1414#
15- # To customize variables locally, copy `.env.local.example` to `.env.local`.
15+ # To customize variables locally, copy `.env.local.example` to `.env.local`,
16+ # and add your custom values there.
1617#
1718# @see https://vortex.drevops.com/workflows/variables
1819
@@ -30,14 +31,14 @@ VORTEX_PROJECT=your_site
3031# Name of the web root directory containing a Drupal codebase.
3132WEBROOT = web
3233
33- # The timezone used in the containers.
34- TZ = " Australia/Melbourne "
34+ # The timezone used within the containers.
35+ TZ = " UTC "
3536
3637# ###############################################################################
3738# DRUPAL #
3839# ###############################################################################
3940
40- # Drupal profile name (used only when installing from profile) .
41+ # Drupal profile name.
4142DRUPAL_PROFILE = standard
4243
4344# ;< DRUPAL_THEME
@@ -82,7 +83,7 @@ DRUPAL_CLAMAV_MODE=daemon
8283# or fresh install from profile), running updates, appying configuration
8384# changes, clearing caches and performing other tasks that prepare the site for
8485# use.
85- # @see https://vortex.drevops.com/workflows /provision
86+ # @see https://vortex.drevops.com/drupal /provision
8687
8788# Set to 'profile' to install a site from profile instead of the database dump.
8889VORTEX_PROVISION_TYPE = database
@@ -98,12 +99,13 @@ VORTEX_PROVISION_OVERRIDE_DB=0
9899#
99100# Database sanitization is enabled by default in all non-production
100101# environments and is always skipped in the production environment.
102+ # @see https://vortex.drevops.com/drupal/provision#database-sanitization
101103VORTEX_PROVISION_SANITIZE_DB_SKIP = 0
102104
103105# Sanitization email pattern.
104106#
105107# Applied if database sanitization is enabled.
106- # @see https://vortex.drevops.com/workflows/build# sanitization
108+ # @see https://vortex.drevops.com/drupal/provision#database- sanitization
107109VORTEX_PROVISION_SANITIZE_DB_EMAIL = " user_%uid@your-site-domain.example"
108110
109111# Put the site into a maintenance mode during site provisioning.
@@ -129,36 +131,40 @@ VORTEX_ACQUIA_APP_NAME=
129131# ;> HOSTING
130132
131133# ###############################################################################
132- # DATABASE #
134+ # DATABASE SOURCE #
133135# ###############################################################################
134136
135137# Database service runs a single database within a container.
136- # See settings.php for database credentials defaults or run
137- # `ahoy drush sql:connect`.
138+ # See settings.php for database credentials or run # `ahoy drush sql:connect`.
138139
139140# Database can be imported from a *file dump* into an empty database started
140- # from the database default image or can *exist* in a pre-built container image.
141+ # from the database default container image or can *exist* in a pre-built
142+ # container image.
141143# Defaults to importing from a file.
142144# @see https://vortex.drevops.com/workflows/database
143145
144146# Database dump directory.
147+ #
148+ # The directory is used to store the database dump files for import and export.
145149VORTEX_DB_DIR = ./.data
146150
147151# Database dump file name.
152+ #
153+ # The file is used to import the database into an empty database container.
148154VORTEX_DB_FILE = db.sql
149155
150156# ;< !PROVISION_TYPE_PROFILE
151157# Database download source.
152158VORTEX_DB_DOWNLOAD_SOURCE = url
153159
154160# ;< DB_DOWNLOAD_SOURCE_CONTAINER_REGISTRY
155- # Name of the pre-built container image.
161+ # Name of the pre-built database container image.
156162# @see https://github.com/drevops/mariadb-drupal-data to seed your DB image.
157163# VORTEX_DB_IMAGE=your_org/your_site:latest
158164# ;> DB_DOWNLOAD_SOURCE_CONTAINER_REGISTRY
159165
160166# ;< DB_DOWNLOAD_SOURCE_URL
161- # Database dump file sourced from CURL .
167+ # Database dump file sourced from a URL .
162168#
163169# HTTP Basic Authentication credentials should be embedded into the value.
164170VORTEX_DB_DOWNLOAD_URL =
@@ -211,14 +217,18 @@ VORTEX_DEPLOY_TYPES=artifact
211217
212218# The channels of the notifications.
213219#
214- # Can be a combination of comma-separated values: email,newrelic,github,jira
220+ # A combination of comma-separated values: email,newrelic,github,jira
215221VORTEX_NOTIFY_CHANNELS = email
216222
217- # Email to send notifications from.
223+ # An email address to send notifications from.
224+ #
225+ # Applies to email notifications.
218226VORTEX_NOTIFY_EMAIL_FROM = " webmaster@your-site-domain.example"
219227
220228# Email address(es) to send notifications to.
221229#
230+ # Applies to email notifications.
231+ #
222232# Multiple names can be specified as a comma-separated list of email addresses
223233# with optional names in the format "email|name".
224234# Example: "to1@example.com|Jane Doe, to2@example.com|John Doe"
0 commit comments