Subject: [PATCH] gnu: services: Add xandikos-service-type.

From: Wilko Meyer <[email-masked]>
Date: Wed, 23 Oct 2024 17:02:57 +0200

* gnu/services/dav.scm: New file.
* gnu/local.mk (GNU_SYSTEM_MODULES): Add file.
* doc/guix.texi (DAV Services): Document the service.

Change-Id: I5345efd579f9e527eb8798397b52bf1b9b4cab56
---
Hi Guix,

I noticed that we already had a xandikos[0] package in Guix, but not a
corresponding service, so I decided to create one.

I took the liberty to add gnu/services/dav.scm as well as a DAV
Services section in our documentation. We do have another
CardDAV/CalDAV server available in guix, radicale, which currently
resides in (gnu services mail) and should probably be moved into (gnu
services dav) as well in the near future?

Kind regards,

Wilko

[0]: https://www.xandikos.org/

 doc/guix.texi        |  56 ++++++++++++++++++++++++
 gnu/local.mk         |   2 +
 gnu/services/dav.scm | 101 +++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 159 insertions(+)
 create mode 100644 gnu/services/dav.scm

diff --git a/doc/guix.texi b/doc/guix.texi
index ac3a7adef0..c423329dbf 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -132,6 +132,7 @@
 Copyright @copyright{} 2024 Fabio Natali@*
 Copyright @copyright{} 2024 Arnaud Daby-Seesaram@*
 Copyright @copyright{} 2024 Nigko Yerden@*
+Copyright @copyright{} 2024 Wilko Meyer@*
 
 Permission is granted to copy, distribute and/or modify this document
 under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -413,6 +414,7 @@ Top
 * DNS Services::                DNS daemons.
 * VNC Services::                VNC daemons.
 * VPN Services::                VPN daemons.
+* DAV Services::                DAV daemons.
 * Network File System::         NFS related services.
 * Samba Services::              Samba services.
 * Continuous Integration::      Cuirass and Laminar services.
@@ -19045,6 +19047,7 @@ Services
 * DNS Services::                DNS daemons.
 * VNC Services::                VNC daemons.
 * VPN Services::                VPN daemons.
+* DAV Services::                DAV daemons.
 * Network File System::         NFS related services.
 * Samba Services::              Samba services.
 * Continuous Integration::      Cuirass and Laminar services.
@@ -34511,6 +34514,59 @@ VPN Services
 @end table
 @end deftp
 
+@node DAV Services
+@subsection DAV Services
+
+@defvar xandikos-service-type
+This service starts @code{xandikos}, a a lightweight CardDAV/CalDAV
+server that backs onto a Git repository.
+
+The service's value is a @code{xandikos-configuration} record.
+@end defvar
+
+@deftp {Data Type} xandikos-configuration
+This is the data type representing the configuration for the
+xandikos-shepherd-service.
+
+It has the following parameters:
+
+@table @asis
+@item @code{package} (default: @code{xandikos})
+The @code{xandikos} package to use.
+
+@item @code{directory} (default: @code{"/var/xandikos/dav"})
+Directory to serve from.
+
+@item @code{listen-address} (default: @code{127.0.0.1})
+The address @code{xandikos} listens on.
+
+@item @code{port} (default: @code{8080})
+The port to run @code{xandikos} on.
+
+@item @code{current-user-principal} (default: @code{"/user/"})
+Path to current user principal.
+
+@item @code{route-prefix} (default: @code{"/"})
+Path to @code{xandikos} (useful when Xandikos is behind a reverse proxy).
+
+@item @code{defaults?} (default: @code{#t})
+Create initial calendar and address book. Implies --autocreate.
+
+@item @code{dump?} (default: @code{#f})
+Print DAV XML request/responses.
+
+@item @code{avahi?} (default: @code{#f})
+Announce services with avahi.
+
+@item @code{autocreate?} (default: @code{#f})
+Automatically create necessary directories.
+
+@item @code{no-strict?} (default: @code{#f})
+Enable workarounds for buggy CalDAV/CardDAV client implementations.
+@end table
+@end deftp
+
+
 @node Network File System
 @subsection Network File System
 @cindex NFS
diff --git a/gnu/local.mk b/gnu/local.mk
index 89a795bfbd..806e4a9a41 100644
--- a/gnu/local.mk
+++ b/gnu/local.mk
@@ -67,6 +67,7 @@
 # Copyright © 2024 David Elsing <[email-masked]>
 # Copyright © 2024 Ashish SHUKLA <[email-masked]>
 # Copyright © 2024 Fabio Natali <[email-masked]>
+# Copyright © 2024 Wilko Meyer <[email-masked]>
 #
 # This file is part of GNU Guix.
 #
@@ -716,6 +717,7 @@ GNU_SYSTEM_MODULES =				\
   %D%/services/cuirass.scm			\
   %D%/services/cups.scm				\
   %D%/services/databases.scm			\
+  %D%/services/dav.scm				\
   %D%/services/dbus.scm				\
   %D%/services/desktop.scm			\
   %D%/services/dict.scm				\
diff --git a/gnu/services/dav.scm b/gnu/services/dav.scm
new file mode 100644
index 0000000000..ae6c2ce969
--- /dev/null
+++ b/gnu/services/dav.scm
@@ -0,0 +1,101 @@
+;;; GNU Guix --- Functional package management for GNU
+;;; Copyright © 2024 Wilko Meyer <[email-masked]>
+;;;
+;;; 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 dav)
+  #:use-module (gnu services)
+  #:use-module (gnu services shepherd)
+  #:use-module (gnu services configuration)
+  #:use-module (gnu packages dav)
+  #:use-module (guix deprecation)
+  #:use-module (guix gexp)
+  #:use-module (guix records)
+  #:use-module (ice-9 match)
+  #:export (xandikos-configuration
+            xandikos-configuration?
+            xandikos-service-type))
+
+;;;
+;;; Xandikos
+;;;
+
+(define-configuration/no-serialization xandikos-configuration
+  (package
+    (file-like xandikos)
+    "Xandikos package to use.")
+  (directory
+   (string "/var/xandikos/dav")
+   "Directory to serve from.")
+  (listen-address
+   (string "127.0.0.1")
+   "The address Xandikos listens on.")
+  (port
+   (integer 8080)
+   "The port to run Xandikos on.")
+  (current-user-principal
+   (string "/user/")
+   "Path to current user principal.")
+  (route-prefix
+   (string "/")
+   "Path to Xandikos. (useful when Xandikos is behind a reverse proxy)")
+  (defaults?
+    (boolean #t)
+    "Create initial calendar and address book.")
+  (dump?
+   (boolean #f)
+   "Print DAV XML request/responses.")
+  (avahi?
+   (boolean #f)
+   "Announce services with avahi.")
+  (autocreate?
+   (boolean #f)
+   "Automatically create necessary directories.")
+  (no-strict?
+   (boolean #f)
+   "Enable workarounds for buggy CalDAV/CardDAV client implementations."))
+
+(define (xandikos-shepherd-service config)
+  (match-record config <xandikos-configuration>
+                (package directory listen-address port current-user-principal route-prefix defaults? dump? avahi? autocreate? no-strict?)
+    (list
+     (shepherd-service
+      (provision '(xandikos))
+      (documentation "Caldav/CardDAV server")
+      (requirement '(networking))
+      (start #~(make-forkexec-constructor
+                (list #$(file-append xandikos "/bin/xandikos")
+                      "--listen-address" #$listen-address
+                      "--port" #$(number->string port)
+                      "-d" #$directory
+                      "--route-prefix" #$route-prefix
+                      "--current-user-principal" #$current-user-principal
+                      #$@(if dump? '("--dump-dav-xml") '())
+                      #$@(if avahi? '("--avahi") '())
+                      #$@(if autocreate? '("--autocreate") '())
+                      #$@(if defaults? '("--defaults") '())
+                      #$@(if no-strict? '("--no-strict") '()))))
+      (stop #~(make-kill-destructor))
+      (respawn? #t)))))
+
+(define xandikos-service-type
+  (service-type
+   (name 'xandikos)
+   (extensions
+    (list (service-extension shepherd-root-service-type
+                             xandikos-shepherd-service)))
+   (default-value (xandikos-configuration))
+   (description "Service to run the @code{Xandikos} CalDAV/CardDAV server.")))

base-commit: 2b2b6a7675d43ff82487718c729cfaf5edf98c8d
-- 
2.46.0