services: messaging: Use HTTPS for prosody.im URLs.

* gnu/services/messaging.scm (prosody-configuration): Use HTTPS whenever
referring to prosody.im URLs in documentation.
* doc/guix.texi (Messaging Services): Likewise.
This commit is contained in:
Tobias Geerinckx-Rice 2017-12-24 00:51:08 +01:00
parent 6cd46747e7
commit 7459cb9305
No known key found for this signature in database
GPG key ID: 0DB0FF884F556D79
2 changed files with 47 additions and 47 deletions

View file

@ -13956,7 +13956,7 @@ definitions for messaging services: currently only Prosody is supported.
@subsubheading Prosody Service @subsubheading Prosody Service
@deffn {Scheme Variable} prosody-service-type @deffn {Scheme Variable} prosody-service-type
This is the type for the @uref{http://prosody.im, Prosody XMPP This is the type for the @uref{https://prosody.im, Prosody XMPP
communication server}. Its value must be a @code{prosody-configuration} communication server}. Its value must be a @code{prosody-configuration}
record as in this example: record as in this example:
@ -14021,13 +14021,13 @@ The Prosody package.
@deftypevr {@code{prosody-configuration} parameter} file-name data-path @deftypevr {@code{prosody-configuration} parameter} file-name data-path
Location of the Prosody data storage directory. See Location of the Prosody data storage directory. See
@url{http://prosody.im/doc/configure}. @url{https://prosody.im/doc/configure}.
Defaults to @samp{"/var/lib/prosody"}. Defaults to @samp{"/var/lib/prosody"}.
@end deftypevr @end deftypevr
@deftypevr {@code{prosody-configuration} parameter} file-name-list plugin-paths @deftypevr {@code{prosody-configuration} parameter} file-name-list plugin-paths
Additional plugin directories. They are searched in all the specified Additional plugin directories. They are searched in all the specified
paths in order. See @url{http://prosody.im/doc/plugins_directory}. paths in order. See @url{https://prosody.im/doc/plugins_directory}.
Defaults to @samp{()}. Defaults to @samp{()}.
@end deftypevr @end deftypevr
@ -14040,15 +14040,15 @@ Defaults to @samp{"/etc/prosody/certs"}.
@deftypevr {@code{prosody-configuration} parameter} string-list admins @deftypevr {@code{prosody-configuration} parameter} string-list admins
This is a list of accounts that are admins for the server. Note that you This is a list of accounts that are admins for the server. Note that you
must create the accounts separately. See @url{http://prosody.im/doc/admins} and must create the accounts separately. See @url{https://prosody.im/doc/admins} and
@url{http://prosody.im/doc/creating_accounts}. @url{https://prosody.im/doc/creating_accounts}.
Example: @code{(admins '("user1@@example.com" "user2@@example.net"))} Example: @code{(admins '("user1@@example.com" "user2@@example.net"))}
Defaults to @samp{()}. Defaults to @samp{()}.
@end deftypevr @end deftypevr
@deftypevr {@code{prosody-configuration} parameter} boolean use-libevent? @deftypevr {@code{prosody-configuration} parameter} boolean use-libevent?
Enable use of libevent for better performance under high load. See Enable use of libevent for better performance under high load. See
@url{http://prosody.im/doc/libevent}. @url{https://prosody.im/doc/libevent}.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@ -14056,7 +14056,7 @@ Defaults to @samp{#f}.
This is the list of modules Prosody will load on startup. It looks for This is the list of modules Prosody will load on startup. It looks for
@code{mod_modulename.lua} in the plugins folder, so make sure that exists too. @code{mod_modulename.lua} in the plugins folder, so make sure that exists too.
Documentation on modules can be found at: Documentation on modules can be found at:
@url{http://prosody.im/doc/modules}. @url{https://prosody.im/doc/modules}.
Defaults to @samp{("roster" "saslauth" "tls" "dialback" "disco" "carbons" "private" "blocklist" "vcard" "version" "uptime" "time" "ping" "pep" "register" "admin_adhoc")}. Defaults to @samp{("roster" "saslauth" "tls" "dialback" "disco" "carbons" "private" "blocklist" "vcard" "version" "uptime" "time" "ping" "pep" "register" "admin_adhoc")}.
@end deftypevr @end deftypevr
@ -14069,13 +14069,13 @@ Defaults to @samp{()}.
@deftypevr {@code{prosody-configuration} parameter} file-name groups-file @deftypevr {@code{prosody-configuration} parameter} file-name groups-file
Path to a text file where the shared groups are defined. If this path is Path to a text file where the shared groups are defined. If this path is
empty then @samp{mod_groups} does nothing. See empty then @samp{mod_groups} does nothing. See
@url{http://prosody.im/doc/modules/mod_groups}. @url{https://prosody.im/doc/modules/mod_groups}.
Defaults to @samp{"/var/lib/prosody/sharedgroups.txt"}. Defaults to @samp{"/var/lib/prosody/sharedgroups.txt"}.
@end deftypevr @end deftypevr
@deftypevr {@code{prosody-configuration} parameter} boolean allow-registration? @deftypevr {@code{prosody-configuration} parameter} boolean allow-registration?
Disable account creation by default, for security. See Disable account creation by default, for security. See
@url{http://prosody.im/doc/creating_accounts}. @url{https://prosody.im/doc/creating_accounts}.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@ -14083,7 +14083,7 @@ Defaults to @samp{#f}.
These are the SSL/TLS-related settings. Most of them are disabled so to These are the SSL/TLS-related settings. Most of them are disabled so to
use Prosody's defaults. If you do not completely understand these options, do use Prosody's defaults. If you do not completely understand these options, do
not add them to your config, it is easy to lower the security of your server not add them to your config, it is easy to lower the security of your server
using them. See @url{http://prosody.im/doc/advanced_ssl_config}. using them. See @url{https://prosody.im/doc/advanced_ssl_config}.
Available @code{ssl-configuration} fields are: Available @code{ssl-configuration} fields are:
@ -14154,7 +14154,7 @@ Password for encrypted private keys.
@deftypevr {@code{prosody-configuration} parameter} boolean c2s-require-encryption? @deftypevr {@code{prosody-configuration} parameter} boolean c2s-require-encryption?
Whether to force all client-to-server connections to be encrypted or not. Whether to force all client-to-server connections to be encrypted or not.
See @url{http://prosody.im/doc/modules/mod_tls}. See @url{https://prosody.im/doc/modules/mod_tls}.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@ -14166,7 +14166,7 @@ Defaults to @samp{("DIGEST-MD5")}.
@deftypevr {@code{prosody-configuration} parameter} boolean s2s-require-encryption? @deftypevr {@code{prosody-configuration} parameter} boolean s2s-require-encryption?
Whether to force all server-to-server connections to be encrypted or not. Whether to force all server-to-server connections to be encrypted or not.
See @url{http://prosody.im/doc/modules/mod_tls}. See @url{https://prosody.im/doc/modules/mod_tls}.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@ -14174,7 +14174,7 @@ Defaults to @samp{#f}.
Whether to require encryption and certificate authentication. This Whether to require encryption and certificate authentication. This
provides ideal security, but requires servers you communicate with to support provides ideal security, but requires servers you communicate with to support
encryption AND present valid, trusted certificates. See encryption AND present valid, trusted certificates. See
@url{http://prosody.im/doc/s2s#security}. @url{https://prosody.im/doc/s2s#security}.
Defaults to @samp{#f}. Defaults to @samp{#f}.
@end deftypevr @end deftypevr
@ -14182,14 +14182,14 @@ Defaults to @samp{#f}.
Many servers don't support encryption or have invalid or self-signed Many servers don't support encryption or have invalid or self-signed
certificates. You can list domains here that will not be required to certificates. You can list domains here that will not be required to
authenticate using certificates. They will be authenticated using DNS. See authenticate using certificates. They will be authenticated using DNS. See
@url{http://prosody.im/doc/s2s#security}. @url{https://prosody.im/doc/s2s#security}.
Defaults to @samp{()}. Defaults to @samp{()}.
@end deftypevr @end deftypevr
@deftypevr {@code{prosody-configuration} parameter} string-list s2s-secure-domains @deftypevr {@code{prosody-configuration} parameter} string-list s2s-secure-domains
Even if you leave @code{s2s-secure-auth?} disabled, you can still require Even if you leave @code{s2s-secure-auth?} disabled, you can still require
valid certificates for some domains by specifying a list here. See valid certificates for some domains by specifying a list here. See
@url{http://prosody.im/doc/s2s#security}. @url{https://prosody.im/doc/s2s#security}.
Defaults to @samp{()}. Defaults to @samp{()}.
@end deftypevr @end deftypevr
@ -14197,20 +14197,20 @@ Defaults to @samp{()}.
Select the authentication backend to use. The default provider stores Select the authentication backend to use. The default provider stores
passwords in plaintext and uses Prosody's configured data storage to store the passwords in plaintext and uses Prosody's configured data storage to store the
authentication data. If you do not trust your server please see authentication data. If you do not trust your server please see
@url{http://prosody.im/doc/modules/mod_auth_internal_hashed} for information @url{https://prosody.im/doc/modules/mod_auth_internal_hashed} for information
about using the hashed backend. See also about using the hashed backend. See also
@url{http://prosody.im/doc/authentication} @url{https://prosody.im/doc/authentication}
Defaults to @samp{"internal_plain"}. Defaults to @samp{"internal_plain"}.
@end deftypevr @end deftypevr
@deftypevr {@code{prosody-configuration} parameter} maybe-string log @deftypevr {@code{prosody-configuration} parameter} maybe-string log
Set logging options. Advanced logging configuration is not yet supported Set logging options. Advanced logging configuration is not yet supported
by the GuixSD Prosody Service. See @url{http://prosody.im/doc/logging}. by the GuixSD Prosody Service. See @url{https://prosody.im/doc/logging}.
Defaults to @samp{"*syslog"}. Defaults to @samp{"*syslog"}.
@end deftypevr @end deftypevr
@deftypevr {@code{prosody-configuration} parameter} file-name pidfile @deftypevr {@code{prosody-configuration} parameter} file-name pidfile
File to write pid in. See @url{http://prosody.im/doc/modules/mod_posix}. File to write pid in. See @url{https://prosody.im/doc/modules/mod_posix}.
Defaults to @samp{"/var/run/prosody/prosody.pid"}. Defaults to @samp{"/var/run/prosody/prosody.pid"}.
@end deftypevr @end deftypevr
@ -14237,7 +14237,7 @@ instance can serve many domains, each one defined as a VirtualHost entry in
Prosody's configuration. Conversely a server that hosts a single domain would Prosody's configuration. Conversely a server that hosts a single domain would
have just one VirtualHost entry. have just one VirtualHost entry.
See @url{http://prosody.im/doc/configure#virtual_host_settings}. See @url{https://prosody.im/doc/configure#virtual_host_settings}.
Available @code{virtualhost-configuration} fields are: Available @code{virtualhost-configuration} fields are:
@ -14258,7 +14258,7 @@ Internal components are implemented with Prosody-specific plugins. To add an
internal component, you simply fill the hostname field, and the plugin you wish internal component, you simply fill the hostname field, and the plugin you wish
to use for the component. to use for the component.
See @url{http://prosody.im/doc/components}. See @url{https://prosody.im/doc/components}.
Defaults to @samp{()}. Defaults to @samp{()}.
Available @code{int-component-configuration} fields are: Available @code{int-component-configuration} fields are:
@ -14277,10 +14277,10 @@ Multi-user chat (MUC) is Prosody's module for allowing you to create
hosted chatrooms/conferences for XMPP users. hosted chatrooms/conferences for XMPP users.
General information on setting up and using multi-user chatrooms can be found General information on setting up and using multi-user chatrooms can be found
in the "Chatrooms" documentation (@url{http://prosody.im/doc/chatrooms}), in the "Chatrooms" documentation (@url{https://prosody.im/doc/chatrooms}),
which you should read if you are new to XMPP chatrooms. which you should read if you are new to XMPP chatrooms.
See also @url{http://prosody.im/doc/modules/mod_muc}. See also @url{https://prosody.im/doc/modules/mod_muc}.
Available @code{mod-muc-configuration} fields are: Available @code{mod-muc-configuration} fields are:
@ -14311,7 +14311,7 @@ Defaults to @samp{20}.
@deftypevr {@code{prosody-configuration} parameter} ext-component-configuration-list ext-components @deftypevr {@code{prosody-configuration} parameter} ext-component-configuration-list ext-components
External components use XEP-0114, which most standalone components External components use XEP-0114, which most standalone components
support. To add an external component, you simply fill the hostname field. See support. To add an external component, you simply fill the hostname field. See
@url{http://prosody.im/doc/components}. @url{https://prosody.im/doc/components}.
Defaults to @samp{()}. Defaults to @samp{()}.
Available @code{ext-component-configuration} fields are: Available @code{ext-component-configuration} fields are:

View file

@ -320,13 +320,13 @@ (define-all-configurations prosody-configuration
(data-path (data-path
(file-name "/var/lib/prosody") (file-name "/var/lib/prosody")
"Location of the Prosody data storage directory. See "Location of the Prosody data storage directory. See
@url{http://prosody.im/doc/configure}." @url{https://prosody.im/doc/configure}."
global) global)
(plugin-paths (plugin-paths
(file-name-list '()) (file-name-list '())
"Additional plugin directories. They are searched in all the specified "Additional plugin directories. They are searched in all the specified
paths in order. See @url{http://prosody.im/doc/plugins_directory}." paths in order. See @url{https://prosody.im/doc/plugins_directory}."
global) global)
(certificates (certificates
@ -339,15 +339,15 @@ (define-all-configurations prosody-configuration
(admins (admins
(string-list '()) (string-list '())
"This is a list of accounts that are admins for the server. Note that you "This is a list of accounts that are admins for the server. Note that you
must create the accounts separately. See @url{http://prosody.im/doc/admins} and must create the accounts separately. See @url{https://prosody.im/doc/admins} and
@url{http://prosody.im/doc/creating_accounts}. @url{https://prosody.im/doc/creating_accounts}.
Example: @code{(admins '(\"user1@@example.com\" \"user2@@example.net\"))}" Example: @code{(admins '(\"user1@@example.com\" \"user2@@example.net\"))}"
common) common)
(use-libevent? (use-libevent?
(boolean #f) (boolean #f)
"Enable use of libevent for better performance under high load. See "Enable use of libevent for better performance under high load. See
@url{http://prosody.im/doc/libevent}." @url{https://prosody.im/doc/libevent}."
common) common)
(modules-enabled (modules-enabled
@ -355,7 +355,7 @@ (define-all-configurations prosody-configuration
"This is the list of modules Prosody will load on startup. It looks for "This is the list of modules Prosody will load on startup. It looks for
@code{mod_modulename.lua} in the plugins folder, so make sure that exists too. @code{mod_modulename.lua} in the plugins folder, so make sure that exists too.
Documentation on modules can be found at: Documentation on modules can be found at:
@url{http://prosody.im/doc/modules}." @url{https://prosody.im/doc/modules}."
common) common)
(modules-disabled (modules-disabled
@ -368,13 +368,13 @@ (define-all-configurations prosody-configuration
(file-name "/var/lib/prosody/sharedgroups.txt") (file-name "/var/lib/prosody/sharedgroups.txt")
"Path to a text file where the shared groups are defined. If this path is "Path to a text file where the shared groups are defined. If this path is
empty then @samp{mod_groups} does nothing. See empty then @samp{mod_groups} does nothing. See
@url{http://prosody.im/doc/modules/mod_groups}." @url{https://prosody.im/doc/modules/mod_groups}."
common) common)
(allow-registration? (allow-registration?
(boolean #f) (boolean #f)
"Disable account creation by default, for security. See "Disable account creation by default, for security. See
@url{http://prosody.im/doc/creating_accounts}." @url{https://prosody.im/doc/creating_accounts}."
common) common)
(ssl (ssl
@ -382,13 +382,13 @@ (define-all-configurations prosody-configuration
"These are the SSL/TLS-related settings. Most of them are disabled so to "These are the SSL/TLS-related settings. Most of them are disabled so to
use Prosody's defaults. If you do not completely understand these options, do use Prosody's defaults. If you do not completely understand these options, do
not add them to your config, it is easy to lower the security of your server not add them to your config, it is easy to lower the security of your server
using them. See @url{http://prosody.im/doc/advanced_ssl_config}." using them. See @url{https://prosody.im/doc/advanced_ssl_config}."
common) common)
(c2s-require-encryption? (c2s-require-encryption?
(boolean #f) (boolean #f)
"Whether to force all client-to-server connections to be encrypted or not. "Whether to force all client-to-server connections to be encrypted or not.
See @url{http://prosody.im/doc/modules/mod_tls}." See @url{https://prosody.im/doc/modules/mod_tls}."
common) common)
(disable-sasl-mechanisms (disable-sasl-mechanisms
@ -400,7 +400,7 @@ (define-all-configurations prosody-configuration
(s2s-require-encryption? (s2s-require-encryption?
(boolean #f) (boolean #f)
"Whether to force all server-to-server connections to be encrypted or not. "Whether to force all server-to-server connections to be encrypted or not.
See @url{http://prosody.im/doc/modules/mod_tls}." See @url{https://prosody.im/doc/modules/mod_tls}."
common) common)
(s2s-secure-auth? (s2s-secure-auth?
@ -408,7 +408,7 @@ (define-all-configurations prosody-configuration
"Whether to require encryption and certificate authentication. This "Whether to require encryption and certificate authentication. This
provides ideal security, but requires servers you communicate with to support provides ideal security, but requires servers you communicate with to support
encryption AND present valid, trusted certificates. See encryption AND present valid, trusted certificates. See
@url{http://prosody.im/doc/s2s#security}." @url{https://prosody.im/doc/s2s#security}."
common) common)
(s2s-insecure-domains (s2s-insecure-domains
@ -416,14 +416,14 @@ (define-all-configurations prosody-configuration
"Many servers don't support encryption or have invalid or self-signed "Many servers don't support encryption or have invalid or self-signed
certificates. You can list domains here that will not be required to certificates. You can list domains here that will not be required to
authenticate using certificates. They will be authenticated using DNS. See authenticate using certificates. They will be authenticated using DNS. See
@url{http://prosody.im/doc/s2s#security}." @url{https://prosody.im/doc/s2s#security}."
common) common)
(s2s-secure-domains (s2s-secure-domains
(string-list '()) (string-list '())
"Even if you leave @code{s2s-secure-auth?} disabled, you can still require "Even if you leave @code{s2s-secure-auth?} disabled, you can still require
valid certificates for some domains by specifying a list here. See valid certificates for some domains by specifying a list here. See
@url{http://prosody.im/doc/s2s#security}." @url{https://prosody.im/doc/s2s#security}."
common) common)
(authentication (authentication
@ -431,21 +431,21 @@ (define-all-configurations prosody-configuration
"Select the authentication backend to use. The default provider stores "Select the authentication backend to use. The default provider stores
passwords in plaintext and uses Prosody's configured data storage to store the passwords in plaintext and uses Prosody's configured data storage to store the
authentication data. If you do not trust your server please see authentication data. If you do not trust your server please see
@url{http://prosody.im/doc/modules/mod_auth_internal_hashed} for information @url{https://prosody.im/doc/modules/mod_auth_internal_hashed} for information
about using the hashed backend. See also about using the hashed backend. See also
@url{http://prosody.im/doc/authentication}" @url{https://prosody.im/doc/authentication}"
common) common)
;; TODO: Handle more complicated log structures. ;; TODO: Handle more complicated log structures.
(log (log
(maybe-string "*syslog") (maybe-string "*syslog")
"Set logging options. Advanced logging configuration is not yet supported "Set logging options. Advanced logging configuration is not yet supported
by the GuixSD Prosody Service. See @url{http://prosody.im/doc/logging}." by the GuixSD Prosody Service. See @url{https://prosody.im/doc/logging}."
common) common)
(pidfile (pidfile
(file-name "/var/run/prosody/prosody.pid") (file-name "/var/run/prosody/prosody.pid")
"File to write pid in. See @url{http://prosody.im/doc/modules/mod_posix}." "File to write pid in. See @url{https://prosody.im/doc/modules/mod_posix}."
global) global)
(http-max-content-size (http-max-content-size
@ -476,7 +476,7 @@ (define-all-configurations prosody-configuration
Prosody's configuration. Conversely a server that hosts a single domain would Prosody's configuration. Conversely a server that hosts a single domain would
have just one VirtualHost entry. have just one VirtualHost entry.
See @url{http://prosody.im/doc/configure#virtual_host_settings}." See @url{https://prosody.im/doc/configure#virtual_host_settings}."
global) global)
(int-components (int-components
@ -490,14 +490,14 @@ (define-all-configurations prosody-configuration
internal component, you simply fill the hostname field, and the plugin you wish internal component, you simply fill the hostname field, and the plugin you wish
to use for the component. to use for the component.
See @url{http://prosody.im/doc/components}." See @url{https://prosody.im/doc/components}."
global) global)
(ext-components (ext-components
(ext-component-configuration-list '()) (ext-component-configuration-list '())
"External components use XEP-0114, which most standalone components "External components use XEP-0114, which most standalone components
support. To add an external component, you simply fill the hostname field. See support. To add an external component, you simply fill the hostname field. See
@url{http://prosody.im/doc/components}." @url{https://prosody.im/doc/components}."
global) global)
(component-secret (component-secret
@ -536,10 +536,10 @@ (define-all-configurations prosody-configuration
hosted chatrooms/conferences for XMPP users. hosted chatrooms/conferences for XMPP users.
General information on setting up and using multi-user chatrooms can be found General information on setting up and using multi-user chatrooms can be found
in the \"Chatrooms\" documentation (@url{http://prosody.im/doc/chatrooms}), in the \"Chatrooms\" documentation (@url{https://prosody.im/doc/chatrooms}),
which you should read if you are new to XMPP chatrooms. which you should read if you are new to XMPP chatrooms.
See also @url{http://prosody.im/doc/modules/mod_muc}." See also @url{https://prosody.im/doc/modules/mod_muc}."
int-component) int-component)
(hostname (hostname