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 [LayoutSettings]

The settings of [LayoutSettings] in velocity.ini: ConfDir, StateDir, SiteName

Download as PDF

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

On this page

velocity.ini [LayoutSettings]

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

ConfDir

Where the server's configuration lives, laid out like Debian's /etc/apache2
(see doc/eng-us/bc/6.0/velocity-ondisk-layout.md):
vc.conf, ports.conf, envvars
mods-available/ -> mods-enabled/ engine modules
conf-available/ -> conf-enabled/ shared snippets
sites-available/ -> sites-enabled/ one file per installation
Written from these settings on every start and used when, merged the way
the server merges, it is exactly the configuration generated -- otherwise
the single file var/tmp/velocity-server.json is used, as before.

auto /etc/vc if it exists or can be created, else an existing
/etc/qbix, else var/vc/qbix/etc in this installation (default)
disabled the single file only
<path> that directory

Default: auto.

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

StateDir

Extended information about each site (root, paths, when it was migrated):
/var/lib/vc when the configuration is in /etc/vc, else var/vc/qbix/lib.

Default: auto.

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

SiteName

This installation's name in sites-available; default: the host of
site.ini [SiteSettings] SiteURL.

Default: empty.

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

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