velocity.ini [ControlSettings] #

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

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

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

StopTimeout #

How long stop and restart wait for a graceful stop. The qbix engine's
processes still there after it -- every process of this installation, found
by the script it runs and the log it writes to, not only the pid files --
are then killed (SIGKILL), and restart reports success only once a new
server answers an HTTP request. The frankenphp and php engines report that
the server did not stop.

Default: 15.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[ControlSettings]
StopTimeout=15
*/ ?>

ShutdownTimeout #

The qbix server's own bound on a graceful stop (Q.webserver.shutdownTimeout):
after this many seconds it is killed with every process it started, even
when it is blocked where no signal but SIGKILL reaches it. Keep it below
StopTimeout. 0 leaves the stop unbounded.

Default: 12.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[ControlSettings]
ShutdownTimeout=12
*/ ?>

DetachedRestart #

restart (and the restart step of deploy) runs as one detached unit: its own
session (setsid) and, as root under systemd, a transient scope
vc-restart-<date>-<token>, so a caller killed between the stop and the start
no longer leaves the server down. The caller waits and prints the outcome as
before. While it runs, restart-in-progress.json lies next to the pid file.
disabled: restart in the calling process, as before.

Default: enabled.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[ControlSettings]
DetachedRestart=enabled
*/ ?>

ExtraOptions #

Extra options appended to the command line verbatim. The qbix engine only;
the frankenphp engine has [FrankenPHPSettings] ExtraOptions[].

Default: an empty list.

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

Related #

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

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