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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
| | ;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2023 Janneke Nieuwenhuizen <janneke@gnu.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 home services shepherd-xyz)
#:use-module (srfi srfi-26)
#:use-module (ice-9 match)
#:use-module (shepherd support)
#:use-module (gnu home services)
#:use-module (gnu home services shepherd)
#:use-module (gnu packages kodi)
#:use-module (gnu packages messaging)
#:use-module (gnu packages ssh)
#:use-module (gnu packages version-control)
#:use-module (gnu services configuration)
#:use-module (gnu services shepherd)
#:use-module (guix records)
#:use-module (guix gexp)
#:export (home-git-daemon-configuration
home-git-daemon-service-type
home-kodi-configuration
home-kodi-service-type
home-ssh-agent-configuration
home-ssh-agent-service-type
home-znc-configuration
home-znc-service-type))
;;; Commentary:
;;
;; Home Services for the Shepherd.
;;
;; Example configurations.
;;
;; Git daemon: use $HOME/src as the base directory.
;;
;; (service home-git-service-type
;; (home-git-configuration
;; (root (string-append (getenv "HOME") "/src"))))
;;
;; Ssh-agent
;;
;; Add to your ~/.bash_profile:
;;
;; SSH_AUTH_SOCK=${XDG_RUNTIME_DIR-$HOME/.cache}/ssh-agent/socket
;; export SSH_AUTH_SOCK
;;
;; (service home-ssh-agent-service-type)
;;
;;; Code:
;;;
;;; Directories.
;;;
(define %user-data-home
;; Default cache directory if shepherd is run as a normal user.
(string-append (or (getenv "XDG_DATA_HOME")
(string-append user-homedir "/.local/share"))))
(define %user-log-dir
;; Default log directory if shepherd is run as a normal user.
(string-append (or (getenv "XDG_DATA_HOME")
(string-append user-homedir "/.local/var/log"))))
\f
;;;
;;; Git daemon.
;;;
(define-record-type* <home-git-daemon-configuration>
home-git-daemon-configuration make-home-git-daemon-configuration
home-git-daemon-configuration?
(git home-git-daemon-git ;file-like
(default git))
(root home-git-daemon-root ;string
(default (string-append %user-data-home
"/git-daemon")))
(export-all? home-git-daemon-export-all? ;boolean
(default #f))
(listen home-git-daemon-configuration-listen ;list of string
(default '()))
(port home-git-daemon-configuration-port ;number | #f
(default #f))
(whitelist home-git-daemon-configuration-whitelist ;list of string
(default '()))
(extra-options home-git-daemon-extra-options ;list of string
(default '())))
(define (home-git-daemon-services config)
"Return a <shepherd-service> for a git daemon with CONFIG."
(match config
(($ <home-git-daemon-configuration>
git root export-all? listen port whitelist extra-options)
(let* ((git (file-append git "/bin/git"))
(command `(,git
"daemon"
,(string-append "--base-path=" root)
,@(if export-all?
'("--export-all")
'())
,@(map (cute string-append "--listen=" <>) listen)
,@(if port
`(,(string-append
"--port=" (number->string port)))
'())
,@extra-options
,@whitelist))
(log-file (string-append %user-log-dir "/git-daemon.log")))
(list (shepherd-service
(documentation "Run the git daemon.")
(provision '(git-daemon))
(start #~(make-forkexec-constructor '#$command
#:log-file #$log-file))
(stop #~(make-kill-destructor))))))))
(define home-git-daemon-service-type
(service-type
(name 'home-git-daemon)
(default-value (home-git-daemon-configuration))
(extensions
(list (service-extension home-shepherd-service-type
home-git-daemon-services)))
(description
"Install and configure the git-daemon as a shepherd service.")))
\f
;;;
;;; Kodi.
;;;
(define-record-type* <home-kodi-configuration>
home-kodi-configuration make-home-kodi-configuration
home-kodi-configuration?
(kodi home-kodi-kodi ;file-like
(default kodi))
(extra-options home-kodi-extra-options ;list of string
(default '())))
(define (home-kodi-services config)
"Return a <shepherd-service> for kodi with CONFIG."
(match config
(($ <home-kodi-configuration> kodi extra-options)
(let* ((kodi (file-append kodi "/bin/kodi"))
(command `(kodi
"-fs"
,@extra-options))
(log-file (string-append %user-log-dir "/kodi.log")))
(list (shepherd-service
(documentation "Run the kodi media center.")
(provision '(kodi))
(start #~(make-forkexec-constructor '#$command
#:log-file #$log-file))
(stop #~(make-kill-destructor))))))))
(define home-kodi-service-type
(service-type
(name 'home-kodi)
(default-value (home-kodi-configuration))
(extensions
(list (service-extension home-shepherd-service-type
home-kodi-services)))
(description
"Install and configure kodi as a shepherd service.")))
\f
;;;
;;; Ssh-agent.
;;;
(define-record-type* <home-ssh-agent-configuration>
home-ssh-agent-configuration make-home-ssh-agent-configuration
home-ssh-agent-configuration?
(openssh home-ssh-agent-openssh ;file-like
(default openssh))
(socket-dir home-ssh-agent-socket-dir ;string
(default (string-append %user-runtime-dir "/ssh-agent")))
(extra-options home-ssh-agent-extra-options ;list of string
(default '())))
(define (home-ssh-agent-services config)
"Return a <shepherd-service> for an ssh-agent with CONFIG."
(match config
(($ <home-ssh-agent-configuration>
openssh socket-dir extra-options)
(let* ((ssh-agent (file-append openssh "/bin/ssh-agent"))
(socket-file (string-append socket-dir "/socket"))
(command `(,ssh-agent
"-D"
"-a" ,socket-file
,@extra-options))
(log-file (string-append %user-log-dir "/ssh-agent.log")))
(list (shepherd-service
(documentation "Run the ssh-agent.")
(provision '(ssh-agent))
(start #~(lambda _
(unless (file-exists? #$socket-dir)
(mkdir-p #$socket-dir)
(chmod #$socket-dir #o700))
(fork+exec-command '#$command #:log-file #$log-file)))
(stop #~(make-kill-destructor))))))))
(define home-ssh-agent-service-type
(service-type
(name 'home-ssh-agent)
(default-value (home-ssh-agent-configuration))
(extensions
(list (service-extension home-shepherd-service-type
home-ssh-agent-services)))
(description
"Install and configure the ssh-agent as a shepherd service.")))
\f
;;;
;;; Znc.
;;;
(define-record-type* <home-znc-configuration>
home-znc-configuration make-home-znc-configuration
home-znc-configuration?
(znc home-znc-znc ;string
(default znc))
(extra-options home-znc-extra-options ;list of string
(default '())))
(define (home-znc-services config)
"Return a <shepherd-service> for znc with CONFIG."
(match config
(($ <home-znc-configuration> znc extra-options)
(let* ((znc (file-append znc "/bin/znc"))
(command `(,znc
"--foreground"
,@extra-options))
(log-file (string-append %user-log-dir "/znc.log")))
(list (shepherd-service
(documentation "Run the znc IRC bouncer.")
(provision '(znc))
(start #~(make-forkexec-constructor '#$command
#:log-file #$log-file))
(stop #~(make-kill-destructor))))))))
(define home-znc-service-type
(service-type
(name 'home-znc)
(default-value (home-znc-configuration))
(extensions
(list (service-extension home-shepherd-service-type
home-znc-services)))
(description
"Install and configure znc as a shepherd service.")))
|