Skip to the content
Documentation
Help Start
Reading in:
  • German: 9,059 of 9,059 pages
About the help in other languages
All help pages

migration.ini [AdminSettings]

The settings of [AdminSettings] in migration.ini: PhpCliPath, JobHistory, Background, QueueJobType, LogBytes

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/ini-settings/migration/AdminSettings.md

On this page

migration.ini [AdminSettings]

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

PhpCliPath

Setup > Migrations (module migration) starts a run or a rollback as a console process of its own, which goes on when
the page is closed; its files are in var/<site>/migration/jobs/.

The php command line binary those processes run with. Empty: cronjob.ini [AdminSettings] PhpCliPath, else the
usual places (the bin directory of this php, /usr/bin/php, /usr/local/bin/php). Never the php-fpm binary.

Default: empty.

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

JobHistory

How many runs started there keep their files (the newest ones; a run going on is always kept).

Default: 50.

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

Background

How a run started there goes to the background:
process a console process of its own, started at once (the default)
queue a job of expqueue (the extension), run by its worker, when expqueue is active, its tables are installed,
expqueue.ini has the job type below and a worker is running; else a process as above
The job type, in the site's expqueue.ini.append.php:
[JobType_migration.run]
Handler=expMigrationQueueHandler
Class=bulk
Timeout=86400
Description=A migration run started in Setup > Migrations

Default: process.

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

QueueJobType

The expqueue job type of Background=queue.

Default: migration.run.

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

LogBytes

How much of the end of a run log a page shows, in bytes.

Default: 262144.

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

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.

Something wrong on this page? Report an error

Documentation license

This documentation is free documentation, licensed under the GNU Free Documentation License 1.3 or later.

Exponential Copyright © 1998-2026 Exponential Foundation and 7x