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

velocity.ini [LogSettings]

The settings of [LogSettings] in velocity.ini: Enabled, Dir, AccessName, ErrorName, Format, FileMode, DirMode

Download as PDF

Address: https://doc.exponential.earth/exphelp/viewer/examples/ini-settings/velocity/LogSettings.md

On this page

velocity.ini [LogSettings]

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

Enabled

The server's own access and error log, one line per request and one per
fault. LogFile above is only what the process prints to the console.

On, because without it the server writes nothing at all: no access log,
no error log, no record of a single request.

Default: enabled.

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

Dir

The qbix engine's log directory; relative paths resolve against the
installation root. Everything Velocity writes for one server is kept
together below var/vc/<engine>/: log/ (the frankenphp engine's is
[FrankenPHPSettings] LogDir, the php engine's [PHPServerSettings] LogFile),
run/ (pid file, console output, generated configuration, admin socket), and
for qbix the configuration tree etc/ and lib/, for frankenphp bin/, tls/ and
caddy/. Until 2026-09 this was var/log/qbix; an installation that sets Dir
keeps its own.

Default: var/vc/qbix/log.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[LogSettings]
Dir=var/vc/qbix/log
*/ ?>

AccessName

The file names. Empty names them after the default siteaccess
([SiteSettings] DefaultAccess in site.ini): site-access.log and
site-error.log for a siteaccess called "site", which keeps several
installations apart in one directory. Rotation puts the date in front of
the extension, so site-access.log becomes site-access.2026-09-24.log.

Default: empty.

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

ErrorName

Default: empty.

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

Format

The access line.

combined what Apache and nginx write, for tools that read those. The
default here.
qbix combined, plus the time the response took. The server's own
default.
common combined without referrer and user agent.

Anything else is taken as a format string, with %{Host}i and the like.

Default: combined.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[LogSettings]
Format=combined
*/ ?>

FileMode

Permissions of the log files, octal. Empty leaves them to the umask. An
access log names the people who visited, so it is not for every account on
the machine to read.

Default: 0640.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[LogSettings]
FileMode=0640
*/ ?>

DirMode

Permissions of the log directory, octal, applied to one that already exists
as well. Empty leaves it to the umask, which in practice is 0755 -- anyone
could list the files, and 0640 on each of them hides only their contents.
0750 goes with 0640. For a group that shares the logs, 2770 with a FileMode
of 0660: the setgid bit passes the group on to new files, it does not give
the group write access. chmod needs ownership, so a directory another user
created keeps its mode, and the server says so on start.

Default: 0750.

<?php /* #?ini charset="utf-8"?
# settings/override/velocity.ini.append.php
[LogSettings]
DirMode=0750
*/ ?>

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.

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