diff options
| author | Wilko Meyer <w@wmeyer.eu> | 2024-10-23 17:02:57 +0200 |
|---|---|---|
| committer | Ricardo Wurmus <rekado@elephly.net> | 2026-02-09 16:27:42 +0100 |
| commit | eee1bfbec5f281fb3b21b0d6bc4db88187d113b5 (patch) | |
| tree | fbb48067df66fe72fd619033e92e6720a7637a23 /doc | |
| parent | 84d6e780e1cf42caae8b9f9b0321267d99da4ddb (diff) | |
gnu: services: Add xandikos-service-type.
* 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
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix.texi | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index cb22e612e42..9d41b43d94e 100644 --- a/doc/guix.texi +++ b/doc/guix.texi | |||
| @@ -131,6 +131,7 @@ Copyright @copyright{} 2024 Dariqq@* | |||
| 131 | Copyright @copyright{} 2024 Denis 'GNUtoo' Carikli@* | 131 | Copyright @copyright{} 2024 Denis 'GNUtoo' Carikli@* |
| 132 | Copyright @copyright{} 2024 Fabio Natali@* | 132 | Copyright @copyright{} 2024 Fabio Natali@* |
| 133 | Copyright @copyright{} 2024 Arnaud Daby-Seesaram@* | 133 | Copyright @copyright{} 2024 Arnaud Daby-Seesaram@* |
| 134 | Copyright @copyright{} 2024 Wilko Meyer@* | ||
| 134 | Copyright @copyright{} 2024-2025 Nigko Yerden@* | 135 | Copyright @copyright{} 2024-2025 Nigko Yerden@* |
| 135 | Copyright @copyright{} 2024 Troy Figiel@* | 136 | Copyright @copyright{} 2024 Troy Figiel@* |
| 136 | Copyright @copyright{} 2024 Sharlatan Hellseher@* | 137 | Copyright @copyright{} 2024 Sharlatan Hellseher@* |
| @@ -431,6 +432,7 @@ Services | |||
| 431 | * DNS Services:: DNS daemons. | 432 | * DNS Services:: DNS daemons. |
| 432 | * VNC Services:: VNC daemons. | 433 | * VNC Services:: VNC daemons. |
| 433 | * VPN Services:: VPN daemons. | 434 | * VPN Services:: VPN daemons. |
| 435 | * DAV Services:: DAV daemons. | ||
| 434 | * Network File System:: NFS related services. | 436 | * Network File System:: NFS related services. |
| 435 | * Samba Services:: Samba services. | 437 | * Samba Services:: Samba services. |
| 436 | * Continuous Integration:: Cuirass and Laminar services. | 438 | * Continuous Integration:: Cuirass and Laminar services. |
| @@ -19882,6 +19884,7 @@ declaration. | |||
| 19882 | * DNS Services:: DNS daemons. | 19884 | * DNS Services:: DNS daemons. |
| 19883 | * VNC Services:: VNC daemons. | 19885 | * VNC Services:: VNC daemons. |
| 19884 | * VPN Services:: VPN daemons. | 19886 | * VPN Services:: VPN daemons. |
| 19887 | * DAV Services:: DAV daemons. | ||
| 19885 | * Network File System:: NFS related services. | 19888 | * Network File System:: NFS related services. |
| 19886 | * Samba Services:: Samba services. | 19889 | * Samba Services:: Samba services. |
| 19887 | * Continuous Integration:: Cuirass and Laminar services. | 19890 | * Continuous Integration:: Cuirass and Laminar services. |
| @@ -37736,6 +37739,60 @@ a firewall. | |||
| 37736 | @end table | 37739 | @end table |
| 37737 | @end deftp | 37740 | @end deftp |
| 37738 | 37741 | ||
| 37742 | @node DAV Services | ||
| 37743 | @subsection DAV Services | ||
| 37744 | @cindex CalDAV | ||
| 37745 | |||
| 37746 | @defvar xandikos-service-type | ||
| 37747 | This service starts @code{xandikos}, a lightweight CardDAV/CalDAV | ||
| 37748 | server backed by a Git repository. | ||
| 37749 | |||
| 37750 | The service's value is a @code{xandikos-configuration} record. | ||
| 37751 | @end defvar | ||
| 37752 | |||
| 37753 | @deftp {Data Type} xandikos-configuration | ||
| 37754 | This is the data type representing the configuration for the | ||
| 37755 | @code{xandikos-shepherd-service}. | ||
| 37756 | |||
| 37757 | It has the following parameters: | ||
| 37758 | |||
| 37759 | @table @asis | ||
| 37760 | @item @code{package} (default: @code{xandikos}) | ||
| 37761 | The @code{xandikos} package to use. | ||
| 37762 | |||
| 37763 | @item @code{directory} (default: @code{"/var/xandikos/dav"}) | ||
| 37764 | The directory to serve from. | ||
| 37765 | |||
| 37766 | @item @code{listen-address} (default: @code{127.0.0.1}) | ||
| 37767 | The address @command{xandikos} listens on. | ||
| 37768 | |||
| 37769 | @item @code{port} (default: @code{8080}) | ||
| 37770 | The port to run @command{xandikos} on. | ||
| 37771 | |||
| 37772 | @item @code{current-user-principal} (default: @code{"/user/"}) | ||
| 37773 | Path to current user principal. | ||
| 37774 | |||
| 37775 | @item @code{route-prefix} (default: @code{"/"}) | ||
| 37776 | Path to @command{xandikos} (useful when Xandikos is behind a reverse proxy). | ||
| 37777 | |||
| 37778 | @item @code{defaults?} (default: @code{#t}) | ||
| 37779 | Create initial calendar and address book. Implies @option{--autocreate}. | ||
| 37780 | |||
| 37781 | @item @code{dump?} (default: @code{#f}) | ||
| 37782 | Print DAV XML request/responses. | ||
| 37783 | |||
| 37784 | @item @code{avahi?} (default: @code{#f}) | ||
| 37785 | Announce services with avahi. | ||
| 37786 | |||
| 37787 | @item @code{autocreate?} (default: @code{#f}) | ||
| 37788 | Automatically create necessary directories. | ||
| 37789 | |||
| 37790 | @item @code{no-strict?} (default: @code{#f}) | ||
| 37791 | Enable workarounds for buggy CalDAV/CardDAV client implementations. | ||
| 37792 | @end table | ||
| 37793 | @end deftp | ||
| 37794 | |||
| 37795 | |||
| 37739 | @node Network File System | 37796 | @node Network File System |
| 37740 | @subsection Network File System | 37797 | @subsection Network File System |
| 37741 | @cindex NFS | 37798 | @cindex NFS |
