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
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
|
;;; guix-forge --- Guix software forge meta-service
;;; Copyright © 2022, 2023 Arun Isaac <arunisaac@systemreboot.net>
;;;
;;; This file is part of guix-forge.
;;;
;;; guix-forge 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.
;;;
;;; guix-forge 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 guix-forge. If not, see
;;; <https://www.gnu.org/licenses/>.
(define-module (forge tissue)
#:use-module (srfi srfi-1)
#:use-module (forge socket)
#:use-module (gnu build linux-container)
#:use-module ((gnu packages admin) #:select (shadow))
#:use-module ((gnu packages autotools) #:select (autoconf automake))
#:use-module ((gnu packages compression) #:select (lzip))
#:use-module ((gnu packages gettext) #:select (gnu-gettext))
#:use-module ((gnu packages guile) #:select (guile-3.0 guile-git))
#:use-module ((gnu packages guile-xyz) #:select (guile-filesystem guile-xapian))
#:use-module ((gnu packages skribilo) #:select (skribilo) #:prefix guix:)
#:use-module (gnu services)
#:use-module (gnu services shepherd)
#:use-module (gnu system file-systems)
#:use-module (gnu system shadow)
#:use-module (guix build-system gnu)
#:use-module (guix download)
#:use-module (guix gexp)
#:use-module (guix least-authority)
#:use-module (guix modules)
#:use-module (guix git-download)
#:use-module ((guix licenses) #:prefix license:)
#:use-module (guix packages)
#:use-module (guix records)
#:export (tissue-service-type
<tissue-configuration>
tissue-configuration
tissue-configuration?
tissue-configuration-package
tissue-configuration-socket
tissue-configuration-state-directory
tissue-configuration-hosts
<tissue-host>
tissue-host
tissue-host?
tissue-host-name
tissue-host-user
tissue-host-upstream-repository))
;; tissue requires an unreleased version of skribilo for its gemtext
;; reader.
(define-public skribilo-latest
(let ((commit "621eb1945aec8f26f5aee4bdf896f2434e145182")
(revision "1"))
(package
(inherit guix:skribilo)
(name "skribilo")
(version (git-version "0.9.5" revision commit))
(source (origin
(method git-fetch)
(uri (git-reference
(url "https://git.savannah.gnu.org/git/skribilo.git")
(commit commit)))
(file-name (git-file-name name version))
(sha256
(base32
"16rdcvszl9x183y32hjdwns0lkrvkmwd2fsshymspb12k4cxj6i4"))))
(native-inputs
(modify-inputs (package-native-inputs guix:skribilo)
(prepend autoconf)
(prepend automake)
(prepend gnu-gettext))))))
;; We use this commit of guile-xapian until the 0.4.0 release.
(define guile-xapian-latest
(let ((commit "93162fd60dbc0cce726113a82c13d88783a279b6")
(revision "1"))
(package
(inherit guile-xapian)
(name "guile-xapian")
(version (git-version (package-version guile-xapian) revision commit))
(source (origin
(method git-fetch)
(uri (git-reference
(url "https://git.systemreboot.net/guile-xapian")
(commit commit)))
(file-name (git-file-name name version))
(sha256
(base32
"0g9w10wsjw11ayi9l5y0k6lz4mq2qfhq2hwbxbqgdj7jmllwirgp")))))))
;; TODO: Contribute tissue package upstream to Guix after release of
;; its guile-xapian and skribilo dependencies.
(define-public tissue
(package
(name "tissue")
(version "0.1.0")
(source (origin
(method url-fetch)
(uri (string-append "https://tissue.systemreboot.net/releases/tissue-"
version ".tar.lz"))
(sha256
(base32
"0vsybgnzv8nnwf58pnxrs4101xczl8jvxd1wzmk4vmdyrp8a2kkm"))))
(build-system gnu-build-system)
(arguments
(list #:make-flags #~(list (string-append "prefix=" #$output))
#:modules `(((guix build guile-build-system)
#:select (target-guile-effective-version))
,@%gnu-build-system-modules)
#:phases
(with-imported-modules '((guix build guile-build-system))
#~(modify-phases %standard-phases
(replace 'patch-source-shebangs
(lambda* (#:key inputs #:allow-other-keys)
(substitute* "bin/tissue"
(("^exec guile")
(string-append "exec " (search-input-file inputs "/bin/guile"))))))
(delete 'configure)
(add-after 'install 'wrap
(lambda* (#:key inputs outputs #:allow-other-keys)
(let ((out (assoc-ref outputs "out"))
(effective-version (target-guile-effective-version)))
(wrap-program (string-append out "/bin/tissue")
`("GUILE_LOAD_PATH" prefix
(,(string-append out "/share/guile/site/" effective-version)
,(getenv "GUILE_LOAD_PATH")))
`("GUILE_LOAD_COMPILED_PATH" prefix
(,(string-append out "/lib/guile/" effective-version "/site-ccache")
,(getenv "GUILE_LOAD_COMPILED_PATH")))))))))))
(inputs (list guile-3.0 guile-filesystem guile-git guile-xapian-latest))
(native-inputs
(list lzip))
(propagated-inputs
(list skribilo-latest))
(home-page "https://tissue.systemreboot.net")
(synopsis "Text based project information management system")
(description
"tissue is an issue tracker and project information management system
built on plain text files and git. It features a static site
generator to build a project website and a powerful search interface
to search through project issues and documentation. The search
interface is built on the Xapian search engine library, and is
available both as a command-line program and as a web server.")
(license license:gpl3+)))
(define-record-type* <tissue-configuration>
tissue-configuration make-tissue-configuration
tissue-configuration?
(package tissue-configuration-package
(default tissue))
(socket tissue-configuration-socket
(default (forge-unix-socket
(path "/var/run/tissue/socket"))))
(state-directory tissue-configuration-state-directory
(default "/var/lib/tissue"))
(hosts tissue-configuration-hosts
(default '())))
(define-record-type* <tissue-host>
tissue-host make-tissue-host
tissue-host?
(name tissue-host-name)
(user tissue-host-user
(default "tissue"))
(upstream-repository tissue-host-upstream-repository))
(define %tissue-accounts
(list (user-account
(name "tissue")
(group "tissue")
(system? #t)
(comment "tissue user")
(home-directory "/var/empty")
(shell (file-append shadow "/sbin/nologin")))
(user-group
(name "tissue")
(system? #t))))
(define (tissue-conf-gexp config)
(match-record config <tissue-configuration>
(socket state-directory hosts)
#~(begin
(use-modules (ice-9 pretty-print))
(call-with-output-file #$output
(lambda (port)
(pretty-print
'((listen . #$(cond
((forge-ip-socket? socket)
(match-record socket <forge-ip-socket>
(ip port)
(string-append (if (ipv4-address? ip)
ip
(string-append "[" ip "]"))
":"
(number->string port))))
((forge-unix-socket? socket)
(string-append "unix:" (forge-unix-socket-path socket)))
(else (raise (condition
(make-message-condition
"Socket must be a <forge-ip-socket> or <forge-unix-socket> record")
(make-irritants-condition socket))))))
(state-directory . #$state-directory)
(hosts . #$(map (lambda (host)
(match-record host <tissue-host>
(name upstream-repository)
`(,name (upstream-repository . ,upstream-repository))))
hosts)))
port))))))
;; We cannot just pass the configuration file on the command-line
;; because we need future `tissue pull' invocations to find it. These
;; `tissue pull' invocations are beyond the scope of this service, and
;; will need to find the configuration at a standard location.
(define (tissue-etc-files config)
`(("tissue.conf" ,(computed-file "tissue.conf"
(tissue-conf-gexp config)))))
(define (tissue-activation config)
(match-record config <tissue-configuration>
(socket state-directory hosts)
(with-imported-modules '((guix build utils))
#~(begin
(use-modules (guix build utils)
(ice-9 match))
(let ((user (getpw "tissue")))
;; Create socket directory.
(when #$(forge-unix-socket? socket)
(let ((socket-directory #$(dirname (forge-unix-socket-path socket))))
(mkdir-p socket-directory)
(chown socket-directory (passwd:uid user) (passwd:gid user))))
;; Create state directory.
(mkdir-p #$state-directory)
(chown #$state-directory (passwd:uid user) (passwd:gid user)))
;; Create host directories if they don't exist, and set
;; permissions.
(for-each (match-lambda
((hostname username)
(let ((host-directory (string-append #$state-directory "/" hostname))
(user (getpw username)))
(mkdir-p host-directory)
(for-each (lambda (file)
(chown file (passwd:uid user) (passwd:gid user)))
(find-files host-directory #:directories? #t)))))
'#$(map (lambda (host)
(match-record host <tissue-host>
(name user)
(list name user)))
hosts))))))
(define (tissue-shepherd-service config)
(match-record config <tissue-configuration>
(socket state-directory)
(shepherd-service
(documentation "Run tissue web server.")
(provision '(tissue))
(requirement '(networking))
(start
(let ((tissue-conf (computed-file "tissue.conf" (tissue-conf-gexp config))))
#~(make-forkexec-constructor
(list #$(least-authority-wrapper
(file-append (tissue-configuration-package config)
"/bin/tissue")
#:name "tissue"
#:mappings (cons* (file-system-mapping
(source tissue-conf)
(target source))
(file-system-mapping
(source state-directory)
(target source))
(if (forge-unix-socket? socket)
(list (file-system-mapping
(source (dirname (forge-unix-socket-path socket)))
(target source)
(writable? #t)))
(list)))
;; TODO: If socket is a Unix socket, run in a
;; network namespace. We can't do this yet due to
;; https://yhetil.org/guix/m1ilknoi5r.fsf@fastmail.net/
#:namespaces (delq 'net %namespaces))
"web"
(string-append "--config=" #$tissue-conf))
#:user "tissue"
#:group "tissue"
#:log-file "/var/log/tissue.log")))
(stop #~(make-kill-destructor)))))
(define tissue-service-type
(service-type
(name 'tissue)
(description "Run tissue web server.")
(extensions
(list (service-extension account-service-type
(const %tissue-accounts))
(service-extension etc-service-type
tissue-etc-files)
(service-extension activation-service-type
tissue-activation)
(service-extension shepherd-root-service-type
(compose list tissue-shepherd-service))))
(compose concatenate)
(extend (lambda (config host-extensions)
(tissue-configuration
(inherit config)
(hosts (append (tissue-configuration-hosts config)
host-extensions)))))
(default-value (tissue-configuration))))
|
