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
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
|
;;; GNU Guix --- Functional package management for GNU
;;; Copyright © 2021 Oleg Pykhalov <[email protected]>
;;; Copyright © 2023 Justin Veilleux <[email protected]>
;;; Copyright © 2025 Zacchaeus <[email protected]>
;;;
;;; 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 syncthing)
#:use-module (gnu packages syncthing)
#:use-module (gnu services)
#:use-module (gnu services shepherd)
#:use-module (guix gexp)
#:use-module (guix records)
#:use-module (ice-9 match)
#:use-module (srfi srfi-1)
#:use-module (sxml simple)
#:export (syncthing-configuration
syncthing-configuration?
syncthing-device
syncthing-device?
syncthing-config-file
syncthing-config-file?
syncthing-folder-device
syncthing-folder-device?
syncthing-folder
syncthing-folder?
syncthing-service-type
syncthing-shepherd-service
syncthing-files-service))
;;; Commentary:
;;;
;;; This module provides a service definition for the syncthing service.
;;;
;;; Code:
(define-record-type* <syncthing-device>
syncthing-device make-syncthing-device
syncthing-device?
(id syncthing-device-id)
(name syncthing-device-name (default ""))
(compression syncthing-device-compression (default "metadata"))
(introducer syncthing-device-introducer (default "false"))
(skip-introduction-removals syncthing-device-skip-introduction-removals (default "false"))
(introduced-by syncthing-device-introduced-by (default ""))
(addresses syncthing-device-addresses (default '("dynamic")))
(paused syncthing-device-paused (default "false"))
(auto-accept-folders syncthing-device-auto-accept-folders (default "false"))
(max-send-kbps syncthing-device-max-send-kbps (default "0"))
(max-recv-kbps syncthing-device-max-recv-kbps (default "0"))
(max-request-kib syncthing-device-max-request-kib (default "0"))
(untrusted syncthing-device-untrusted (default "false"))
(remote-gui-port syncthing-device-remote-gui-port (default "0"))
(num-connections syncthing-device-num-connections (default "0")))
(define syncthing-device->sxml
(match-record-lambda <syncthing-device>
(id
name compression introducer skip-introduction-removals introduced-by
addresses paused auto-accept-folders max-send-kbps max-recv-kbps
max-request-kib untrusted remote-gui-port num-connections)
`(device (@ (id ,id)
(name ,name)
(compression ,compression)
(introducer ,introducer)
(skipIntroductionRemovals ,skip-introduction-removals)
(introducedBy ,introduced-by))
,@(map (lambda (address) `(address ,address)) addresses)
(paused ,paused)
(autoAcceptFolders ,auto-accept-folders)
(maxSendKbps ,max-send-kbps)
(maxRecvKbps ,max-recv-kbps)
(maxRequestKiB ,max-request-kib)
(untrusted ,untrusted)
(remoteGUIPort ,remote-gui-port)
(numConnections ,num-connections))))
(define-record-type* <syncthing-folder-device>
syncthing-folder-device make-syncthing-folder-device
syncthing-folder-device?
(device syncthing-folder-device-device)
(introduced-by syncthing-folder-device-introduced-by (default (syncthing-device (id ""))))
(encryption-password syncthing-folder-device-encryption-password (default "")))
(define syncthing-folder-device->sxml
(match-record-lambda <syncthing-folder-device>
(device introduced-by encryption-password)
`(device (@ (id ,(syncthing-device-id device))
(introducedBy ,(syncthing-device-id introduced-by)))
(encryptionPassword ,encryption-password))))
(define-record-type* <syncthing-folder>
syncthing-folder make-syncthing-folder
syncthing-folder?
(id syncthing-folder-id (default #f))
(label syncthing-folder-label)
(path syncthing-folder-path)
(type syncthing-folder-type (default "sendreceive"))
(rescan-interval-s syncthing-folder-rescan-interval-s (default "3600"))
(fs-watcher-enabled syncthing-folder-fs-watcher-enabled (default "true"))
(fs-watcher-delay-s syncthing-folder-fs-watcher-delay-s (default "10"))
(fs-watcher-timeout-s syncthing-folder-fs-watcher-timeout-s (default "0"))
(ignore-perms syncthing-folder-ignore-perms (default "false"))
(auto-normalize syncthing-folder-auto-normalize (default "true"))
(devices syncthing-folder-devices (default '())
(sanitize (lambda (folder-device-list)
(map (lambda (device)
(if (syncthing-folder-device? device)
device
(syncthing-folder-device (device device))))
folder-device-list))))
(filesystem-type syncthing-folder-filesystem-type (default "basic"))
(min-disk-free-unit syncthing-folder-min-disk-free-unit (default "%"))
(min-disk-free syncthing-folder-min-disk-free (default "1"))
(versioning-type syncthing-folder-versioning-type (default #f))
(versioning-fs-path syncthing-folder-versioning-fs-path (default ""))
(versioning-fs-type syncthing-folder-versioning-fs-type (default "basic"))
(versioning-cleanup-interval-s syncthing-folder-versioning-cleanup-interval-s (default "3600"))
(versioning-cleanout-days syncthing-folder-versioning-cleanout-days (default #f))
(versioning-keep syncthing-folder-versioning-keep (default #f))
(versioning-max-age syncthing-folder-versioning-max-age (default #f))
(versioning-command syncthing-folder-versioning-command (default #f))
(copiers syncthing-folder-copiers (default "0"))
(puller-max-pending-kib syncthing-folder-puller-max-pending-kib (default "0"))
(hashers syncthing-folder-hashers (default "0"))
(order syncthing-folder-order (default "random"))
(ignore-delete syncthing-folder-ignore-delete (default "false"))
(scan-progress-interval-s syncthing-folder-scan-progress-interval-s (default "0"))
(puller-pause-s syncthing-folder-puller-pause-s (default "0"))
(max-conflicts syncthing-folder-max-conflicts (default "10"))
(disable-sparse-files syncthing-folder-disable-sparse-files (default "false"))
(disable-temp-indexes syncthing-folder-disable-temp-indexes (default "false"))
(paused syncthing-folder-paused (default "false"))
(weak-hash-threshold-pct syncthing-folder-weak-hash-threshold-pct (default "25"))
(marker-name syncthing-folder-marker-name (default ".stfolder"))
(copy-ownership-from-parent syncthing-folder-copy-ownership-from-parent (default "false"))
(mod-time-window-s syncthing-folder-mod-time-window-s (default "0"))
(max-concurrent-writes syncthing-folder-max-concurrent-writes (default "2"))
(disable-fsync syncthing-folder-disable-fsync (default "false"))
(block-pull-order syncthing-folder-block-pull-order (default "standard"))
(copy-range-method syncthing-folder-copy-range-method (default "standard"))
(case-sensitive-fs syncthing-folder-case-sensitive-fs (default "false"))
(junctions-as-dirs syncthing-folder-junctions-as-dirs (default "false"))
(sync-ownership syncthing-folder-sync-ownership (default "false"))
(send-ownership syncthing-folder-send-ownership (default "false"))
(sync-xattrs syncthing-folder-sync-xattrs (default "false"))
(send-xattrs syncthing-folder-send-xattrs (default "false"))
(xattr-filter-max-single-entry-size syncthing-folder-xattr-filter-max-single-entry-size (default "1024"))
(xattr-filter-max-total-size syncthing-folder-xattr-filter-max-total-size (default "4096")))
;; Some parameters, when empty, are fully omitted from the config file. It is
;; unknown if this causes a functional difference, but stick to the normal
;; program's behavior to be safe.
(define (maybe-param symbol value)
(if value `((param (@ (key ,(symbol->string symbol)) (val ,value)) "")) '()))
(define syncthing-folder->sxml
(match-record-lambda <syncthing-folder>
(id
label path type rescan-interval-s fs-watcher-enabled fs-watcher-delay-s
fs-watcher-timeout-s ignore-perms auto-normalize devices filesystem-type
min-disk-free-unit min-disk-free versioning-type versioning-fs-path
versioning-fs-type versioning-cleanup-interval-s versioning-cleanout-days
versioning-keep versioning-max-age versioning-command copiers
puller-max-pending-kib hashers order ignore-delete scan-progress-interval-s
puller-pause-s max-conflicts disable-sparse-files disable-temp-indexes paused
weak-hash-threshold-pct marker-name copy-ownership-from-parent mod-time-window-s
max-concurrent-writes disable-fsync block-pull-order copy-range-method
case-sensitive-fs junctions-as-dirs sync-ownership send-ownership sync-xattrs
send-xattrs xattr-filter-max-single-entry-size xattr-filter-max-total-size)
`(folder (@ (id ,(if id id label))
(label ,label)
(path ,path)
(type ,type)
(rescanIntervalS ,rescan-interval-s)
(fsWatcherEnabled ,fs-watcher-enabled)
(fsWatcherDelayS ,fs-watcher-delay-s)
(fsWatcherTimeoutS ,fs-watcher-timeout-s)
(ignorePerms ,ignore-perms)
(autoNormalize ,auto-normalize))
(filesystemType ,filesystem-type)
,@(map syncthing-folder-device->sxml
devices)
(minDiskFree (@ (unit ,min-disk-free-unit))
,min-disk-free)
(versioning ,@(if versioning-type
`((@ (type ,versioning-type)))
'())
,@(maybe-param 'cleanoutDays versioning-cleanout-days)
,@(maybe-param 'keep versioning-keep)
,@(maybe-param 'maxAge versioning-max-age)
,@(maybe-param 'command versioning-command)
(cleanupIntervalS ,versioning-cleanup-interval-s)
(fsPath ,versioning-fs-path)
(fsType ,versioning-fs-type))
(copiers ,copiers)
(pullerMaxPendingKiB ,puller-max-pending-kib)
(hashers ,hashers)
(order ,order)
(ignoreDelete ,ignore-delete)
(scanProgressIntervalS ,scan-progress-interval-s)
(pullerPauseS ,puller-pause-s)
(maxConflicts ,max-conflicts)
(disableSparseFiles ,disable-sparse-files)
(disableTempIndexes ,disable-temp-indexes)
(paused ,paused)
(weakHashThresholdPct ,weak-hash-threshold-pct)
(markerName ,marker-name)
(copyOwnershipFromParent ,copy-ownership-from-parent)
(modTimeWindowS ,mod-time-window-s)
(maxConcurrentWrites ,max-concurrent-writes)
(disableFsync ,disable-fsync)
(blockPullOrder ,block-pull-order)
(copyRangeMethod ,copy-range-method)
(caseSensitiveFS ,case-sensitive-fs)
(junctionsAsDirs ,junctions-as-dirs)
(syncOwnership ,sync-ownership)
(sendOwnership ,send-ownership)
(syncXattrs ,sync-xattrs)
(sendXattrs ,send-xattrs)
(xattrFilter (maxSingleEntrySize ,xattr-filter-max-single-entry-size)
(maxTotalSize ,xattr-filter-max-total-size)))))
(define-record-type* <syncthing-config-file>
syncthing-config-file make-syncthing-config-file
syncthing-config-file?
(folders syncthing-config-folders
; this matches syncthing's default
(default (list (syncthing-folder (id "default")
(label "Default Folder")
(path "~/Sync")))))
(devices syncthing-config-devices
(default '()))
(gui-enabled syncthing-config-gui-enabled (default "true"))
(gui-tls syncthing-config-gui-tls (default "false"))
(gui-debugging syncthing-config-gui-debugging (default "false"))
(gui-send-basic-auth-prompt syncthing-config-gui-send-basic-auth-prompt (default "false"))
(gui-address syncthing-config-gui-address (default "127.0.0.1:8384"))
(gui-user syncthing-config-gui-user (default #f))
(gui-password syncthing-config-gui-password (default #f))
(gui-apikey syncthing-config-gui-apikey (default #f))
(gui-theme syncthing-config-gui-theme (default "default"))
(ldap-enabled syncthing-config-ldap-enabled (default #f))
(ldap-address syncthing-config-ldap-address (default ""))
(ldap-bind-dn syncthing-config-ldap-bind-dn (default ""))
(ldap-transport syncthing-config-ldap-transport (default ""))
(ldap-insecure-skip-verify syncthing-config-ldap-insecure-skip-verify (default ""))
(ldap-search-base-dn syncthing-config-ldap-search-base-dn (default ""))
(ldap-search-filter syncthing-config-ldap-search-filter (default ""))
(listen-address syncthing-config-listen-address (default "default"))
(global-announce-server syncthing-config-global-announce-server (default "default"))
(global-announce-enabled syncthing-config-global-announce-enabled (default "true"))
(local-announce-enabled syncthing-config-local-announce-enabled (default "true"))
(local-announce-port syncthing-config-local-announce-port (default "21027"))
(local-announce-mcaddr syncthing-config-local-announce-mcaddr (default "[ff12::8384]:21027"))
(max-send-kbps syncthing-config-max-send-kbps (default "0"))
(max-recv-kbps syncthing-config-max-recv-kbps (default "0"))
(reconnection-interval-s syncthing-config-reconnection-interval-s (default "60"))
(relays-enabled syncthing-config-relays-enabled (default "true"))
(relay-reconnect-interval-m syncthing-config-relay-reconnect-interval-m (default "10"))
(start-browser syncthing-config-start-browser (default "true"))
(nat-enabled syncthing-config-nat-enabled (default "true"))
(nat-lease-minutes syncthing-config-nat-lease-minutes (default "60"))
(nat-renewal-minutes syncthing-config-nat-renewal-minutes (default "30"))
(nat-timeout-seconds syncthing-config-nat-timeout-seconds (default "10"))
(ur-accepted syncthing-config-ur-accepted (default "0"))
(ur-seen syncthing-config-ur-seen (default "0"))
(ur-unique-id syncthing-config-ur-unique-id (default ""))
(ur-url syncthing-config-ur-url (default "https://data.syncthing.net/newdata"))
(ur-post-insecurely syncthing-config-ur-post-insecurely (default "false"))
(ur-initial-delay-s syncthing-config-ur-initial-delay-s (default "1800"))
(auto-upgrade-interval-h syncthing-config-auto-upgrade-interval-h (default "12"))
(upgrade-to-pre-releases syncthing-config-upgrade-to-pre-releases (default "false"))
(keep-temporaries-h syncthing-config-keep-temporaries-h (default "24"))
(cache-ignored-files syncthing-config-cache-ignored-files (default "false"))
(progress-update-interval-s syncthing-config-progress-update-interval-s (default "5"))
(limit-bandwidth-in-lan syncthing-config-limit-bandwidth-in-lan (default "false"))
(min-home-disk-free-unit syncthing-config-min-home-disk-free-unit (default "%"))
(min-home-disk-free syncthing-config-min-home-disk-free (default "1"))
(releases-url syncthing-config-releases-url (default "https://upgrades.syncthing.net/meta.json"))
(overwrite-remote-device-names-on-connect syncthing-config-overwrite-remote-device-names-on-connect (default "false"))
(temp-index-min-blocks syncthing-config-temp-index-min-blocks (default "10"))
(unacked-notification-id syncthing-config-unacked-notification-id (default "authenticationUserAndPassword"))
(traffic-class syncthing-config-traffic-class (default "0"))
(set-low-priority syncthing-config-set-low-priority (default "true"))
(max-folder-concurrency syncthing-config-max-folder-concurrency (default "0"))
(crash-reporting-url syncthing-config-crash-reporting-url (default "https://crash.syncthing.net/newcrash"))
(crash-reporting-enabled syncthing-config-crash-reporting-enabled (default "true"))
(stun-keepalive-start-s syncthing-config-stun-keepalive-start-s (default "180"))
(stun-keepalive-min-s syncthing-config-stun-keepalive-min-s (default "20"))
(stun-server syncthing-config-stun-server (default "default"))
(database-tuning syncthing-config-database-tuning (default "auto"))
(max-concurrent-incoming-request-kib syncthing-config-max-concurrent-incoming-request-kib (default "0"))
(announce-lan-addresses syncthing-config-announce-lan-addresses (default "true"))
(send-full-index-on-upgrade syncthing-config-send-full-index-on-upgrade (default "false"))
(connection-limit-enough syncthing-config-connection-limit-enough (default "0"))
(connection-limit-max syncthing-config-connection-limit-max (default "0"))
(insecure-allow-old-tlsVersions syncthing-config-insecure-allow-old-tlsVersions (default "false"))
(connection-priority-tcp-lan syncthing-config-connection-priority-tcp-lan (default "10"))
(connection-priority-quic-lan syncthing-config-connection-priority-quic-lan (default "20"))
(connection-priority-tcp-wan syncthing-config-connection-priority-tcp-wan (default "30"))
(connection-priority-quic-wan syncthing-config-connection-priority-quic-wan (default "40"))
(connection-priority-relay syncthing-config-connection-priority-relay (default "50"))
(connection-priority-upgrade-threshold syncthing-config-connection-priority-upgrade-threshold (default "0"))
(default-folder syncthing-config-default-folder
(default (syncthing-folder (label "") (path "~"))))
(default-device syncthing-config-default-device
(default (syncthing-device (id ""))))
(default-ignores syncthing-config-default-ignores (default "")))
(define syncthing-config-file->sxml
(match-record-lambda <syncthing-config-file>
(folders
devices gui-enabled gui-tls gui-debugging gui-send-basic-auth-prompt
gui-address gui-user gui-password gui-apikey gui-theme ldap-enabled
ldap-address ldap-bind-dn ldap-transport ldap-insecure-skip-verify
ldap-search-base-dn ldap-search-filter listen-address global-announce-server
global-announce-enabled local-announce-enabled local-announce-port
local-announce-mcaddr max-send-kbps max-recv-kbps reconnection-interval-s
relays-enabled relay-reconnect-interval-m start-browser nat-enabled
nat-lease-minutes nat-renewal-minutes nat-timeout-seconds ur-accepted
ur-seen ur-unique-id ur-url ur-post-insecurely ur-initial-delay-s
auto-upgrade-interval-h upgrade-to-pre-releases keep-temporaries-h
cache-ignored-files progress-update-interval-s limit-bandwidth-in-lan
min-home-disk-free-unit min-home-disk-free releases-url
overwrite-remote-device-names-on-connect temp-index-min-blocks
unacked-notification-id traffic-class set-low-priority max-folder-concurrency
crash-reporting-url crash-reporting-enabled stun-keepalive-start-s
stun-keepalive-min-s stun-server database-tuning
max-concurrent-incoming-request-kib announce-lan-addresses
send-full-index-on-upgrade connection-limit-enough connection-limit-max
insecure-allow-old-tlsVersions connection-priority-tcp-lan
connection-priority-quic-lan connection-priority-tcp-wan
connection-priority-quic-wan connection-priority-relay
connection-priority-upgrade-threshold default-folder default-device
default-ignores)
`(configuration (@ (version "37"))
,@(map syncthing-folder->sxml
folders)
;; collect any devices in any folders, as well as any
;; devices explicitly added.
,@(map syncthing-device->sxml
(delete-duplicates
(append devices
(apply append
(map (lambda (folder)
(map syncthing-folder-device-device
(syncthing-folder-devices folder)))
folders)))
;; devices are the same if their id's are equal
(lambda (device1 device2)
(string= (syncthing-device-id device1)
(syncthing-device-id device2)))))
(gui (@ (enabled ,gui-enabled)
(tls ,gui-tls)
(debugging ,gui-debugging)
(sendBasicAuthPrompt ,gui-send-basic-auth-prompt))
(address ,gui-address)
,@(if gui-user `((user ,gui-user)) '())
,@(if gui-password `((password ,gui-password)) '())
,@(if gui-apikey `((apikey ,gui-apikey)) '())
(theme ,gui-theme))
(ldap ,(if ldap-enabled
`((address ,ldap-address)
(bindDN ,ldap-bind-dn)
,@(if ldap-transport
`((transport ,ldap-transport))
'())
,@(if ldap-insecure-skip-verify
`((insecureSkipVerify ,ldap-insecure-skip-verify))
'())
,@(if ldap-search-base-dn
`((searchBaseDN ,ldap-search-base-dn))
'())
,@(if ldap-search-filter
`((searchFilter ,ldap-search-filter))
'()))
""))
(options (listenAddress ,listen-address)
(globalAnnounceServer ,global-announce-server)
(globalAnnounceEnabled ,global-announce-enabled)
(localAnnounceEnabled ,local-announce-enabled)
(localAnnouncePort ,local-announce-port)
(localAnnounceMCAddr ,local-announce-mcaddr)
(maxSendKbps ,max-send-kbps)
(maxRecvKbps ,max-recv-kbps)
(reconnectionIntervalS ,reconnection-interval-s)
(relaysEnabled ,relays-enabled)
(relayReconnectIntervalM ,relay-reconnect-interval-m)
(startBrowser ,start-browser)
(natEnabled ,nat-enabled)
(natLeaseMinutes ,nat-lease-minutes)
(natRenewalMinutes ,nat-renewal-minutes)
(natTimeoutSeconds ,nat-timeout-seconds)
(urAccepted ,ur-accepted)
(urSeen ,ur-seen)
(urUniqueID ,ur-unique-id)
(urURL ,ur-url)
(urPostInsecurely ,ur-post-insecurely)
(urInitialDelayS ,ur-initial-delay-s)
(autoUpgradeIntervalH ,auto-upgrade-interval-h)
(upgradeToPreReleases ,upgrade-to-pre-releases)
(keepTemporariesH ,keep-temporaries-h)
(cacheIgnoredFiles ,cache-ignored-files)
(progressUpdateIntervalS ,progress-update-interval-s)
(limitBandwidthInLan ,limit-bandwidth-in-lan)
(minHomeDiskFree (@ (unit ,min-home-disk-free-unit))
,min-home-disk-free)
(releasesURL ,releases-url)
(overwriteRemoteDeviceNamesOnConnect ,overwrite-remote-device-names-on-connect)
(tempIndexMinBlocks ,temp-index-min-blocks)
(unackedNotificationID ,unacked-notification-id)
(trafficClass ,traffic-class)
(setLowPriority ,set-low-priority)
(maxFolderConcurrency ,max-folder-concurrency)
(crashReportingURL ,crash-reporting-url)
(crashReportingEnabled ,crash-reporting-enabled)
(stunKeepaliveStartS ,stun-keepalive-start-s)
(stunKeepaliveMinS ,stun-keepalive-min-s)
(stunServer ,stun-server)
(databaseTuning ,database-tuning)
(maxConcurrentIncomingRequestKiB ,max-concurrent-incoming-request-kib)
(announceLANAddresses ,announce-lan-addresses)
(sendFullIndexOnUpgrade ,send-full-index-on-upgrade)
(connectionLimitEnough ,connection-limit-enough)
(connectionLimitMax ,connection-limit-max)
(insecureAllowOldTLSVersions ,insecure-allow-old-tlsVersions)
(connectionPriorityTcpLan ,connection-priority-tcp-lan)
(connectionPriorityQuicLan ,connection-priority-quic-lan)
(connectionPriorityTcpWan ,connection-priority-tcp-wan)
(connectionPriorityQuicWan ,connection-priority-quic-wan)
(connectionPriorityRelay ,connection-priority-relay)
(connectionPriorityUpgradeThreshold ,connection-priority-upgrade-threshold))
(defaults
,(syncthing-folder->sxml default-folder)
,(syncthing-device->sxml default-device)
(ignores ,default-ignores)))))
(define (serialize-syncthing-config-file config)
(with-output-to-string
(lambda ()
(sxml->xml (cons '*TOP* (list (syncthing-config-file->sxml config)))))))
(define-record-type* <syncthing-configuration>
syncthing-configuration make-syncthing-configuration
syncthing-configuration?
(syncthing syncthing-configuration-syncthing ;file-like
(default syncthing))
(arguments syncthing-configuration-arguments ;list of strings
(default '()))
(logflags syncthing-configuration-logflags ;number
(default 0))
(user syncthing-configuration-user ;string
(default #f))
(group syncthing-configuration-group ;string
(default "users"))
(home syncthing-configuration-home ;string
(default #f))
(config-file syncthing-configuration-config-file
(default #f)) ; syncthing-config-file or file-like
(home-service? syncthing-configuration-home-service?
(default for-home?) (innate)))
(define syncthing-shepherd-service
(match-record-lambda <syncthing-configuration>
(syncthing arguments logflags user group home home-service? config-file)
(list
(shepherd-service
(provision (if home-service?
'(syncthing)
(list (string->symbol
(string-append "syncthing-" user)))))
(documentation "Run syncthing.")
(requirement (if home-service? '() '(loopback user-processes)))
(start #~(lambda _
;; If we are managing the config, and it's not a home
;; service, then exepect the config file at
;; /var/lib/syncthing-<user>. This makes sure the ownership
;; is correct.
(unless (or #$(not config-file) #$home-service?)
(let ((user-pw (getpw #$user)))
(chown (string-append "/var/lib/syncthing-" #$user)
(passwd:uid user-pw)
(passwd:gid user-pw)))
(chmod (string-append "/var/lib/syncthing-" #$user) #o700))
(make-forkexec-constructor
(append (list (string-append #$syncthing "/bin/syncthing")
;; Do not try to try to launch a web browser on startup.
"--no-browser"
;; If syncthing crashes, let the service fail.
"--no-restart"
(string-append "--logflags=" (number->string #$logflags)))
;; Optionally move data and configuration home to
;; /var/lib/syncthing-<user>.
(if (or #$(not config-file) #$home-service?) '()
(list (string-append "--home=/var/lib/syncthing-" #$user)))
'#$arguments)
#:user #$(and (not home-service?) user)
#:group #$(and (not home-service?) group)
#:environment-variables
(append
(list
(string-append "HOME="
(or #$home
(passwd:dir
(getpw (if (and #$home-service?
(not #$user))
(getuid)
#$user)))))
"SSL_CERT_DIR=/etc/ssl/certs"
"SSL_CERT_FILE=/etc/ssl/certs/ca-certificates.crt")
(filter (negate ;XXX: 'remove' is not in (guile)
(lambda (str)
(or (string-prefix? "HOME=" str)
(string-prefix? "SSL_CERT_DIR=" str)
(string-prefix? "SSL_CERT_FILE=" str))))
(environ))))))
(respawn? #f)
(stop #~(make-kill-destructor))))))
(define syncthing-files-service
(match-record-lambda <syncthing-configuration> (config-file user home home-service?)
(if config-file
;; When used as a system service, this service might be executed
;; before a user's home even exists, causing it to be owned by root,
;; and the skeletons to never be applied to that user's home. In such
;; cases, put the config at /var/lib/syncthnig-<user>/config.xml
`((,(if home-service?
".config/syncthing/config.xml"
(string-append "/var/lib/syncthing-" user "/config.xml"))
,(if (file-like? config-file)
config-file
(plain-file "syncthin-config.xml" (serialize-syncthing-config-file
config-file)))))
'())))
(define syncthing-service-type
(service-type (name 'syncthing)
(extensions (list (service-extension shepherd-root-service-type
syncthing-shepherd-service)
(service-extension special-files-service-type
syncthing-files-service)))
(description
"Run @uref{https://github.com/syncthing/syncthing, Syncthing}
decentralized continuous file system synchronization.")))
;;; syncthing.scm ends here
|
