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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
|
package App::BorgRestore::Settings;
use v5.10;
use strict;
use warnings;
use App::BorgRestore::Helper;
use File::Path qw(mkpath);
use Sys::Hostname;
=encoding utf-8
=head1 NAME
App::BorgRestore::Settings - Settings package
=head1 DESCRIPTION
App::BorgRestore::Settings searches for configuration files in the following locations in
order. The first file found will be used, any later ones are ignored. If no
files are found, defaults are used.
=over
=item * $XDG_CONFIG_HOME/borg-restore.cfg
=item * /etc/borg-restore.cfg
=back
=head2 Configuration Options
You can set the following options in the config file.
Note that the configuration file is parsed as a perl script. Thus you can also
use any features available in perl itself.
=over
=item C<$borg_repo>
This specifies the URL to the borg repo as used in other borg commands. If you
use the $BORG_REPO environment variable set this to an empty string. Default:
"backup:borg-".hostname;
=item C<$cache_path_base>
This defaults to "C<$XDG_CACHE_HOME>/borg-restore.pl". It contains the lookup database.
=item C<@backup_prefixes>
This is an array of prefixes that need to be added when looking up a file in the
backup archives. If you use filesystem snapshots and the snapshot for /home is
located at /mnt/snapshots/home, you have to add the following:
# In the backup archives, /home has the path /mnt/snapshots/home
{regex => "^/home/", replacement => "mnt/snapshots/home/"},
The regex must always include the leading slash and it is suggested to include
a tailing slash as well to prevent clashes with directories that start with the
same string. The first regex that matches for a given file is used. This
setting only affects lookups, it does not affect the creation of the database
with --update-database.
=item C<$sqlite_cache_size>
Default: 102400
The size of the in-memory cache of sqlite in kibibytes. This should be large
enough to fit the database so that adding new backup data does not need to use
the disk too much.
=back
=head2 Example Configuration
$borg_repo = "/path/to/repo";
$cache_path_base = "/mnt/somewhere/borg-restore.pl-cache";
@backup_prefixes = (
{regex => "^/home/", replacement => "mnt/snapshots/home/"},
# /boot is not snapshotted
{regex => "^/boot", replacement => ""},
{regex => "^/", replacement => "mnt/snapshots/root/"},
);
$sqlite_cache_size = 2097152;
=head1 LICENSE
Copyright (C) 2016-2017 Florian Pritz E<lt>bluewind@xinu.atE<gt>
Licensed under the GNU General Public License version 3 or later.
See LICENSE for the full license text.
=cut
our $borg_repo = "backup:borg-".hostname;
our $cache_path_base = sprintf("%s/borg-restore.pl", $ENV{XDG_CACHE_HOME} // $ENV{HOME}."/.cache");
our @backup_prefixes = (
{regex => "^/", replacement => ""},
);
our $sqlite_cache_size = 102400;
my @configfiles = (
sprintf("%s/borg-restore.cfg", $ENV{XDG_CONFIG_HOME} // $ENV{HOME}."/.config"),
"/etc/borg-restore.cfg",
);
for my $configfile (@configfiles) {
$configfile = App::BorgRestore::Helper::untaint($configfile, qr/.*/);
if (-e $configfile) {
unless (my $return = do $configfile) {
die "couldn't parse $configfile: $@" if $@;
die "couldn't do $configfile: $!" unless defined $return;
die "couldn't run $configfile" unless $return;
}
}
}
$cache_path_base = App::BorgRestore::Helper::untaint($cache_path_base, qr/.*/);
# ensure the cache directory exists
mkpath(get_cache_dir(), {mode => oct(700)});
sub get_cache_dir {
return "$cache_path_base/v2";
}
sub get_cache_path {
my $item = shift;
return get_cache_dir()."/$item";
}
sub get_db_path {
return get_cache_path('archives.db');
}
1;
__END__
|
