migration.ini [TriggerSettings] #

The block [TriggerSettings] of settings/migration.ini, with 8 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).

Trigger #

The signed HTTP trigger: a source installation that reaches this one by FTP only runs the migrations here through
the view migration/trigger (POST, JSON). Each request is signed with HMAC-SHA256 with the secret Secret names, used
once (its nonce), valid for Lifetime seconds, and only taken from AllowedAddresses[]. Guide:
doc/eng-us/guides/migrations-remote-deploy.md ("FTP remotes with the HTTP trigger")

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[TriggerSettings]
Trigger=disabled
*/ ?>

Secret #

The secret the requests are signed with: a name of the secret store (Setup > Secrets) or env:VARIABLE, at least 16
characters; the source's TriggerSecret holds the same value. Never the secret itself.

Default: empty.

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

AllowedAddresses #

The addresses (or CIDR ranges, 192.0.2.0/24, 2001:db8::/32) the source connects from. Empty: no request is taken.

Default: an empty list.

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

Lifetime #

Seconds a signature is valid after it was issued.

Default: 300.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[TriggerSettings]
Lifetime=300
*/ ?>

MaxRequestsPerMinute #

At most this many requests a minute (429 above).

Default: 30.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[TriggerSettings]
MaxRequestsPerMinute=30
*/ ?>

Php #

The PHP CLI that runs the console scripts, and how many seconds one may take.

Default: php.

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

Timeout #

Default: 900.

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

AllowRootUser #

enabled: the console scripts run with --allow-root-user (only when the web server's PHP runs as root).

Default: disabled.

<?php /* #?ini charset="utf-8"?
# settings/override/migration.ini.append.php
[TriggerSettings]
AllowRootUser=disabled
*/ ?>

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.