aboutsummaryrefslogtreecommitdiff
path: root/src/org/euandre/queue.scm
diff options
context:
space:
mode:
authorEuAndreh <eu@euandre.org>2023-03-16 13:49:22 -0300
committerEuAndreh <eu@euandre.org>2023-03-16 13:49:52 -0300
commitf20221d4cd4a7166403e5ed4c40e00bcc689a43c (patch)
tree8d34fbce8b1b013e4f5c5e1aab97b047501c264d /src/org/euandre/queue.scm
parentqueue.scm: Fix "configuration" action of cyrus-sal (diff)
downloadpackage-repository-f20221d4cd4a7166403e5ed4c40e00bcc689a43c.tar.gz
package-repository-f20221d4cd4a7166403e5ed4c40e00bcc689a43c.tar.xz
queue.scm: Add proper documentation string to cyrus-sasl-service-type
Diffstat (limited to 'src/org/euandre/queue.scm')
-rw-r--r--src/org/euandre/queue.scm17
1 files changed, 14 insertions, 3 deletions
diff --git a/src/org/euandre/queue.scm b/src/org/euandre/queue.scm
index b269374..bf61fae 100644
--- a/src/org/euandre/queue.scm
+++ b/src/org/euandre/queue.scm
@@ -593,7 +593,7 @@ to the list of supplementary groups of the user of such running process.")))
(list
(shepherd-service
(provision '(cyrus-sasl))
- (documentation "FIXME:DOCUMENTATION")
+ (documentation "Run the saslauthd daemon of Cyrus SASL.")
(start #~(make-forkexec-constructor
(list #$cmd "-a" #$authmech "-d" "-m" #$run-directory)
#:user #$user
@@ -604,7 +604,7 @@ to the list of supplementary groups of the user of such running process.")))
(list
(shepherd-action
(name 'configuration)
- (documentation "FIXME:DOCUMENTATION")
+ (documentation "Display the name of all registered configuration files.")
(procedure
(let ((names (map cyrus-service-configuration-name services)))
#~(lambda _
@@ -636,7 +636,18 @@ to the list of supplementary groups of the user of such running process.")))
(cyrus-sasl-configuration-services config)
services)))))
(default-value (cyrus-sasl-configuration))
- (description "FIXME:DOCUMENTATION")))
+ (description "Run the @code{saslauthd} daemon from the Cyrus SASL package.
+
+Services can extend @code{cyrus-sasl-service-type}, and provide their own list
+of @code{cyrus-service-configuration} entries to be registered in this service.
+
+For the @code{saslauthd} daemon to be able to authenticate using the \"shadow\"
+@code{authmech}, it needs read access to the @file{/etc/shadow} file. This is
+accomplished by default by adding the @code{etc-shadow} group to the list of
+supplementary groups of the running daemon, and by enabling the
+@code{shadow-group-service-type} service.
+
+By default, the daemon runs in a container.")))
(define-record-type* <dkimproxyout-configuration>