diff options
author | Liliana Marie Prikler <liliana.prikler@gmail.com> | 2022-03-26 09:57:18 +0100 |
---|---|---|
committer | Liliana Marie Prikler <liliana.prikler@gmail.com> | 2022-04-12 20:32:32 +0200 |
commit | 42679e3f81a0fa61e225b1f6aa0e80e39625372f (patch) | |
tree | 88b99817c74681df5880c0d965fda4e9cfd6acfb /doc | |
parent | 9ab158a457be5267ca03f7dd3f511b7308ca0ab6 (diff) | |
download | guix-42679e3f81a0fa61e225b1f6aa0e80e39625372f.tar guix-42679e3f81a0fa61e225b1f6aa0e80e39625372f.tar.gz |
services: Replace murmur-service-type with mumble-server-service-type.
* gnu/services/telephony.scm (murmur-configuration, make-murmur-configuration)
(murmur-configuration?, murmur-configuration-package)
(murmur-configuration-user, murmur-configuration-group)
(murmur-configuration-port, murmur-configuration-welcome-text)
(murmur-configuration-server-password)
(murmur-configuration-max-users)
(murmur-configuration-max-user-bandwidth)
(murmur-configuration-database-file)
(murmur-configuration-log-file, murmur-configuration-pid-file)
(murmur-configuration-autoban-attempts)
(murmur-configuration-autoban-timeframe)
(murmur-configuration-autoban-time)
(murmur-configuration-opus-threshold)
(murmur-configuration-channel-nesting-limit)
(murmur-configuration-channelname-regex)
(murmur-configuration-username-regex)
(murmur-configuration-test-message-length)
(murmur-configuration-image-message-length)
(murmur-configuration-cert-required?)
(murmur-configuration-remember-channel?)
(murmur-configuration-allow-html?)
(murmur-configuration-allow-ping?)
(murmur-configuration-bonjour?)
(murmur-configuration-send-version?)
(murmur-configuration-log-days)
(murmur-configuration-obfuscate-ips?)
(murmur-configuration-ssl-cert murmur-configuration-ssl-key)
(murmur-configuration-ssl-dh-params murmur-configuration-ssl-ciphers)
(murmur-configuration-public-registration)
(murmur-configuration-file)
(murmur-public-registration-configuration)
(make-murmur-public-registration-configuration)
(murmur-public-registration-configuration?)
(murmur-public-registration-configuration-name)
(murmur-public-registration-configuration-url)
(murmur-public-registration-configuration-password)
(murmur-public-registration-configuration-hostname)
(murmur-service-type): Add deprecation alias and rename to ...
(mumble-server-configuration, make-mumble-server-configuration)
(mumble-server-configuration?, mumble-server-configuration-package)
(mumble-server-configuration-user, mumble-server-configuration-group)
(mumble-server-configuration-port, mumble-server-configuration-welcome-text)
(mumble-server-configuration-server-password)
(mumble-server-configuration-max-users)
(mumble-server-configuration-max-user-bandwidth)
(mumble-server-configuration-database-file)
(mumble-server-configuration-log-file, mumble-server-configuration-pid-file)
(mumble-server-configuration-autoban-attempts)
(mumble-server-configuration-autoban-timeframe)
(mumble-server-configuration-autoban-time)
(mumble-server-configuration-opus-threshold)
(mumble-server-configuration-channel-nesting-limit)
(mumble-server-configuration-channelname-regex)
(mumble-server-configuration-username-regex)
(mumble-server-configuration-test-message-length)
(mumble-server-configuration-image-message-length)
(mumble-server-configuration-cert-required?)
(mumble-server-configuration-remember-channel?)
(mumble-server-configuration-allow-html?)
(mumble-server-configuration-allow-ping?)
(mumble-server-configuration-bonjour?)
(mumble-server-configuration-send-version?)
(mumble-server-configuration-log-days)
(mumble-server-configuration-obfuscate-ips?)
(mumble-server-configuration-ssl-cert mumble-server-configuration-ssl-key)
(mumble-server-configuration-ssl-dh-params) (mumble-server-configuration-ssl-ciphers)
(mumble-server-configuration-public-registration)
(mumble-server-configuration-file)
(mumble-server-public-registration-configuration)
(make-mumble-server-public-registration-configuration)
(mumble-server-public-registration-configuration?)
(mumble-server-public-registration-configuration-name)
(mumble-server-public-registration-configuration-url)
(mumble-server-public-registration-configuration-password)
(mumble-server-public-registration-configuration-hostname)
(mumble-server-service-type): ... these.
* doc/guix.texi ("Murmur (VoIP server)"): Rename to ...
("Mumble server"): ... this. Adjust documentation accordingly.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/guix.texi | 73 |
1 files changed, 41 insertions, 32 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index 7369a306f6..a865b2e2e4 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -25072,21 +25072,21 @@ account fingerprint for a registered username. @end deftp -@subsubheading Murmur (VoIP server) +@subsubheading Mumble server -@cindex Murmur (VoIP server) +@cindex Mumble +@cindex Murmur @cindex VoIP server -This section describes how to set up and run a Murmur server. Murmur is -the server of the @uref{https://mumble.info, Mumble} voice-over-IP -(VoIP) suite. +This section describes how to set up and run a +@uref{https://mumble.info, Mumble} server (formerly known as Murmur). -@deftp {Data Type} murmur-configuration -The service type for the Murmur server. An example configuration can +@deftp {Data Type} mumble-server-configuration +The service type for the Mumble server. An example configuration can look like this: @lisp -(service murmur-service-type - (murmur-configuration +(service mumble-server-service-type + (mumble-server-configuration (welcome-text "Welcome to this Mumble server running on Guix!") (cert-required? #t) ;disallow text password logins @@ -25094,7 +25094,8 @@ look like this: (ssl-key "/etc/letsencrypt/live/mumble.example.com/privkey.pem"))) @end lisp -After reconfiguring your system, you can manually set the murmur @code{SuperUser} +After reconfiguring your system, you can manually set the mumble-server +@code{SuperUser} password with the command that is printed during the activation phase. It is recommended to register a normal Mumble user account @@ -25106,17 +25107,17 @@ the @code{SuperUser} password that you set previously, and grant your newly registered mumble user administrator or moderator rights and create some channels. -Available @code{murmur-configuration} fields are: +Available @code{mumble-server-configuration} fields are: @table @asis @item @code{package} (default: @code{mumble}) -Package that contains @code{bin/murmurd}. +Package that contains @code{bin/mumble-server}. -@item @code{user} (default: @code{"murmur"}) -User who will run the Murmur server. +@item @code{user} (default: @code{"mumble-server"}) +User who will run the Mumble-Server server. -@item @code{group} (default: @code{"murmur"}) -Group of the user who will run the murmur server. +@item @code{group} (default: @code{"mumble-server"}) +Group of the user who will run the mumble-server server. @item @code{port} (default: @code{64738}) Port on which the server will listen. @@ -25133,11 +25134,11 @@ Maximum of users that can be connected to the server at once. @item @code{max-user-bandwidth} (default: @code{#f}) Maximum voice traffic a user can send per second. -@item @code{database-file} (default: @code{"/var/lib/murmur/db.sqlite"}) +@item @code{database-file} (default: @code{"/var/lib/mumble-server/db.sqlite"}) File name of the sqlite database. The service's user will become the owner of the directory. -@item @code{log-file} (default: @code{"/var/log/murmur/murmur.log"}) +@item @code{log-file} (default: @code{"/var/log/mumble-server/mumble-server.log"}) File name of the log file. The service's user will become the owner of the directory. @@ -25176,8 +25177,9 @@ If it is set to @code{#t} clients that use weak password authentication will not be accepted. Users must have completed the certificate wizard to join. @item @code{remember-channel?} (default: @code{#f}) -Should murmur remember the last channel each user was in when they disconnected -and put them into the remembered channel when they rejoin. +Should mumble-server remember the last channel each user was in when +they disconnected and put them into the remembered channel when they +rejoin. @item @code{allow-html?} (default: @code{#f}) Should html be allowed in text messages, user comments, and channel descriptions. @@ -25193,10 +25195,10 @@ Disabling this setting will prevent public listing of the server. Should the server advertise itself in the local network through the bonjour protocol. @item @code{send-version?} (default: @code{#f}) -Should the murmur server version be exposed in ping requests. +Should the mumble-server server version be exposed in ping requests. @item @code{log-days} (default: @code{31}) -Murmur also stores logs in the database, which are accessible via RPC. +Mumble also stores logs in the database, which are accessible via RPC. The default is 31 days of months, but you can set this setting to 0 to keep logs forever, or -1 to disable logging to the database. @@ -25229,17 +25231,19 @@ This option is specified using @uref{https://www.openssl.org/docs/apps/ciphers.html#CIPHER-LIST-FORMAT, OpenSSL cipher list notation}. -It is recommended that you try your cipher string using 'openssl ciphers <string>' -before setting it here, to get a feel for which cipher suites you will get. -After setting this option, it is recommend that you inspect your Murmur log -to ensure that Murmur is using the cipher suites that you expected it to. +It is recommended that you try your cipher string using +'openssl ciphers <string>' before setting it here, to get a feel for +which cipher suites you will get. +After setting this option, it is recommend that you inspect your Mumble +server log to ensure that Mumble is using the cipher suites that you +expected it to. Note: Changing this option may impact the backwards compatibility of your -Murmur server, and can remove the ability for older Mumble clients to be able -to connect to it. +Mumble-Server server, and can remove the ability for older Mumble clients to be able to connect to it. @item @code{public-registration} (default: @code{#f}) -Must be a @code{<murmur-public-registration-configuration>} record or @code{#f}. +Must be a @code{<mumble-server-public-registration-configuration>} +record or @code{#f}. You can optionally register your server in the public server list that the @code{mumble} client shows on startup. @@ -25253,8 +25257,8 @@ Optional alternative override for this configuration. @end table @end deftp -@deftp {Data Type} murmur-public-registration-configuration -Configuration for public registration of a murmur service. +@deftp {Data Type} mumble-server-public-registration-configuration +Configuration for public registration of a mumble-server service. @table @asis @item @code{name} @@ -25274,7 +25278,12 @@ If it is set your server will be linked by this host name instead. @end table @end deftp - +@quotation Deprecation notice +Due to historical reasons, all of the above @code{mumble-server-} +procedures are also exported with the @code{murmur-} prefix. +It is recommended that you switch to using @code{mumble-server-} +going forward. +@end quotation @node File-Sharing Services @subsection File-Sharing Services |