audit.ini [AuditArchiveSettings] #

The block [AuditArchiveSettings] of settings/audit.ini, with 5 setting(s).

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

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

ArchiveDir #

Where archives go: absolute, or relative to the site's var directory. Best on another
file system or a mount the web server cannot write (see the security notes).

Default: log/audit/archive.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditArchiveSettings]
ArchiveDir=log/audit/archive
*/ ?>

FormatHandlers #

Format handlers: name => class implementing expAuditFormatHandler (RAD survey registry
"auditformats"). A handler whose PHP extension or binary is missing reports itself
unavailable and the archive run falls back to gzip.
Built in.

Default: a hash of 5: gzip=expAuditGzipFormat, bzip2=expAuditBzip2Format, xz=expAuditXzFormat, zstd=expAuditZstdFormat, zip=expAuditZipFormat.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditArchiveSettings]
# an empty "FormatHandlers[]" first replaces the shipped list; without it the items are added
FormatHandlers[]
FormatHandlers[gzip]=expAuditGzipFormat
FormatHandlers[bzip2]=expAuditBzip2Format
FormatHandlers[xz]=expAuditXzFormat
FormatHandlers[zstd]=expAuditZstdFormat
FormatHandlers[zip]=expAuditZipFormat
*/ ?>

Level #

Compression level per handler (each handler's own range).

Default: a hash of 5: gzip=9, bzip2=9, xz=6, zstd=19, zip=9.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditArchiveSettings]
# an empty "Level[]" first replaces the shipped list; without it the items are added
Level[]
Level[gzip]=9
Level[bzip2]=9
Level[xz]=6
Level[zstd]=19
Level[zip]=9
*/ ?>

FileMode #

Mode of archive files and directories.

Default: 0440.

<?php /* #?ini charset="utf-8"?
# settings/override/audit.ini.append.php
[AuditArchiveSettings]
FileMode=0440
*/ ?>

DirMode #

Default: 0750.

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

Related #

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

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