diff options
author | Janneke Nieuwenhuizen <[email protected]> | 2025-03-13 19:22:02 +0100 |
---|---|---|
committer | Janneke Nieuwenhuizen <[email protected]> | 2025-03-20 09:32:05 +0100 |
commit | 2f204a73036d3f78bb3a8a99833ac69a9efaab7b (patch) | |
tree | 298cf0536dabb606e526e4534ed82b070ed48163 /doc | |
parent | 973e59e24e45e505baeddd99a54e77c57a9454e0 (diff) |
services: Add snuik-service-type.
* gnu/services/messaging.scm (snuik-configuration): New type.
(snuik-services): New procedure.
(snuik-activation, %snuik-accounts, snuik-service-type): New variables.
* doc/guix.texi (Messaging Services): Document it.
Change-Id: I0c52b4804948876dc1b4d3b5ac660af848a13f25
Diffstat (limited to 'doc')
-rw-r--r-- | doc/guix.texi | 59 |
1 files changed, 58 insertions, 1 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index fe43ed2504..41211d461d 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -36,7 +36,7 @@ Copyright @copyright{} 2016, 2017, 2018, 2021 Chris Marusich@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Efraim Flashner@* Copyright @copyright{} 2016 John Darrington@* Copyright @copyright{} 2016, 2017 Nikita Gillmann@* -Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024 Janneke Nieuwenhuizen@* +Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023, 2024, 2025 Janneke Nieuwenhuizen@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Julien Lepiller@* Copyright @copyright{} 2016 Alex ter Weele@* Copyright @copyright{} 2016, 2017, 2018, 2019, 2020, 2021 Christopher Baines@* @@ -30218,6 +30218,63 @@ and Error. @end table @end deftp +@cindex irc-bot +@cindex snuik +The @uref{https://gitlab.com/janneke/snuik, Snuik IRC bot} can be run as +a daemon to aid talking to users that are currently offline. With the +@code{(gnu services messaging)} service, you can configure it by adding +a @code{snuik-service-type} service to the @code{services} field of your +operating system declaration. + +@defvar snuik-service-type +This is the type of the Snuik service, whose value is a +@code{snuik-configuration} object. +@end defvar + +Here is an example of a service and its configuration: + +@lisp +(service snuik-service-type + (snuik-configuration + (password-file "/var/run/snuik/.password.snuik") + (channels '("#bootstrappable" + "#dezyne" + "#guix-risc-v" + "#lilypond")))) +@end lisp + +@deftp {Data Type} snuik-configuration +Available @code{snuik-configuration} fields are: + +@table @asis +@item @code{snuik} (default: @code{snuik}) (type: package) +The Snuik package to use. + +@item @code{server} (default: @code{"irc.libera.chat"}) +The IRC server to connect to. + +@item @code{port} (default: @code{6665}) (type: integer) +Port number used by the IRC server. + +@item @code{nick} (default: @code{"snuik"}) (type: string) +The nickname for snuik to use. + +@item @code{password} (default: @code{#f}) (type: string) +The password to use when logging in. + +@item @code{password-file} (default: @code{".password.<nick>}) +The file to read the password from to use when logging in. + +@item @code{channels} (default: @code{'("##botchat")}) +The channels for snuik to join, a list of strings. + +@item @code{extra-options} (default: @code{'()}) +Extra options will be passed to @command{snuik}, please run +@command{snuik --help } for more information. + +@end table +@end deftp + @node Telephony Services @subsection Telephony Services |