1 ;;; GNU Guix --- Functional package management for GNU
2 ;;; Copyright © 2014, 2015, 2016, 2017 Ludovic Courtès <ludo@gnu.org>
4 ;;; This file is part of GNU Guix.
6 ;;; GNU Guix is free software; you can redistribute it and/or modify it
7 ;;; under the terms of the GNU General Public License as published by
8 ;;; the Free Software Foundation; either version 3 of the License, or (at
9 ;;; your option) any later version.
11 ;;; GNU Guix is distributed in the hope that it will be useful, but
12 ;;; WITHOUT ANY WARRANTY; without even the implied warranty of
13 ;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 ;;; GNU General Public License for more details.
16 ;;; You should have received a copy of the GNU General Public License
17 ;;; along with GNU Guix. If not, see <http://www.gnu.org/licenses/>.
19 (define-module (gnu services avahi)
20 #:use-module (gnu services)
21 #:use-module (gnu services base)
22 #:use-module (gnu services shepherd)
23 #:use-module (gnu services dbus)
24 #:use-module (gnu system shadow)
25 #:use-module (gnu packages avahi)
26 #:use-module (gnu packages admin)
27 #:use-module (guix records)
28 #:use-module (guix gexp)
29 #:export (avahi-configuration
35 ;;; This module provides service definitions for the Avahi
36 ;;; "zero-configuration" tool set.
41 (define-record-type* <avahi-configuration>
42 avahi-configuration make-avahi-configuration
44 (avahi avahi-configuration-avahi ;<package>
46 (debug? avahi-configuration-debug? ;Boolean
48 (host-name avahi-configuration-host-name) ;string
49 (publish? avahi-configuration-publish?) ;Boolean
50 (ipv4? avahi-configuration-ipv4?) ;Boolean
51 (ipv6? avahi-configuration-ipv6?) ;Boolean
52 (wide-area? avahi-configuration-wide-area?) ;Boolean
53 (domains-to-browse avahi-configuration-domains-to-browse)) ;list of strings
55 (define* (configuration-file config)
56 "Return an avahi-daemon configuration file based on CONFIG, an
57 <avahi-configuration>."
59 (if value "yes\n" "no\n"))
61 (define host-name (avahi-configuration-host-name config))
63 (plain-file "avahi-daemon.conf"
67 (string-append "host-name=" host-name "\n")
70 "browse-domains=" (string-join
71 (avahi-configuration-domains-to-browse
74 "use-ipv4=" (bool (avahi-configuration-ipv4? config))
75 "use-ipv6=" (bool (avahi-configuration-ipv6? config))
77 "enable-wide-area=" (bool (avahi-configuration-wide-area? config))
80 (bool (not (avahi-configuration-publish? config))))))
82 (define %avahi-accounts
83 ;; Account and group for the Avahi daemon.
84 (list (user-group (name "avahi") (system? #t))
89 (comment "Avahi daemon user")
90 (home-directory "/var/empty")
91 (shell (file-append shadow "/sbin/nologin")))))
93 (define %avahi-activation
96 (use-modules (guix build utils))
97 (mkdir-p "/var/run/avahi-daemon")))
99 (define (avahi-shepherd-service config)
100 "Return a list of <shepherd-service> for CONFIG."
101 (let ((config (configuration-file config))
102 (debug? (avahi-configuration-debug? config))
103 (avahi (avahi-configuration-avahi config)))
104 (list (shepherd-service
105 (documentation "Run the Avahi mDNS/DNS-SD responder.")
106 (provision '(avahi-daemon))
107 (requirement '(dbus-system networking))
109 (start #~(make-forkexec-constructor
110 (list #$(file-append avahi "/sbin/avahi-daemon")
112 #$@(if debug? #~("--debug") #~())
114 #:pid-file "/var/run/avahi-daemon/pid"))
115 (stop #~(make-kill-destructor))))))
117 (define avahi-service-type
118 (let ((avahi-package (compose list avahi-configuration-avahi)))
119 (service-type (name 'avahi)
121 "Run @command{avahi-daemon}, a host and service discovery
122 daemon that implements the multicast DNS (mDNS) and DNS service
123 discovery (DNS-SD) protocols. Additionally, extend the C library's name
124 service switch (NSS) with support for @code{.local} host name resolution.")
126 (list (service-extension shepherd-root-service-type
127 avahi-shepherd-service)
128 (service-extension dbus-root-service-type
130 (service-extension account-service-type
131 (const %avahi-accounts))
132 (service-extension activation-service-type
133 (const %avahi-activation))
134 (service-extension nscd-service-type
135 (const (list nss-mdns)))
137 ;; Provide 'avahi-browse', 'avahi-resolve', etc. in
138 ;; the system profile.
139 (service-extension profile-service-type
142 (define* (avahi-service #:key (avahi avahi) debug?
145 (ipv4? #t) (ipv6? #t)
147 (domains-to-browse '()))
148 "Return a service that runs @command{avahi-daemon}, a system-wide
149 mDNS/DNS-SD responder that allows for service discovery and
150 \"zero-configuration\" host name lookups (see @uref{http://avahi.org/}), and
151 extends the name service cache daemon (nscd) so that it can resolve
152 @code{.local} host names using
153 @uref{http://0pointer.de/lennart/projects/nss-mdns/, nss-mdns}. Additionally,
154 add the @var{avahi} package to the system profile so that commands such as
155 @command{avahi-browse} are directly usable.
157 If @var{host-name} is different from @code{#f}, use that as the host name to
158 publish for this machine; otherwise, use the machine's actual host name.
160 When @var{publish?} is true, publishing of host names and services is allowed;
161 in particular, avahi-daemon will publish the machine's host name and IP
162 address via mDNS on the local network.
164 When @var{wide-area?} is true, DNS-SD over unicast DNS is enabled.
166 Boolean values @var{ipv4?} and @var{ipv6?} determine whether to use IPv4/IPv6
168 (service avahi-service-type
170 (avahi avahi) (debug? debug?) (host-name host-name)
171 (publish? publish?) (ipv4? ipv4?) (ipv6? ipv6?)
172 (wide-area? wide-area?)
173 (domains-to-browse domains-to-browse))))
175 ;;; avahi.scm ends here