velocity.ini [CacheSettings]
The block [CacheSettings] of settings/velocity.ini, with 15 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.phpfor every siteaccess,settings/siteaccess/<siteaccess>/velocity.ini.append.phpfor one siteaccess,extension/<extension>/settings/velocity.ini.append.phpin an extension (read when the extension is active).
Enabled
The server's response cache, in front of the workers. A hit is answered by
the parent process -- no fork, no PHP, no database. Measured on this
installation, anonymous front page: about 3,500 req/s from the cache
against 27 rendered.The settings further down that used to live in [ServerSettings] as
CacheSkipCookies, CacheStaleWhileRevalidate, CacheNotFoundSeconds,
MinifyCachedHtml and MiddleOutCompression still work there; a value here
wins.Needs qbix-webserver v0.0.4.26 or later: older versions matched the session
cookie by its exact name, never recognised eZSESSID<digest>, and served a
signed-in visitor's pages to everybody.
Default: enabled.
# settings/override/velocity.ini.append.php
[CacheSettings]
Enabled=enabled
*/ ?>DefaultTtl
Seconds an anonymous page is kept. Exponential sends
Cache-Control: no-cache, must-revalidate, which the server does not treat as
a refusal, so a page is stored only when it has a lifetime -- its own
max-age, or this. 0 caches only responses that bring their own.The trade: a visitor may see a page up to this old, and a page that differs
between anonymous visitors without a cookie telling them apart would be
shared between them. Signed-in visitors are never served from the cache.
Default: 30.
# settings/override/velocity.ini.append.php
[CacheSettings]
DefaultTtl=30
*/ ?>Dir
Where entries too large for shared memory are kept. Relative paths resolve
against the installation root. Left to itself the server would put them in
files/cache/reverse of the directory above the document root.
Default: var/cache/qbix-reverse.
# settings/override/velocity.ini.append.php
[CacheSettings]
Dir=var/cache/qbix-reverse
*/ ?>APCu
Small responses in APCu, shared by every worker; larger ones on disk.
APCuMaxSize is the size limit in bytes, 0 leaves the server's 65536.
Default: enabled.
# settings/override/velocity.ini.append.php
[CacheSettings]
APCu=enabled
*/ ?>APCuMaxSize
Default: 0.
# settings/override/velocity.ini.append.php
[CacheSettings]
APCuMaxSize=0
*/ ?>SweepEvery
Clearing expired entries off the disk, every SweepEvery seconds (0 switches
it off). SweepMaxAge removes anything older than that regardless of its own
lifetime -- without it, a response that says max-age=31536000 stays a year.
Default: 300.
# settings/override/velocity.ini.append.php
[CacheSettings]
SweepEvery=300
*/ ?>SweepMaxAge
Default: 86400.
# settings/override/velocity.ini.append.php
[CacheSettings]
SweepMaxAge=86400
*/ ?>FileMode
Permissions, octal, as in [LogSettings]. A cached page is what an anonymous
visitor sees, but nothing else on the machine needs to read it.
Default: 0640.
# settings/override/velocity.ini.append.php
[CacheSettings]
FileMode=0640
*/ ?>DirMode
Default: 0750.
# settings/override/velocity.ini.append.php
[CacheSettings]
DirMode=0750
*/ ?>SkipCookies
Which cookies mean "this response is personal, do not cache it", matched as
a prefix. Empty means the session cookie plus is_logged_in, which the kernel
sets for signed-in visitors for exactly this purpose. The session cookie's
name follows [Session] SessionNameHandler in site.ini: with "default" PHP
names it (PHPSESSID); with "custom" it is SessionNamePrefix, which as a
prefix also covers every siteaccess's <prefix><digest>.To name them yourself, list every one -- a list replaces the default:
SkipCookies[]
SkipCookies[]=PHPSESSID
SkipCookies[]=is_logged_in
Default: empty.
# settings/override/velocity.ini.append.php
[CacheSettings]
SkipCookies=
*/ ?>StaleWhileRevalidate
Seconds an expired page may still be served while one request renders the
replacement, so that an expiry does not send every visitor to PHP at once.
Default: 60.
# settings/override/velocity.ini.append.php
[CacheSettings]
StaleWhileRevalidate=60
*/ ?>NotFoundSeconds
Seconds a 404 is remembered, so a crawler walking dead links does not run the
full rendering path for each. 0 (the default) remembers none: every 404
reaches PHP, as under Apache, so 404.log and the request classifier
(security.log) see each one -- a 404 answered from the cache was seen once a
minute at most. A 404 the kernel marks private, no-store is never kept anyway.
Default: 0.
# settings/override/velocity.ini.append.php
[CacheSettings]
NotFoundSeconds=0
*/ ?>HonorRequestNoCache
A request carrying Cache-Control: no-cache (or Pragma: no-cache) is sent to
PHP instead of being answered from the cache, and the answer is stored again.
A browser's ordinary reload (max-age=0) is still answered from the cache.
Needs exponential-velocity with Q.web.cache.honorRequestNoCache; older
versions ignore it.
Default: enabled.
# settings/override/velocity.ini.append.php
[CacheSettings]
HonorRequestNoCache=enabled
*/ ?>MinifyHtml
Collapse the templates' indentation in stored pages: 27 % smaller documents.
Default: enabled.
# settings/override/velocity.ini.append.php
[CacheSettings]
MinifyHtml=enabled
*/ ?>MiddleOutCompression
Compress stored entries against a shared dictionary. Measured and left off:
entries are stored already gzipped, and a dictionary cannot shrink that.
Default: disabled.
# settings/override/velocity.ini.append.php
[CacheSettings]
MiddleOutCompression=disabled
*/ ?>Related
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.