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
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
| | ;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2024 Giacomo Leidi <goodoldpaul@autistici.org>
;;;
;;; This file is part of GNU Guix.
;;;
;;; GNU Guix is free software; you can redistribute it and/or modify it
;;; under the terms of the GNU General Public License as published by
;;; the Free Software Foundation; either version 3 of the License, or (at
;;; your option) any later version.
;;;
;;; GNU Guix is distributed in the hope that it will be useful, but
;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;;; GNU General Public License for more details.
;;;
;;; You should have received a copy of the GNU General Public License
;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
(define-module (gnu services backup)
#:use-module (gnu packages backup)
#:use-module (gnu services)
#:use-module (gnu services configuration)
#:use-module (gnu services mcron)
#:use-module (guix gexp)
#:use-module (guix modules)
#:use-module (guix packages)
#:use-module (srfi srfi-1)
#:export (restic-backup-job
restic-backup-job?
restic-backup-job-fields
restic-backup-job-restic
restic-backup-job-user
restic-backup-job-repository
restic-backup-job-password-file
restic-backup-job-included
restic-backup-job-verbose?
restic-backup-job-extra-flags
restic-backup-configuration
restic-backup-configuration?
restic-backup-configuration-fields
restic-backup-configuration-jobs
restic-backup-job-program
restic-backup-job->mcron-job
restic-backup-service-type))
(define (gexp-or-string? value)
(or (gexp? value)
(string? value)))
(define (lowerable? value)
(or (file-like? value)
(gexp-or-string? value)))
(define list-of-lowerables?
(list-of lowerable?))
(define-configuration/no-serialization restic-backup-job
(restic
(package restic)
"The restic package to be used for the current job.")
(user
(string "root")
"The user used for running the current job.")
(repository
(string)
"The restic repository target of this job.")
(password-file
(string)
"The path of a password file, readable by the configured @code{user}, that
will be used to set the @code{RESTIC_PASSWORD} environment variable for the
current job.")
(specification
(gexp-or-string)
"A string or a gexp that will be passed as time specification in the mcron
job specification (@pxref{Syntax, mcron job specifications,, mcron,
GNU@tie{}mcron}).")
(included
(list-of-lowerables '())
"A list of values that are lowered to strings representing filesystem paths.
These are the paths that will be recursively included in the current job.")
(verbose?
(boolean #f)
"Whether to enable verbose output for the current backup job.")
(extra-flags
(list-of-lowerables '())
"A list of values that are lowered to strings. These will be passed as
command-line arguments to the current job @command{restic backup} invokation."))
(define list-of-restic-backup-jobs?
(list-of restic-backup-job?))
(define-configuration/no-serialization restic-backup-configuration
(jobs
(list-of-restic-backup-jobs '())
"The list of backup jobs for the current system."))
(define (restic-backup-job-program config)
(let ((restic
(file-append (restic-backup-job-restic config) "/bin/restic"))
(repository
(restic-backup-job-repository config))
(password-file
(restic-backup-job-password-file config))
(included
(restic-backup-job-included config))
(extra-flags
(restic-backup-job-extra-flags config))
(verbose
(if (restic-backup-job-verbose? config)
'("--verbose")
'())))
(program-file
"restic-backup-job.scm"
(with-imported-modules (source-module-closure
'((guix build utils)))
#~(begin
(use-modules (guix build utils)
(ice-9 popen)
(ice-9 rdelim))
(setenv "RESTIC_PASSWORD"
(with-input-from-file #$password-file read-line))
(execlp #$restic #$@verbose
"-r" #$repository
#$@extra-flags
"backup" #$@included))))))
(define (restic-backup-job->mcron-job config)
(let ((user
(restic-backup-job-user config))
(specification
(restic-backup-job-specification config))
(program
(restic-backup-job-program config)))
#~(job #$specification
#$program
#:user #$user)))
(define restic-backup-service-type
(service-type (name 'restic-backup)
(extensions
(list
(service-extension mcron-service-type
(lambda (config)
(map restic-backup-job->mcron-job
(restic-backup-configuration-jobs
config))))))
(compose concatenate)
(extend
(lambda (config jobs)
(restic-backup-configuration
(inherit config)
(jobs (append (restic-backup-configuration-jobs config)
jobs)))))
(default-value (restic-backup-configuration))
(description
"This service configures @code{mcron} jobs for running backups
with @code{restic}.")))
|