Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .vortex/docs/content/development/variables.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -387,6 +387,7 @@ The list below is automatically generated with [Shellvar](https://github.com/ale
| <a id="vortex_notify_webhook_url"></a>`VORTEX_NOTIFY_WEBHOOK_URL` | Webhook URL to send notifications to. | `UNDEFINED` | `.env`, `scripts/vortex/notify-webhook.sh`, `ACQUIA ENVIRONMENT`, `LAGOON ENVIRONMENT` |
| <a id="vortex_project"></a>`VORTEX_PROJECT` | Project name.<br/><br/>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`](#compose_project_name). | `your_site` | `.env`, `scripts/vortex/info.sh` |
| <a id="vortex_provision_acquia_skip"></a>`VORTEX_PROVISION_ACQUIA_SKIP` | Skip Drupal site provisioning in Acquia environment. | `UNDEFINED` | `ACQUIA ENVIRONMENT` |
| <a id="vortex_provision_cache_rebuild_after_db_update_skip"></a>`VORTEX_PROVISION_CACHE_REBUILD_AFTER_DB_UPDATE_SKIP` | Skip cache rebuild after database updates. | `0` | `scripts/vortex/provision.sh` |
| <a id="vortex_provision_db"></a>`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` |
| <a id="vortex_provision_db_dir"></a>`VORTEX_PROVISION_DB_DIR` | Directory with database dump file. | `./.data` | `scripts/vortex/provision.sh` |
| <a id="vortex_provision_db_file"></a>`VORTEX_PROVISION_DB_FILE` | Database dump file name. | `db.sql` | `scripts/vortex/provision.sh` |
Expand Down
9 changes: 6 additions & 3 deletions .vortex/docs/content/drupal/provision.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -136,13 +136,15 @@ section.
⑦ 💡 Verify config unchanged? ──Config changed──► 🏁 EXIT 1 (fail) ✗
│ Config unchanged (or check disabled)
⑧ 🧹 Rebuild caches after DB updates (skippable)
⬇️ Import configuration (if config files present)
🧹 Rebuild caches
🔄 Run deployment hooks
😷 Run DB sanitization
😷 Run DB sanitization
⚙️ Run custom scripts
Expand All @@ -158,11 +160,12 @@ You can control the provisioning flow using the following environment variables:
1. `VORTEX_PROVISION_SKIP=1`<br/>Kill-switch to completely skip provisioning. The script will exit immediately after start. Useful in emergencies when any kind of automation needs to be disabled.<br/><br/>
2. `VORTEX_PROVISION_TYPE=profile`<br/>Install from a Drupal `profile` instead of importing from a `database` dump. Useful for building sites without the persistent DB and/or test profile configuration installation.<br/><br/>
3. `VORTEX_PROVISION_OVERRIDE_DB=1`<br/>Drop an existing database before importing from dump/installing from profile. This is useful when an already provisioned environment requires a fresh database to be imported.<br/><br/>
4. `VORTEX_PROVISION_FALLBACK_TO_PROFILE=1`<br/>Automatically fall back to installing from profile if the database dump file or container image is not available. Useful for distribution demos or when using recipes/profiles that can install without a pre-existing database.<br/><br/>
4. `VORTEX_PROVISION_FALLBACK_TO_PROFILE=1`<br/>Automatically fall back to installing from profile if the database dump file or container image is not available. The site is installed from the configured profile, the Shield module is enabled to protect the environment, and all post-provision operations (configuration import, database updates, deployment hooks, etc.) are skipped. This provides a minimal working Drupal site when no database is available.<br/><br/>
5. `VORTEX_PROVISION_POST_OPERATIONS_SKIP=1`<br/>Skip configuration imports, database updates, and other post-provisioning steps. Essentially, this is `drush sql:drop` and `$(drush sql:connect) < .data/db.sql` commands. This is useful when you want to provision a site without running any additional operations.<br/>`ahoy import-db` uses this flag to import DB and exit.<br/><br/>
6. `VORTEX_PROVISION_USE_MAINTENANCE_MODE=1`<br/>Enable maintenance mode right after the site is bootstrappable and disable it at the end. Useful when you want to prevent users from accessing the site while it is being provisioned.<br/><br/>
7. `VORTEX_PROVISION_VERIFY_CONFIG_UNCHANGED_AFTER_UPDATE=1`<br/>Verify that active configuration was not changed by database updates. When enabled and config files are present, the provision will fail if `drush updatedb` modifies active configuration, preventing `drush config:import` from silently overwriting those changes.<br/><br/>
8. `VORTEX_PROVISION_SANITIZE_DB_SKIP=1`<br/>Disable database sanitization.
8. `VORTEX_PROVISION_CACHE_REBUILD_AFTER_DB_UPDATE_SKIP=1`<br/>Skip the cache rebuild that runs between database updates and configuration import. By default, caches are rebuilt after `drush updatedb` to ensure a clean state before importing configuration.<br/><br/>
9. `VORTEX_PROVISION_SANITIZE_DB_SKIP=1`<br/>Disable database sanitization.

:::tip

Expand Down
Loading
Loading