diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/guix.texi | 21 |
1 files changed, 12 insertions, 9 deletions
diff --git a/doc/guix.texi b/doc/guix.texi index bd85b33fdb..144adf327e 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -32963,16 +32963,19 @@ This is the type of the agate service, whose value should be an (service agate-service-type (agate-configuration (content "/srv/gemini") - (certs "/srv/gemini-certs"))) + (certificates "/srv/gemini-certs"))) @end lisp The example above represents the minimal tweaking necessary to get Agate up and running. Specifying the path to the certificate and key directory is always necessary, as the Gemini protocol requires TLS by default. -If specified path is writable by Agate, and contains no valid key -and certificate, the Agate will try to generate them on the first start. -If specified directory is read-only - key and certificate should be pre-generated by user. +If specified @code{certificates} path is writable by Agate, and contains no +valid pre-generated key and certificate, the Agate will try to generate +them on the first start. In this case you should pass at least one +hostname using the @code{hostnames} option. +If specified directory is read-only - key and certificate should be +pre-generated by user. To obtain a certificate and a key in a DER format, you could, for example, use OpenSSL, running a commands similar to the following example: @@ -32986,7 +32989,7 @@ openssl req -x509 -key key.der -outform DER -days 3650 -out cert.der \ Of course, you'll have to replace @i{example.com} with your own domain name, and then point the Agate configuration towards the path of the -directory with the generated key and certificate using the @code{certs} option. +directory with the generated key and certificate using the @code{certificates} option. @end defvar @@ -33000,10 +33003,10 @@ The package object of the Agate server. @item @code{content} (default: @file{"/srv/gemini"}) The directory from which Agate will serve files. -@item @code{certs} (default: @file{"/srv/gemini-certs"}) +@item @code{certificates} (default: @file{"/srv/gemini-certs"}) Root of the certificate directory. Must be filled in with a value from the user. -@item @code{addr} (default: @code{'("0.0.0.0:1965" "[::]:1965")}) +@item @code{addresses} (default: @code{'("[::]:1965" "0.0.0.0:1965")}) A list of the addresses to listen on. @item @code{hostnames} (default: @code{'()}) @@ -33011,7 +33014,7 @@ Virtual hosts for the Gemini server. If multiple values are specified, corresponding directory names should be present in the @code{content} directory. Optional. -@item @code{lang} (default: @code{#f}) +@item @code{languages} (default: @code{#f}) RFC 4646 language code(s) for text/gemini documents. Optional. @item @code{only-tls13?} (default: @code{#f}) @@ -33021,7 +33024,7 @@ Set to @code{#t} to disable support for TLSv1.2. Set to @code{#t} to serve secret files (files/directories starting with a dot). -@item @code{central-conf?} (default: @code{#f}) +@item @code{central-configuration?} (default: @code{#f}) Set to @code{#t} to look for the .meta configuration file in the @code{content} root directory and will ignore @code{.meta} files in other directories |