Introduction
This article details the available configuration options for Cerberus.
Please note all configuration options are set in the AppSetting.Config file. No changes should ever be made to the App.Config file as this file may be change between versions.
Configuration Options
Database Configuration Options
MariaDB.ServerAddress
The IP address or fully qualified domain name of the MariaDB/MySQL database server. For reliability, we recommend using an IP address.
MariaDB.ServerPort
The TCP/IP port the MariaDB or MySQL server is listening on. By default, this is 3306
MariaDB.Username and MariaDB.Password
The credentials (username and password) of the database user account used to connect and read data from the MariaDB/MySQL database.
This user should have global privileges of SELECT, SHOW DATABASES, RELOAD, LOCK TABLES and SHOW VIEW
MariaDB.BackupTimes
The times at which backups are to be created in Comma Separate Values (CSV) format. You may enter either specific times and or wildcard hours:minute values.
Example 1: 12:35,*:40
Backup will run at 12:35 and every hour at 40 minutes past.
Example 2: 06:30,21:30
Backup will run at 06:30 (AM) and 21:30 (PM)
Example 3: *:00,*:05,*:10,*:15,*:20,*:25,*:30,*:35;*:40,*:45,*:50,*:55
Backup will run every five minutes.
MariaDB.ExcludedSchemas
Specific database names to exclude from the backups enter is Comma Separated Values (CSV) format.
Unless you need to back them up, it is recommended - and is default - to exclude the default databases.
Example 1: information_schema,mysql,performance_schema,sys
MariaDB.StoragePath
Full physical path to where backups should be stored. If the target path does not exist, Cerberus will automatically stop. Cerberus will not create the path.
MariaDB.CompressBackups
Whether to compress backup files. Depending on database content, this may result in the compressed files being upto 1/10th the size of the original mysqldump file. Works reliably with raw dump files of upto 2gb in size.
MariaDB.DaysToStore
The number of days backups are to be retained for. The backup process will automatically delete and detected backup files that are older than this data.
MySqlDump Configuration
These configuration options are used to configure the behaviour of mysqldump and the generated backup contents.
MySqlDump.Path
The filesystem path to the mysqldump.exe application. It is recommended that you use the version of mysqldump that corresponds to your MariaDB/MySql installation.
For Windows, this is typically found within $PATH_TO_MARIADB$\bin or the MySQL installation folder. For example: C:\Program Files\MariaDB 11.8\bin\mysqldump.exe
If your MariaDB\MySQL server is running on a non-Windows server, you need to obtain the corresponding mysqldump version from either MariaDB or MySQL.
If mysqldump is within the same folder as Cerberus, use ./mysqldump.exe
MySqlDump.ExtendedInsert
Whether to use extended inserts in the generated dump files. Default is FALSE.
Enabling this option will create larger database dump files, but will also provide more granular control when attempting to determine backup errors. If you have any concerns about the quality of data in your database, enable this option.
MySqlDump.RemoveConditionalExecutionTokens *EXPERIMENTAL*
Whether to remove conditional execution tokens from output. Default is FALSE.
These are the conditional comments often found with database dump files. These are intended to notify any importing application of the expected database server version required for a specific statement or command. An example of one of these statements are:
/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */
Some applications - for example SqlYog - often fail when importing database dumps containing conditional execution tokens. Enabling this option will strip these tokens from the database dump. If enabled, you should always perfom a test restore to ensure it is working correctly.
MySqlDump.SkipComments
Whether to skip comments in output. Default is FALSE.
MySqlDump.TimeOut
The number of seconds to wait before mysqldump is considered to have timed out or is considered not responding. Defaults to 300 or 5 minutes.
If individual database size is larger than 1GB, you may need to increase this value. The exact time taken for a backup or if a timeout occurs will be recorded in the Cerberus log.
MySqlDump.UseHexForBinary
Whether to use HEX data for BINARY or BLOB data. Default is TRUE.
Further Information
Some of these configuration options may be overridden with Cerberus Command Line Arguments.