From 193f547ca35eb49ef57bd9a25b67cb3965f10b03 Mon Sep 17 00:00:00 2001 From: "Jan (janneke) Nieuwenhuizen" Date: Sun, 5 Mar 2023 17:38:50 +0100 Subject: [PATCH] gnu: home: services: Add home-znc-service-type. * gnu/home/services/messaging.scm: New file. * gnu/local.mk (GNU_SYSTEM_MODULES): Add it. * po/guix/POTFILES.in: Likewise. * doc/guix.texi (Messaging Home Services): Document it in new subsection. --- doc/guix.texi | 37 +++++++++++++++++ gnu/home/services/messaging.scm | 73 +++++++++++++++++++++++++++++++++ gnu/local.mk | 3 +- po/guix/POTFILES.in | 1 + 4 files changed, 113 insertions(+), 1 deletion(-) create mode 100644 gnu/home/services/messaging.scm diff --git a/doc/guix.texi b/doc/guix.texi index 8baa2f3224..a823d5f27d 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -41705,6 +41705,7 @@ services)}. * Guix: Guix Home Services. Services for Guix. * Fonts: Fonts Home Services. Services for managing User's fonts. * Sound: Sound Home Services. Dealing with audio. +* Messaging: Messaging Home Services. Services for managing messaging. @end menu @c In addition to that Home Services can provide @@ -42797,6 +42798,42 @@ Stopping the Shepherd service turns off broadcasting. This is the multicast address used by default by the two services above. @end defvar +@node Messaging Home Services +@subsection Messaging Home Services + +@cindex znc +The @uref{https://znc.in, ZNC bouncer} can be run as a daemon to manage +your IRC presence. With the @code{(gnu home services znc)} service, you +can configure ZNC to run upon login. + +You will have to provide a @file{~/.znc/configs/znc.conf} seperately. + +Here is an example of a service and its configuration that you could add +to the @code{services} field of your @code{home-environment}: + +@lisp +(service home-znc-service-type) +@end lisp + +@defvr {Scheme Variable} home-znc-service-type +This is the type of the @code{git daemon} home service, whose value is an +@code{home-znc-configuration} object. +@end defvr + +@deftp {Data Type} home-znc-configuration +Available @code{home-znc-configuration} fields are: + +@table @asis +@item @code{git} (default: @code{git}) (type: file-like) +The git package to use. + +@item @code{extra-options} (default: @code{'()}) +Extra options will be passed to @command{znc}, please run @command{man +znc} for more information. + +@end table +@end deftp + @node Invoking guix home @section Invoking @command{guix home} diff --git a/gnu/home/services/messaging.scm b/gnu/home/services/messaging.scm new file mode 100644 index 0000000000..d403b84ac9 --- /dev/null +++ b/gnu/home/services/messaging.scm @@ -0,0 +1,73 @@ +;;; GNU Guix --- Functional package management for GNU +;;; Copyright © 2023 Janneke Nieuwenhuizen +;;; +;;; 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 . + +(define-module (gnu home services messaging) + #:use-module (srfi srfi-26) + + #:use-module (ice-9 match) + + #:use-module (shepherd support) + + #:use-module (gnu home services) + #:use-module (gnu home services shepherd) + #:use-module (gnu packages messaging) + #:use-module (gnu services configuration) + #:use-module (gnu services shepherd) + #:use-module (guix records) + #:use-module (guix gexp) + + #:export (home-znc-configuration + home-znc-service-type)) + +;;; +;;; Znc. +;;; +(define-record-type* + home-znc-configuration make-home-znc-configuration + home-znc-configuration? + (znc home-znc-znc ;string + (default znc)) + (extra-options home-znc-extra-options ;list of string + (default '()))) + +(define (home-znc-services config) + "Return a for znc with CONFIG." + (match config + (($ znc extra-options) + (let* ((znc (file-append znc "/bin/znc")) + (command `(,znc + "--foreground" + ,@extra-options)) + (log-file (string-append %user-log-dir "/znc.log"))) + (list (shepherd-service + (documentation "Run the znc IRC bouncer.") + (provision '(znc)) + (start #~(make-forkexec-constructor '#$command + #:log-file #$log-file)) + (stop #~(make-kill-destructor)))))))) + +(define home-znc-service-type + (service-type + (name 'home-znc) + (default-value (home-znc-configuration)) + (extensions + (list (service-extension home-shepherd-service-type + home-znc-services))) + (description + "Install and configure @command{znc}, an @acronym{IRC, Internet Relay +Chat} bouncer, as a Shepherd service."))) diff --git a/gnu/local.mk b/gnu/local.mk index eafd7c40ea..c87ce6fa8c 100644 --- a/gnu/local.mk +++ b/gnu/local.mk @@ -11,7 +11,7 @@ # Copyright © 2016 Ben Woodcroft # Copyright © 2016, 2017, 2018, 2019 Alex Vong # Copyright © 2016, 2017, 2018, 2019, 2020, 2021 Efraim Flashner -# Copyright © 2016, 2017, 2018, 2019, 2020, 2021, 2022 Jan (janneke) Nieuwenhuizen +# Copyright © 2016, 2017, 2018, 2019, 2020, 2021, 2022, 2023 Jan (janneke) Nieuwenhuizen # Copyright © 2017, 2018, 2019, 2020 Tobias Geerinckx-Rice # Copyright © 2017, 2018 Clément Lassieur # Copyright © 2017, 2020 Mathieu Othacehe @@ -91,6 +91,7 @@ GNU_SYSTEM_MODULES = \ %D%/home/services/symlink-manager.scm \ %D%/home/services/fontutils.scm \ %D%/home/services/guix.scm \ + %D%/home/services/messaging.scm \ %D%/home/services/pm.scm \ %D%/home/services/shells.scm \ %D%/home/services/shepherd.scm \ diff --git a/po/guix/POTFILES.in b/po/guix/POTFILES.in index 7009fc756c..c71a6ca857 100644 --- a/po/guix/POTFILES.in +++ b/po/guix/POTFILES.in @@ -13,6 +13,7 @@ gnu/services/shepherd.scm gnu/services/samba.scm gnu/services/version-control.scm gnu/home/services.scm +gnu/home/services/messaging.scm gnu/home/services/ssh.scm gnu/home/services/symlink-manager.scm gnu/system/file-systems.scm