[InstallSettings]
Available since Exponential 6.0.15 (in development, not in a release yet).
Summary
The group [InstallSettings] of settings/migration.ini.
File
settings/migration.ini; override it in settings/override/migration.ini.append.php, in a siteaccess or in an extension.
Settings
| Setting | Default | Description |
|---|---|---|
| RunOnPackageInstall | enabled | Migrations shipped with a package (a directory migrations/ at the top of the package, next to its package.xml or package.json): installing the package (Setup > Packages, or a package the setup wizard or the kickstarter installs item by item) runs them once its items are installed, with ./console exp:migration:migrate --path=<the package's migrations> --apply as the user who installs it (the console: [RunSettings] RunAsUser). A migration that fails leaves the package not installed, so installing it again runs what is still pending. disabled: the package's migrations are not run; ./console exp:migration:migrate --apply runs them with the others. |
| RunOnKickstart | enabled | The kickstarter (php bin/php/kickstarter.php run --apply) runs every pending migration of the new installation (./console exp:migration:migrate --apply) after the sites are created, while maintenance mode is still on. disabled: it does not. |
| RunOptions[] | include-uncommitted; no-push | The options of exp:migration:migrate for these runs: no-caption, no-restore, no-commit, no-push, no-tag, include-uncommitted. Installing writes settings, design and extension files the run would otherwise refuse as changes that are not committed, and a new installation has nothing to push yet. |
| Timeout | 3600 | Seconds a run at installation may take before it is stopped (and reported as failed). |
See also
Generated example: migration.ini [InstallSettings]
Added to the reference for Exponential 6.0.15: the 4.x reference had no page for this group. The descriptions are the comment lines of settings/migration.ini.
Contributors
- Graham Brookins Updated
Comments
Add a comment