1backintime-config(1) USER COMMANDS backintime-config(1)
2
6 config - BackInTime configuration files.
7
9 ~/.config/backintime/config
10 /etc/backintime/config
11
13 Back In Time was developed as pure GUI program and so most functions
14 are only useable with backintime-qt. But it is possible to use Back In
15 Time e.g. on a headless server. You have to create the configuration
16 file (~/.config/backintime/config) manually. Look inside
17 /usr/share/doc/backintime-common/examples/ for examples.
18 The configuration file has the following format:
20 keyword=arguments
21 Arguments don't need to be quoted. All characters are allowed except
23 '='.
24 Run 'backintime check-config' to verify the configfile, create the
26 snapshot folder and crontab entries.
27
29 config.version
30 Type: int Allowed Values: 0-99999
31 Default: 6
34 global.hash_collision
37 Type: int Allowed Values: 0-99999
38 Internal value used to prevent hash collisions on mountpoints. Do
39 not change this.
40 Default: 0
42 global.use_flock
45 Type: bool Allowed Values: true|false
46 Prevent multiple snapshots (from different profiles or users) to
47 be run at the same time
48 Default: false
50 profile<N>.name
53 Type: str Allowed Values: text
54 Name of this profile.
55 Default: Main profile
57 profile<N>.schedule.custom_time
60 Type: str Allowed Values: comma separated int (8,12,18,23)
61 or */3
62 Custom hours for cronjob. Only valid for profile<N>.schedule.mode
63 = 19
64 Default: 8,12,18,23
66 profile<N>.schedule.day
69 Type: int Allowed Values: 1-28
70 Which day of month the cronjob should run? Only valid for pro‐
71 file<N>.schedule.mode >= 40
72 Default: 1
74 profile<N>.schedule.mode
77 Type: int Allowed Values:
78 0|1|2|4|7|10|12|14|16|18|19|20|25|27|30|40|80
79 Which schedule used for crontab. The crontab entry will be gener‐
80 ated with 'backintime check-config'.
81 0 = Disabled
82 1 = at every boot
83 2 = every 5 minute
84 4 = every 10 minute
85 7 = every 30 minute
86 10 = every hour
87 12 = every 2 hours
88 14 = every 4 hours
89 16 = every 6 hours
90 18 = every 12 hours
91 19 = custom defined hours
92 20 = every day
93 25 = daily anacron
94 27 = when drive get connected
95 30 = every week
96 40 = every month
97 80 = every year
98 Default: 0
100 profile<N>.schedule.repeatedly.period
103 Type: int Allowed Values: 0-99999
104 How many units to wait between new snapshots with anacron? Only
105 valid for profile<N>.schedule.mode = 25|27
106 Default: 1
108 profile<N>.schedule.repeatedly.unit
111 Type: int Allowed Values: 10|20|30|40
112 Units to wait between new snapshots with anacron.
113 10 = hours
114 20 = days
115 30 = weeks
116 40 = months
117 Only valid for profile<N>.schedule.mode = 25|27
118 Default: 20
120 profile<N>.schedule.time
123 Type: int Allowed Values: 0-2400
124 Position-coded number with the format "hhmm" to specify the hour
125 and minute the cronjob should start (eg. 2015 means a quarter
126 past 8pm). Leading zeros can be omitted (eg. 30 = 0030). Only
127 valid for profile<N>.schedule.mode = 20 (daily), 30 (weekly), 40
128 (monthly) and 80 (yearly)
129 Default: 0
131 profile<N>.schedule.weekday
134 Type: int Allowed Values: 1 = monday - 7 = sunday
135 Which day of week the cronjob should run? Only valid for pro‐
136 file<N>.schedule.mode = 30
137 Default: 7
139 profile<N>.snapshots.backup_on_restore.enabled
142 Type: bool Allowed Values: true|false
143 Rename existing files before restore into FILE.backup.YYYYMMDD
144 Default: true
146 profile<N>.snapshots.bwlimit.enabled
149 Type: bool Allowed Values: true|false
150 Limit rsync bandwidth usage over network. Use this with mode SSH.
151 For mode Local you should rather use ionice.
152 Default: false
154 profile<N>.snapshots.bwlimit.value
157 Type: int Allowed Values: 0-99999
158 Bandwidth limit in KB/sec.
159 Default: 3000
161 profile<N>.snapshots.continue_on_errors
164 Type: bool Allowed Values: true|false
165 Continue on errors. This will keep incomplete snapshots rather
166 than deleting and start over again.
167 Default: true
169 profile<N>.snapshots.copy_links
172 Type: bool Allowed Values: true|false
173 When symlinks are encountered, the item that they point to
174 (the reference) is copied, rather than the symlink.
175 Default: false
177 profile<N>.snapshots.copy_unsafe_links
180 Type: bool Allowed Values: true|false
181 This tells rsync to copy the referent of symbolic links that
182 point outside the copied tree. Absolute symlinks are also
183 treated like ordinary files.
184 Default: false
186 profile<N>.snapshots.cron.ionice
189 Type: bool Allowed Values: true|false
190 Run cronjobs with 'ionice -c2 -n7'. This will give BackInTime the
191 lowest IO bandwidth priority to not interrupt any other working
192 process.
193 Default: true
195 profile<N>.snapshots.cron.nice
198 Type: bool Allowed Values: true|false
199 Run cronjobs with 'nice -n19'. This will give BackInTime the low‐
200 est CPU priority to not interrupt any other working process.
201 Default: true
203 profile<N>.snapshots.cron.redirect_stderr
206 Type: bool Allowed Values: true|false
207 redirect stderr to /dev/null in cronjobs
208 Default: False
210 profile<N>.snapshots.cron.redirect_stdout
213 Type: bool Allowed Values: true|false
214 redirect stdout to /dev/null in cronjobs
215 Default: true
217 profile<N>.snapshots.dont_remove_named_snapshots
220 Type: bool Allowed Values: true|false
221 Keep snapshots with names during smart_remove.
222 Default: true
224 profile<N>.snapshots.exclude.bysize.enabled
227 Type: bool Allowed Values: true|false
228 Enable exclude files by size.
229 Default: false
231 profile<N>.snapshots.exclude.bysize.value
234 Type: int Allowed Values: 0-99999
235 Exclude files bigger than value in MiB. With 'Full rsync mode'
236 disabled this will only affect new files because for rsync this
237 is a transfer option, not an exclude option. So big files that
238 has been backed up before will remain in snapshots even if they
239 had changed.
240 Default: 500
242 profile<N>.snapshots.exclude.<I>.value
245 Type: str Allowed Values: file, folder or pattern (relative
246 or absolute)
247 Exclude this file or folder. <I> must be a counter starting with
248 1
249 Default: ''
251 profile<N>.snapshots.exclude.size
254 Type: int Allowed Values: 0-99999
255 Quantity of profile<N>.snapshots.exclude.<I> entries.
256 Default: -1
258 profile<N>.snapshots.include.<I>.type
261 Type: int Allowed Values: 0|1
262 Specify if profile<N>.snapshots.include.<I>.value is a folder (0)
263 or a file (1).
264 Default: 0
266 profile<N>.snapshots.include.<I>.value
269 Type: str Allowed Values: absolute path
270 Include this file or folder. <I> must be a counter starting with
271 1
272 Default: ''
274 profile<N>.snapshots.include.size
277 Type: int Allowed Values: 0-99999
278 Quantity of profile<N>.snapshots.include.<I> entries.
279 Default: -1
281 profile<N>.snapshots.keep_only_one_snapshot.enabled
284 Type: bool Allowed Values: true|false
285 NOT YET IMPLEMENTED. Remove all snapshots but one.
286 Default: false
288 profile<N>.snapshots.local.nocache
291 Type: bool Allowed Values: true|false
292 Run rsync on local machine with 'nocache'. This will prevent
293 files from being cached in memory.
294 Default: false
296 profile<N>.snapshots.local_encfs.path
299 Type: str Allowed Values: absolute path
300 Where to save snapshots in mode 'local_encfs'.
301 Default: ''
303 profile<N>.snapshots.log_level
306 Type: int Allowed Values: 1-3
307 Log level used during takeSnapshot.
308 1 = Error
309 2 = Changes
310 3 = Info
311 Default: 3
313 profile<N>.snapshots.min_free_inodes.enabled
316 Type: bool Allowed Values: true|false
317 Remove snapshots until profile<N>.snapshots.min_free_inodes.value
318 free inodes in % is reached.
319 Default: true
321 profile<N>.snapshots.min_free_inodes.value
324 Type: int Allowed Values: 1-15
325 Keep at least value % free inodes.
326 Default: 2
328 profile<N>.snapshots.min_free_space.enabled
331 Type: bool Allowed Values: true|false
332 Remove snapshots until profile<N>.snapshots.min_free_space.value
333 free space is reached.
334 Default: true
336 profile<N>.snapshots.min_free_space.unit
339 Type: int Allowed Values: 10|20
340 10 = MB
341 20 = GB
342 Default: 20
344 profile<N>.snapshots.min_free_space.value
347 Type: int Allowed Values: 1-99999
348 Keep at least value + unit free space.
349 Default: 1
351 profile<N>.snapshots.mode
354 Type: str Allowed Values: local|local_encfs|ssh|ssh_encfs
355 Use mode (or backend) for this snapshot. Look at 'man backin‐
356 time' section 'Modes'.
357 Default: local
359 profile<N>.snapshots.<MODE>.password.save
362 Type: bool Allowed Values: true|false
363 Save password to system keyring (gnome-keyring or kwallet).
364 <MODE> must be the same as profile<N>.snapshots.mode
365 Default: false
367 profile<N>.snapshots.<MODE>.password.use_cache
370 Type: bool Allowed Values: true|false
371 Cache password in RAM so it can be read by cronjobs. Security is‐
372 sue: root might be able to read that password, too. <MODE> must
373 be the same as profile<N>.snapshots.mode
374 Default: true if home is not encrypted
376 profile<N>.snapshots.no_on_battery
379 Type: bool Allowed Values: true|false
380 Don't take snapshots if the Computer runs on battery.
381 Default: false
383 profile<N>.snapshots.notify.enabled
386 Type: bool Allowed Values: true|false
387 Display notifications (errors, warnings) through libnotify.
388 Default: true
390 profile<N>.snapshots.path
393 Type: str Allowed Values: absolute path
394 Where to save snapshots in mode 'local'. This path must contain a
395 folderstructure like 'backintime/<HOST>/<USER>/<PROFILE_ID>'
396 Default: ''
398 profile<N>.snapshots.path.host
401 Type: str Allowed Values: text
402 Set Host for snapshot path
403 Default: local hostname
405 profile<N>.snapshots.path.profile
408 Type: str Allowed Values: 1-99999
409 Set Profile-ID for snapshot path
410 Default: current Profile-ID
412 profile<N>.snapshots.path.user
415 Type: str Allowed Values: text
416 Set User for snapshot path
417 Default: local username
419 profile<N>.snapshots.path.uuid
422 Type: str Allowed Values: text
423 Devices uuid used to automatically set up udev rule if the drive
424 is not connected.
425 Default: ''
427 profile<N>.snapshots.preserve_acl
430 Type: bool Allowed Values: true|false
431 Preserve ACL. The source and destination systems must have
432 compatible ACL entries for this option to work properly.
433 Default: false
435 profile<N>.snapshots.preserve_xattr
438 Type: bool Allowed Values: true|false
439 Preserve extended attributes (xattr).
440 Default: false
442 profile<N>.snapshots.remove_old_snapshots.enabled
445 Type: bool Allowed Values: true|false
446 Remove all snapshots older than value + unit
447 Default: true
449 profile<N>.snapshots.remove_old_snapshots.unit
452 Type: int Allowed Values: 20|30|80
453 20 = days
454 30 = weeks
455 80 = years
456 Default: 80
458 profile<N>.snapshots.remove_old_snapshots.value
461 Type: int Allowed Values: 0-99999
462 Snapshots older than this times units will be removed
463 Default: 10
465 profile<N>.snapshots.rsync_options.enabled
468 Type: bool Allowed Values: true|false
469 Past additional options to rsync
470 Default: false
472 profile<N>.snapshots.rsync_options.value
475 Type: str Allowed Values: text
476 rsync options. Options must be quoted e.g. --exclude-
477 from="/path/to/my exclude file"
478 Default: ''
480 profile<N>.snapshots.smart_remove
483 Type: bool Allowed Values: true|false
484 Run smart_remove to clean up old snapshots after a new snapshot
485 was created.
486 Default: false
488 profile<N>.snapshots.smart_remove.keep_all
491 Type: int Allowed Values: 0-99999
492 Keep all snapshots for X days.
493 Default: 2
495 profile<N>.snapshots.smart_remove.keep_one_per_day
498 Type: int Allowed Values: 0-99999
499 Keep one snapshot per day for X days.
500 Default: 7
502 profile<N>.snapshots.smart_remove.keep_one_per_month
505 Type: int Allowed Values: 0-99999
506 Keep one snapshot per month for X month.
507 Default: 24
509 profile<N>.snapshots.smart_remove.keep_one_per_week
512 Type: int Allowed Values: 0-99999
513 Keep one snapshot per week for X weeks.
514 Default: 4
516 profile<N>.snapshots.smart_remove.run_remote_in_background
519 Type: bool Allowed Values: true|false
520 If using mode SSH or SSH-encrypted, run smart_remove in back‐
521 ground on remote machine
522 Default: false
524 profile<N>.snapshots.ssh.check_commands
527 Type: bool Allowed Values: true|false
528 Check if all commands (used during takeSnapshot) work like ex‐
529 pected on the remote host.
530 Default: true
532 profile<N>.snapshots.ssh.check_ping
535 Type: bool Allowed Values: true|false
536 Check if the remote host is available before trying to mount.
537 Default: true
539 profile<N>.snapshots.ssh.cipher
542 Type: str Allowed Values: default | aes192-cbc | aes256-cbc
543 | aes128-ctr | aes192-ctr | aes256-ctr | arcfour | arcfour256 |
544 arcfour128 | aes128-cbc | 3des-cbc | blowfish-cbc | cast128-cbc
545 Cipher that is used for encrypting the SSH tunnel. Depending on
546 the environment (network bandwidth, cpu and hdd performance) a
547 different cipher might be faster.
548 Default: default
550 profile<N>.snapshots.ssh.host
553 Type: str Allowed Values: IP or domain address
554 Remote host used for mode 'ssh' and 'ssh_encfs'.
555 Default: ''
557 profile<N>.snapshots.ssh.ionice
560 Type: bool Allowed Values: true|false
561 Run rsync and other commands on remote host with 'ionice -c2 -n7'
562 Default: false
564 profile<N>.snapshots.ssh.max_arg_length
567 Type: int Allowed Values: 0, >700
568 Maximum argument length of commands run on remote host. This can
569 be tested with 'python3 /usr/share/backintime/common/sshMaxArg.py
570 USER@HOST'.
571 0 = unlimited
572 Default: 0
574 profile<N>.snapshots.ssh.nice
577 Type: bool Allowed Values: true|false
578 Run rsync and other commands on remote host with 'nice -n19'
579 Default: false
581 profile<N>.snapshots.ssh.nocache
584 Type: bool Allowed Values: true|false
585 Run rsync on remote host with 'nocache'. This will prevent files
586 from being cached in memory.
587 Default: false
589 profile<N>.snapshots.ssh.path
592 Type: str Allowed Values: absolute or relative path
593 Snapshot path on remote host. If the path is relative (no leading
594 '/') it will start from remote Users homedir. An empty path will
595 be replaced with './'.
596 Default: ''
598 profile<N>.snapshots.ssh.port
601 Type: int Allowed Values: 0-65535
602 SSH Port on remote host.
603 Default: 22
605 profile<N>.snapshots.ssh.prefix.enabled
608 Type: bool Allowed Values: true|false
609 Add prefix to every command which run through SSH on remote host.
610 Default: false
612 profile<N>.snapshots.ssh.prefix.value
615 Type: str Allowed Values: text
616 Prefix to run before every command on remote host. Variables need
617 to be escaped with \$FOO. This doesn't touch rsync. So to add a
618 prefix for rsync use profile<N>.snapshots.rsync_options.value
619 with --rsync-path="FOO=bar:\$FOO /usr/bin/rsync"
620 Default: 'PATH=/opt/bin:/opt/sbin:\ATH'
622 profile<N>.snapshots.ssh.private_key_file
625 Type: str Allowed Values: absolute path to private key file
626 Private key file used for password-less authentication on remote
627 host.
628 Default: ~/.ssh/id_dsa
630 profile<N>.snapshots.ssh.user
633 Type: str Allowed Values: text
634 Remote SSH user
635 Default: local users name
637 profile<N>.snapshots.take_snapshot_regardless_of_changes
640 Type: bool Allowed Values: true|false
641 Create a new snapshot regardless if there were changes or not.
642 Default: false
644 profile<N>.snapshots.use_checksum
647 Type: bool Allowed Values: true|false
648 Use checksum to detect changes rather than size + time.
649 Default: false
651 profile<N>.snapshots.user_backup.ionice
654 Type: bool Allowed Values: true|false
655 Run BackInTime with 'ionice -c2 -n7' when taking a manual snap‐
656 shot. This will give BackInTime the lowest IO bandwidth priority
657 to not interrupt any other working process.
658 Default: false
660 profile<N>.user_callback.no_logging
663 Type: bool Allowed Values: true|false
664 Do not catch std{out|err} from user-callback script. The script
665 will only write to current TTY. Default is to catch std{out|err}
666 and write it to syslog and TTY again.
667 Default: false
669 profiles
672 Type: str Allowed Values: int separated by colon (e.g.
673 1:3:4)
674 All active Profiles (<N> in profile<N>.snapshots...).
675 Default: 1
677 profiles.version
680 Type: int Allowed Values: 1
681 Internal version of profiles config.
682 Default: 1
684
686 backintime, backintime-qt.
687 Back In Time also has a website: https://github.com/bit-team/backintime
689
691 This manual page was written by BIT Team(<bit-team@lists.launch‐
692 pad.net>).
693version 1.3.3 Nov 2022 backintime-config(1)