table of contents
| backintime-config(1) | USER COMMANDS | backintime-config(1) |
NAME¶
config - BackInTime configuration files.
SYNOPSIS¶
~/.config/backintime/config
/etc/backintime/config
DESCRIPTION¶
Back In Time was developed as pure GUI program and so most functions are only usable with backintime-qt. But it is possible to use Back In Time e.g. on a headless server. You have to create the configuration file (~/.config/backintime/config) manually. Look inside /usr/share/doc/backintime-common/examples/ for examples.
The configuration file has the following format:
keyword=arguments
Arguments don't need to be quoted. All characters are allowed except '='.
Run 'backintime check-config' to verify the configfile, create the snapshot folder and crontab entries.
POSSIBLE KEYWORDS¶
Type: int Allowed Values: 0-99999
Internal value used to prevent hash collisions on mountpoints. Do not change this.
Internal value used to prevent hash collisions on mountpoints. Do not change this.
Default: 0
Type: str Allowed Values: text
Language code (ISO 639) used to translate the user interface. If empty the operating systems current local is used. If 'en' the translation is not active and the original English source strings are used. It is the same if the value is unknown.
Language code (ISO 639) used to translate the user interface. If empty the operating systems current local is used. If 'en' the translation is not active and the original English source strings are used. It is the same if the value is unknown.
Default: ''
Type: bool Allowed Values: true|false
Prevent multiple snapshots (from different profiles or users) to be run at the same time
Prevent multiple snapshots (from different profiles or users) to be run at the same time
Default: false
Type: str Allowed Values: text
Name of this profile.
Name of this profile.
Default: Main profile
Type: str Allowed Values: comma separated int
(8,12,18,23) or */3
Custom hours for cronjob. Only valid for profile<N>.schedule.mode = 19
Custom hours for cronjob. Only valid for profile<N>.schedule.mode = 19
Default: 8,12,18,23
Type: int Allowed Values: 1-28
Which day of month the cronjob should run? Only valid for profile<N>.schedule.mode >= 40
Which day of month the cronjob should run? Only valid for profile<N>.schedule.mode >= 40
Default: 1
Type: int Allowed Values:
0|1|2|4|7|10|12|14|16|18|19|20|25|27|30|40|80
Which schedule used for crontab. The crontab entry will be generated with 'backintime check-config'.
0 = Disabled
1 = at every boot
2 = every 5 minute
4 = every 10 minute
7 = every 30 minute
10 = every hour
12 = every 2 hours
14 = every 4 hours
16 = every 6 hours
18 = every 12 hours
19 = custom defined hours
20 = every day
25 = daily anacron
27 = when drive get connected
30 = every week
40 = every month
80 = every year
Which schedule used for crontab. The crontab entry will be generated with 'backintime check-config'.
0 = Disabled
1 = at every boot
2 = every 5 minute
4 = every 10 minute
7 = every 30 minute
10 = every hour
12 = every 2 hours
14 = every 4 hours
16 = every 6 hours
18 = every 12 hours
19 = custom defined hours
20 = every day
25 = daily anacron
27 = when drive get connected
30 = every week
40 = every month
80 = every year
Default: 0
Type: int Allowed Values: 0-99999
How many units to wait between new snapshots with anacron? Only valid for profile<N>.schedule.mode = 25|27
How many units to wait between new snapshots with anacron? Only valid for profile<N>.schedule.mode = 25|27
Default: 1
Type: int Allowed Values: 10|20|30|40
Units to wait between new snapshots with anacron.
10 = hours
20 = days
30 = weeks
40 = months
Only valid for profile<N>.schedule.mode = 25|27
Units to wait between new snapshots with anacron.
10 = hours
20 = days
30 = weeks
40 = months
Only valid for profile<N>.schedule.mode = 25|27
Default: 20
Type: int Allowed Values: 0-2400
Position-coded number with the format "hhmm" to specify the hour and minute the cronjob should start (eg. 2015 means a quarter past 8pm). Leading zeros can be omitted (eg. 30 = 0030). Only valid for profile<N>.schedule.mode = 20 (daily), 30 (weekly), 40 (monthly) and 80 (yearly)
Position-coded number with the format "hhmm" to specify the hour and minute the cronjob should start (eg. 2015 means a quarter past 8pm). Leading zeros can be omitted (eg. 30 = 0030). Only valid for profile<N>.schedule.mode = 20 (daily), 30 (weekly), 40 (monthly) and 80 (yearly)
Default: 0
Type: int Allowed Values: 1 = monday - 7 = sunday
Which day of week the cronjob should run? Only valid for profile<N>.schedule.mode = 30
Which day of week the cronjob should run? Only valid for profile<N>.schedule.mode = 30
Default: 7
Type: bool Allowed Values: true|false
Rename existing files before restore into FILE.backup.YYYYMMDD
Rename existing files before restore into FILE.backup.YYYYMMDD
Default: true
Type: bool Allowed Values: true|false
Limit rsync bandwidth usage over network. Use this with mode SSH. For mode Local you should rather use ionice.
Limit rsync bandwidth usage over network. Use this with mode SSH. For mode Local you should rather use ionice.
Default: false
Type: int Allowed Values: 0-99999
Bandwidth limit in KB/sec.
Bandwidth limit in KB/sec.
Default: 3000
Type: bool Allowed Values: true|false
Continue on errors. This will keep incomplete snapshots rather than deleting and start over again.
Continue on errors. This will keep incomplete snapshots rather than deleting and start over again.
Default: true
Type: bool Allowed Values: true|false
When symlinks are encountered, the item that they point to (the reference) is copied, rather than the symlink.
When symlinks are encountered, the item that they point to (the reference) is copied, rather than the symlink.
Default: false
Type: bool Allowed Values: true|false
This tells rsync to copy the referent of symbolic links that point outside the copied tree. Absolute symlinks are also treated like ordinary files.
This tells rsync to copy the referent of symbolic links that point outside the copied tree. Absolute symlinks are also treated like ordinary files.
Default: false
Type: bool Allowed Values: true|false
Run cronjobs with 'ionice -c2 -n7'. This will give BackInTime the lowest IO bandwidth priority to not interrupt any other working process.
Run cronjobs with 'ionice -c2 -n7'. This will give BackInTime the lowest IO bandwidth priority to not interrupt any other working process.
Default: true
Type: bool Allowed Values: true|false
Run cronjobs with 'nice -n19'. This will give BackInTime the lowest CPU priority to not interrupt any other working process.
Run cronjobs with 'nice -n19'. This will give BackInTime the lowest CPU priority to not interrupt any other working process.
Default: true
Type: bool Allowed Values: true|false
redirect stderr to /dev/null in cronjobs
redirect stderr to /dev/null in cronjobs
Default: False
Type: bool Allowed Values: true|false
redirect stdout to /dev/null in cronjobs
redirect stdout to /dev/null in cronjobs
Default: true
Type: bool Allowed Values: true|false
Keep snapshots with names during smart_remove.
Keep snapshots with names during smart_remove.
Default: true
Type: bool Allowed Values: true|false
Enable exclude files by size.
Enable exclude files by size.
Default: false
Type: int Allowed Values: 0-99999
Exclude files bigger than value in MiB. With 'Full rsync mode' disabled this will only affect new files because for rsync this is a transfer option, not an exclude option. So big files that has been backed up before will remain in snapshots even if they had changed.
Exclude files bigger than value in MiB. With 'Full rsync mode' disabled this will only affect new files because for rsync this is a transfer option, not an exclude option. So big files that has been backed up before will remain in snapshots even if they had changed.
Default: 500
Type: str Allowed Values: file, folder or pattern
(relative or absolute)
Exclude this file or folder. <I> must be a counter starting with 1
Exclude this file or folder. <I> must be a counter starting with 1
Default: ''
Type: int Allowed Values: 0-99999
Quantity of profile<N>.snapshots.exclude.<I> entries.
Quantity of profile<N>.snapshots.exclude.<I> entries.
Default: -1
Type: int Allowed Values: 0|1
Specify if profile<N>.snapshots.include.<I>.value is a folder (0) or a file (1).
Specify if profile<N>.snapshots.include.<I>.value is a folder (0) or a file (1).
Default: 0
Type: str Allowed Values: absolute path
Include this file or folder. <I> must be a counter starting with 1
Include this file or folder. <I> must be a counter starting with 1
Default: ''
Type: int Allowed Values: 0-99999
Quantity of profile<N>.snapshots.include.<I> entries.
Quantity of profile<N>.snapshots.include.<I> entries.
Default: -1
Type: bool Allowed Values: true|false
NOT YET IMPLEMENTED. Remove all snapshots but one.
NOT YET IMPLEMENTED. Remove all snapshots but one.
Default: false
Type: bool Allowed Values: true|false
Run rsync on local machine with 'nocache'. This will prevent files from being cached in memory.
Run rsync on local machine with 'nocache'. This will prevent files from being cached in memory.
Default: false
Type: str Allowed Values: absolute path
Where to save snapshots in mode 'local_encfs'.
Where to save snapshots in mode 'local_encfs'.
Default: ''
Type: int Allowed Values: 1-3
Log level used during takeSnapshot.
1 = Error
2 = Changes
3 = Info
Log level used during takeSnapshot.
1 = Error
2 = Changes
3 = Info
Default: 3
Type: bool Allowed Values: true|false
Remove snapshots until profile<N>.snapshots.min_free_inodes.value free inodes in % is reached.
Remove snapshots until profile<N>.snapshots.min_free_inodes.value free inodes in % is reached.
Default: true
Type: int Allowed Values: 1-15
Keep at least value % free inodes.
Keep at least value % free inodes.
Default: 2
Type: bool Allowed Values: true|false
Remove snapshots until profile<N>.snapshots.min_free_space.value free space is reached.
Remove snapshots until profile<N>.snapshots.min_free_space.value free space is reached.
Default: true
Type: int Allowed Values: 10|20
10 = MB
20 = GB
10 = MB
20 = GB
Default: 20
Type: int Allowed Values: 1-99999
Keep at least value + unit free space.
Keep at least value + unit free space.
Default: 1
Type: str Allowed Values: local|local_encfs|ssh|ssh_encfs
Use mode (or backend) for this snapshot. Look at 'man backintime' section 'Modes'.
Use mode (or backend) for this snapshot. Look at 'man backintime' section 'Modes'.
Default: local
Type: bool Allowed Values: true|false
Save password to system keyring (gnome-keyring or kwallet). <MODE> must be the same as profile<N>.snapshots.mode
Save password to system keyring (gnome-keyring or kwallet). <MODE> must be the same as profile<N>.snapshots.mode
Default: false
Type: bool Allowed Values: true|false
Cache password in RAM so it can be read by cronjobs. Security issue: root might be able to read that password, too. <MODE> must be the same as profile<N>.snapshots.mode
Cache password in RAM so it can be read by cronjobs. Security issue: root might be able to read that password, too. <MODE> must be the same as profile<N>.snapshots.mode
Default: true if home is not encrypted
Type: bool Allowed Values: true|false
Don't take snapshots if the Computer runs on battery.
Don't take snapshots if the Computer runs on battery.
Default: false
Type: bool Allowed Values: true|false
Display notifications (errors, warnings) through libnotify.
Display notifications (errors, warnings) through libnotify.
Default: true
Type: bool Allowed Values: true|false
Use rsync's "--one-file-system" to avoid crossing filesystem boundaries when recursing.
Use rsync's "--one-file-system" to avoid crossing filesystem boundaries when recursing.
Default: false
Type: str Allowed Values: absolute path
Where to save snapshots in mode 'local'. This path must contain a folderstructure like 'backintime/<HOST>/<USER>/<PROFILE_ID>'
Where to save snapshots in mode 'local'. This path must contain a folderstructure like 'backintime/<HOST>/<USER>/<PROFILE_ID>'
Default: ''
Type: str Allowed Values: text
Set Host for snapshot path
Set Host for snapshot path
Default: local hostname
Type: str Allowed Values: 1-99999
Set Profile-ID for snapshot path
Set Profile-ID for snapshot path
Default: current Profile-ID
Type: str Allowed Values: text
Set User for snapshot path
Set User for snapshot path
Default: local username
Type: str Allowed Values: text
Devices uuid used to automatically set up udev rule if the drive is not connected.
Devices uuid used to automatically set up udev rule if the drive is not connected.
Default: ''
Type: bool Allowed Values: true|false
Preserve ACL. The source and destination systems must have compatible ACL entries for this option to work properly.
Preserve ACL. The source and destination systems must have compatible ACL entries for this option to work properly.
Default: false
Type: bool Allowed Values: true|false
Preserve extended attributes (xattr).
Preserve extended attributes (xattr).
Default: false
Type: bool Allowed Values: true|false
Remove all snapshots older than value + unit
Remove all snapshots older than value + unit
Default: true
Type: int Allowed Values: 20|30|80
20 = days
30 = weeks
80 = years
20 = days
30 = weeks
80 = years
Default: 80
Type: int Allowed Values: 0-99999
Snapshots older than this times units will be removed
Snapshots older than this times units will be removed
Default: 10
Type: bool Allowed Values: true|false
Past additional options to rsync
Past additional options to rsync
Default: false
Type: str Allowed Values: text
rsync options. Options must be quoted e.g. --exclude-from="/path/to/my exclude file"
rsync options. Options must be quoted e.g. --exclude-from="/path/to/my exclude file"
Default: ''
Type: bool Allowed Values: true|false
Run smart_remove to clean up old snapshots after a new snapshot was created.
Run smart_remove to clean up old snapshots after a new snapshot was created.
Default: false
Type: int Allowed Values: 0-99999
Keep all snapshots for X days.
Keep all snapshots for X days.
Default: 2
Type: int Allowed Values: 0-99999
Keep one snapshot per day for X days.
Keep one snapshot per day for X days.
Default: 7
Type: int Allowed Values: 0-99999
Keep one snapshot per month for X month.
Keep one snapshot per month for X month.
Default: 24
Type: int Allowed Values: 0-99999
Keep one snapshot per week for X weeks.
Keep one snapshot per week for X weeks.
Default: 4
Type: bool Allowed Values: true|false
If using mode SSH or SSH-encrypted, run smart_remove in background on remote machine
If using mode SSH or SSH-encrypted, run smart_remove in background on remote machine
Default: false
Type: bool Allowed Values: true|false
Check if all commands (used during takeSnapshot) work like expected on the remote host.
Check if all commands (used during takeSnapshot) work like expected on the remote host.
Default: true
Type: bool Allowed Values: true|false
Check if the remote host is available before trying to mount.
Check if the remote host is available before trying to mount.
Default: true
Type: str Allowed Values: default | aes192-cbc |
aes256-cbc | aes128-ctr | aes192-ctr | aes256-ctr | arcfour | arcfour256 |
arcfour128 | aes128-cbc | 3des-cbc | blowfish-cbc | cast128-cbc
Cipher that is used for encrypting the SSH tunnel. Depending on the environment (network bandwidth, cpu and hdd performance) a different cipher might be faster.
Cipher that is used for encrypting the SSH tunnel. Depending on the environment (network bandwidth, cpu and hdd performance) a different cipher might be faster.
Default: default
Type: str Allowed Values: IP or domain address
Remote host used for mode 'ssh' and 'ssh_encfs'.
Remote host used for mode 'ssh' and 'ssh_encfs'.
Default: ''
Type: bool Allowed Values: true|false
Run rsync and other commands on remote host with 'ionice -c2 -n7'
Run rsync and other commands on remote host with 'ionice -c2 -n7'
Default: false
Type: int Allowed Values: 0, >700
Maximum command length of commands run on remote host. This can be tested for all ssh profiles in the configuration with 'python3 /usr/share/backintime/common/sshMaxArg.py [initial_ssh_cmd_length]'.
0 = unlimited
Maximum command length of commands run on remote host. This can be tested for all ssh profiles in the configuration with 'python3 /usr/share/backintime/common/sshMaxArg.py [initial_ssh_cmd_length]'.
0 = unlimited
Default: 0
Type: bool Allowed Values: true|false
Run rsync and other commands on remote host with 'nice -n19'
Run rsync and other commands on remote host with 'nice -n19'
Default: false
Type: bool Allowed Values: true|false
Run rsync on remote host with 'nocache'. This will prevent files from being cached in memory.
Run rsync on remote host with 'nocache'. This will prevent files from being cached in memory.
Default: false
Type: str Allowed Values: absolute or relative path
Snapshot path on remote host. If the path is relative (no leading '/') it will start from remote Users homedir. An empty path will be replaced with './'.
Snapshot path on remote host. If the path is relative (no leading '/') it will start from remote Users homedir. An empty path will be replaced with './'.
Default: ''
Type: int Allowed Values: 0-65535
SSH Port on remote host.
SSH Port on remote host.
Default: 22
Type: bool Allowed Values: true|false
Add prefix to every command which run through SSH on remote host.
Add prefix to every command which run through SSH on remote host.
Default: false
Type: str Allowed Values: text
Prefix to run before every command on remote host. Variables need to be escaped with \$FOO. This doesn't touch rsync. So to add a prefix for rsync use profile<N>.snapshots.rsync_options.value with --rsync-path="FOO=bar:\$FOO /usr/bin/rsync"
Prefix to run before every command on remote host. Variables need to be escaped with \$FOO. This doesn't touch rsync. So to add a prefix for rsync use profile<N>.snapshots.rsync_options.value with --rsync-path="FOO=bar:\$FOO /usr/bin/rsync"
Default: 'PATH=/opt/bin:/opt/sbin:\$PATH'
Type: str Allowed Values: absolute path to private key
file
Private key file used for password-less authentication on remote host.
Private key file used for password-less authentication on remote host.
Default: ~/.ssh/id_dsa
Type: str Allowed Values: text
Remote SSH user
Remote SSH user
Default: local users name
Type: bool Allowed Values: true|false
Create a new snapshot regardless if there were changes or not.
Create a new snapshot regardless if there were changes or not.
Default: false
Type: bool Allowed Values: true|false
Use checksum to detect changes rather than size + time.
Use checksum to detect changes rather than size + time.
Default: false
Type: bool Allowed Values: true|false
Run BackInTime with 'ionice -c2 -n7' when taking a manual snapshot. This will give BackInTime the lowest IO bandwidth priority to not interrupt any other working process.
Run BackInTime with 'ionice -c2 -n7' when taking a manual snapshot. This will give BackInTime the lowest IO bandwidth priority to not interrupt any other working process.
Default: false
Type: bool Allowed Values: true|false
Do not catch std{out|err} from user-callback script. The script will only write to current TTY. Default is to catch std{out|err} and write it to syslog and TTY again.
Do not catch std{out|err} from user-callback script. The script will only write to current TTY. Default is to catch std{out|err} and write it to syslog and TTY again.
Default: false
Type: str Allowed Values: int separated by colon (e.g.
1:3:4)
All active Profiles (<N> in profile<N>.snapshots...).
All active Profiles (<N> in profile<N>.snapshots...).
Default: 1
Type: int Allowed Values: 1
Internal version of profiles config.
Internal version of profiles config.
Default: 1
SEE ALSO¶
backintime(1), backintime-qt(1), backintime-askpass(1)
Back In Time project website: https://github.com/bit-team/backintime
Back In Time mailing list: https://mail.python.org/mailman3/lists/bit-dev.python.org
AUTHOR¶
Back In Time Team
| August 2024 | version 1.5.2 |