diff options
author | EuAndreh <eu@euandre.org> | 2023-03-17 14:46:46 -0300 |
---|---|---|
committer | EuAndreh <eu@euandre.org> | 2023-03-17 14:46:46 -0300 |
commit | 7bbcb1c4b1e20bb58535b991df8d3ad1030480d4 (patch) | |
tree | b2e52d43eacc729e90476237d996321602ae5f85 | |
parent | queue.scm: Add flexible "config-extra" and "raw-file" options for dkimproxyout (diff) | |
download | package-repository-7bbcb1c4b1e20bb58535b991df8d3ad1030480d4.tar.gz package-repository-7bbcb1c4b1e20bb58535b991df8d3ad1030480d4.tar.xz |
queue.scm: Add docstrings to dkimproxy service variables
-rw-r--r-- | src/org/euandre/queue.scm | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/src/org/euandre/queue.scm b/src/org/euandre/queue.scm index 412699c..e72b3b7 100644 --- a/src/org/euandre/queue.scm +++ b/src/org/euandre/queue.scm @@ -673,7 +673,6 @@ supplementary groups of the running daemon, and by enabling the By default, the daemon runs in a container."))) -;; FIXME: net namespaces only on specific ports 10027 and 10028, and only localhost (define-record-type* <dkimproxyout-configuration> dkimproxyout-configuration make-dkimproxyout-configuration @@ -696,9 +695,6 @@ By default, the daemon runs in a container."))) (container-namespaces dkimproxyout-configuration-container-namespaces (default (s1:fold delq container:%namespaces '(net)))) (extra-mappings dkimproxyout-configuration-extra-mappings (default '()))) -;; # FIXME:DOCUMENTATION add this to the service documentation -;; # the corresponding public key is available at: -;; # ~a/public.key (define (generate-out.cf config) (match-record config <dkimproxyout-configuration> (config-extra listen relay domains selector data-directory) @@ -815,7 +811,7 @@ keyfile ~a/private.key (list (shepherd-service (provision '(dkimproxyout)) - (documentation " FIXME ") + (documentation "Run the outbound DKIMProxy.out daemon.") (start #~(make-forkexec-constructor (list #$cmd "--conf_file" #$config-file) #:user #$user @@ -826,12 +822,11 @@ keyfile ~a/private.key (list (shepherd-action (name 'configuration) - (documentation "FIXME:DOCUMENTATION") + (documentation "Display the name of the configuration file being used.") (procedure #~(lambda _ (format #t "~a~%" #$config-file))))))))))) - (define-public dkimproxyout-service-type (service-type (name 'dkimproxyout) @@ -848,9 +843,18 @@ keyfile ~a/private.key (service-extension shepherd-root-service-type dkimproxyout-shepherd-service))) (default-value (dkimproxyout-configuration)) - (description "FIXME:DOCUMENTATION"))) + (description "Run the @code{dkimproxy.out} SMTP outbound proxy for adding +DKIM signature headers to emails. This daemon is meant to be used in companiong +with an SMTP server, such as Postfix. +On startup, it creates the keypair to be used for signing if the keypair doesn't +exist yet. The corresponding public.key is kept in the same directory as the +private key. The default location for the private key is +@file{/var/lib/dkimproxyout/private.key}, so the public key is kept at +@file{/var/lib/dkimproxyout/public.key}, so that it can be added as a TXT DNS +entry. +By default, the daemon runs in a container."))) |