-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathbackupbot.conf
114 lines (92 loc) · 5.73 KB
/
backupbot.conf
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
################################################################################
# Last updated on 01-12-2024
# This is the configuration file for backupbot.
#
# Backupbot automatically sources /usr/local/etc/backupbot.conf. Either copy
# this sample configuration file to that directory or create your own file.
#
# /usr/local/etc/backupbot.conf should be owned and readable by root (chmod 500).
################################################################################
################################################################################
# General settings
################################################################################
BACKUPBOT_LOG='/var/log/backupbot.log'
################################################################################
# Automatic backup
################################################################################
AUTOMATIC_BACKUP_ENABLE='NO' # NO (disable), YES (enable)
AUTOMATIC_BACKUP_HOURLY='0' # only for zfs, 0-59 where 0 is the whole hour
AUTOMATIC_BACKUP_DAILY='0' # 0-23 where 0 is 00:00 and 23 is 23:00
AUTOMATIC_BACKUP_WEEKLY='0' # 0 (disable), 1-7 where 1 is monday
RANDOM_DELAY='NO' # adds delay between 0-1 hours to automated backups
# Run 'backupbot --cron' to effectuate the changes to the schedule.
################################################################################
# Feature backup files
################################################################################
BACKUP_FILES_ENABLE='NO' # NO (disable), YES (enable)
BACKUP_FILES_DESTINATION='/var/tmp' # no trailing / at the end of folder name
BACKUP_FILES_RETENTION_DAILY='0' # number of days backups are kept, 0 for infinite
BACKUP_FILES_RETENTION_WEEKLY='0' # number of days backups are kept, 0 for infinite
BACKUP_FILES_COMPRESSION='0' # 0 (disable), 1 (gzip), 2 (bzip2), 3 (xz)*
BACKUP_FILES_ENCRYPTION='NO' # NO (disable), secret/passphrase (enable)
BACKUP_FILES_SPLIT='NO' # splits backup files, NO (disable), number in GB (enable)
BACKUP_FILES_OWNER='root' # sets the owner of file backups
BACKUP_FILES_GROUP='wheel' # sets the group of file backups
BACKUP_FILES_PERMISSIONS='640' # sets file permissions of file backups
# Note that all entries should be separated from each other with a space and that
# there should be no trailing / on the end of the folder names.
BACKUP_FILES='/etc /usr/local/etc /var/log /root /home'
# Optionally customize the variable part of the file name.
BACKUP_FILES_PREFIX="$(date +%y%m%dT%H%M%S)"
################################################################################
# Feature backup MySQL databases
################################################################################
# MySQL can authenticate unattended by creating a *.cnf file in /usr/local/etc/mysql
# with the following content (this is required for this feature to work):
# [client]
# user='root'
# password='password'
BACKUP_MYSQL_ENABLE='NO' # NO (disable), YES (enable)
BACKUP_MYSQL_DESTINATION='/var/tmp' # no trailing / at the end of folder name
BACKUP_MYSQL_RETENTION_DAILY='0' # number of days backups are kept, 0 for infinite
BACKUP_MYSQL_RETENTION_WEEKLY='0' # number of days backups are kept, 0 for infinite
BACKUP_MYSQL_COMPRESSION='0' # 0 (disable), 1 (gzip), 2 (bzip2), 3 (xz)*
BACKUP_MYSQL_ENCRYPTION='NO' # NO (disable), secret/passphrase (enable)
BACKUP_MYSQL_OWNER='root' # sets the owner of mysql backups
BACKUP_MYSQL_GROUP='wheel' # sets the group of mysql backups
BACKUP_MYSQL_PERMISSIONS='640' # sets the permissions of file backups
# Optionally customize the variable part of the file name.
BACKUP_MYSQL_PREFIX="$(date +%y%m%dT%H%M%S)"
################################################################################
# Feature backup ZFS snapshot (work in progress)
################################################################################
BACKUP_ZFS_ENABLE='NO' # NO (disable), YES (enable)
BACKUP_ZFS_RETENTION_HOURLY='0' # number of days backups are kept, 0 for infinite
BACKUP_ZFS_RETENTION_DAILY='0' # number of days backups are kept, 0 for infinite
BACKUP_ZFS_RETENTION_WEEKLY='0' # number of days backups are kept, 0 for infinite
# Optionally customize the variable part of the file name.
BACKUP_ZFS_PREFIX="$(date +%y%m%dT%H%M%S)"
################################################################################
# Advanced settings
################################################################################
# These settings can be safely ignored by most people.
# # Advanced compression options
# For most people a choice between gzip, bzip2 and xz is sufficient. If this is
# not the case for you then there are some other options available.
#
# $BACKUP_FILES_COMPRESSION, $BACKUP_MYSQL_COMPRESSION
# '1' gzip compression algorithm with gzip
# '2' bzip2 compression algorithm with bzip2
# '3' xz compression algorithm with xz
# '4' lz4 compression algorithm with lz4
# '5' Zstandard compression algorithm with zstd
# '6' lzma compression algorithm with lrzip (needs package installed)
# '7' lzma compression algorithm with lzip (needs package installed)
# '8' lzo compression algorithm with lzop (needs package installed)
# '101' gzip compression algorithm with pigz (parallel processing)(needs package installed)
# '102' bzip2 compression algorithm with pbzip2 (parallel processing)(needs package installed)
# '107' lzma compression algorithm with plzip (parallel processing)(needs package installed)
#
# Do note that lrzip (6), lzip (7), lzop (8), pigz (101), pbzip2 (102) and plzip (107)
# require their respective package to be installed.
#