migration.ini [InstallSettings] #

The block [InstallSettings] of settings/migration.ini, with 4 setting(s).

Never edit settings/migration.ini itself: an update replaces it. Put the settings you change in an override, which wins over the shipped file:

• settings/override/migration.ini.append.php for every siteaccess,
• settings/siteaccess/<siteaccess>/migration.ini.append.php for one siteaccess,
• extension/<extension>/settings/migration.ini.append.php in an extension (read when the extension is active).

RunOnPackageInstall #

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.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[InstallSettings]
RunOnPackageInstall=enabled
*/ ?>

RunOnKickstart #

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.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[InstallSettings]
RunOnKickstart=enabled
*/ ?>

RunOptions #

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.

Default: a list of 2: include-uncommitted, no-push.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[InstallSettings]
# an empty "RunOptions[]" first replaces the shipped list; without it the items are added
RunOptions[]
RunOptions[]=include-uncommitted
RunOptions[]=no-push
*/ ?>

Timeout #

Seconds a run at installation may take before it is stopped (and reported as failed).

Default: 3600.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[InstallSettings]
Timeout=3600
*/ ?>

Related #

• All blocks of migration.ini
• All INI files
• The settings page

Generated by ./console exp:help:examples from settings/migration.ini. Do not edit this page: change the source and generate again (how). Free documentation: GFDL 1.3 or later.