11. Archiver configuration settings

The following table describes configuration settings that apply to Kopano Archiver. When settings marked yes in column Required aren’t specified Archiver prints an error message and quits execution.

Table 10.1. Archiver settings

Setting	Type	Default	Required	Meaning and usage
server_socket	string		Yes	Location of server unix socket.
archive_enable	yes/no	yes	No	Setting this to no disables archiving.
archive_after	integer	30	No	Archive messages older than this number of days.
stub_enable	yes/no	no	No	Enables or disables stubbing.
stub_unread	yes/no	no	No	Enables or disables stubbing of unread messages.
stub_after	integer	0	No	Stub messages older than this number of days. When archive_after has a larger value than this setting, archive_after is used instead.
delete_enable	yes/no	no	No	Delete archived messages from the main store. Only archived messages can be deleted. Note that if this option is set to yes, no stubbing is performed.
delete_unread	yes/no	no	No	Enables or disables deleting unread archived messages from the main store.
delete_after	integer	0	No	Delete messages older than this number of days. When archive_after has a larger value than this setting, archive_after is used instead.
purge_enable	yes/no	no	No	Enables or disables purging of messages in the archive server(s).
purge_after	integer	2555 (7 years)	No	Purge messages older than this number of days. When archive_after has a larger value than this setting, archive_after is used instead.
cleanup_action	string	store	No	Specify what action should be taken on archive messages whose primary message has been deleted. Possible options are: store: the archived message in a special folder named Kopano Archive\Deleted` `; ``delete, delete the archived messages.
cleanup_follow_pur ge_after	yes/no	no	No	Specify that items that are cleaned up from the archive are at least the age that is specified in setting purge_after. This is to avoid messages being deleted from the archive when they were deleted from the primary store by a delete operation. Note that setting this to yes will cause a cleanup run to seemingly do nothing. A rule of thumb is to set this to the same value as delete_enable. So when delete_enable is set to yes, make sure cleanup_follow_purge_af ter is also set to yes.
enable_auto_attach	yes/no	no	No	Specify whether on each archive run an auto-attach run is performed in order to match the attached archives to the requested state as specified in LDAP or ADS.
auto_attach_writab le	yes/no	yes	No	Specify whether an auto attached archive will be granted write permissions for the user the arcive is attached to.
purge_soft_deleted	yes/no	no	No	Specify whether archiver must purge soft-deleted items before a clean-up run
log_method	string	file	No	Logging method, either syslog of file.
log_file	string		No	File name of log file when log_method = file, use “-” for stderr
log_level	integer	2	No	Log level (0 = no logging, 5 = full logging)
log_timestamp	integer	1	No	Log timestamp - prefix each log line with timestamp in file logging mode.
sslkey_file	string		Yes	Log in to Kopano server using this SSL Key.
sslkey_pass	string		Yes	Password of SSL Key.
pid_file	string	/var/run/z arafa-arch iver.pid	No	Name of control pid file.
mysql_host	string	localhost	No	MySQL hostname to connect to for database access.
mysql_port	string	3306	No	MySQL port to connect with (usually 3306).
mysql_user	string	root	No	Name of the user with which to connect to MySQL.
mysql_password	string		No	The password for mysql_user (leave empty for no password).
mysql_socket	string		No	Override the default MySQL socket to access mysql locally. Works only if the mysql_host value is empty or localhost.
mysql_database	string	kopano-arc hiver	No	Database to connect to.