From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms13.migadu.com with LMTPS id mAdRKPgnd2ZqVAAAqHPOHw:P1 (envelope-from ) for ; Sat, 22 Jun 2024 19:37:28 +0000 Received: from aspmx1.migadu.com ([2001:41d0:303:e224::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0.migadu.com with LMTPS id mAdRKPgnd2ZqVAAAqHPOHw (envelope-from ) for ; Sat, 22 Jun 2024 21:37:28 +0200 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20230601 header.b=foqA3VrJ; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1719085048; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-transfer-encoding:content-transfer-encoding:resent-cc: resent-from:resent-sender:resent-message-id:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=N1aXpfejDC0OoBW0DuXaBkhE9Tl2WF+PbORDgm0v8lI=; b=VqCB1CGOGP8rLyFY7fOkGm3lbImpJg1VsxU0Vw1swyjJcs2zS/SphSrVGZMZG8b6FqyA7c L0ZPsuKFuMdGvziJn9ghsm3QqO1BTQzlE1tZJCKtaK6SQs7MsrG+rAXoIayIaBcn/LHoRd j+/DA11O1rUSiFxZ7GNeQcypup0aw1bj94n9uujh3vpJpOmFOeK13CaTTB6bLyOWPKr311 /EmwPBy8p+ppYingKel2JlV2R0h24ma32L/d113dYITHk9LT2x7iF4rSQT5nCTkp3OaOS2 VvcrxIDYNmHYFdmj4SV6IvmEydDutvCXRKYcLRwvmIGLXUnz/6Zgv9rKCyB6Zw== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1719085048; a=rsa-sha256; cv=none; b=fEfreKkNhSW+glsInoiUKMJQX+zXfNMcTmVKxD6dwklac9eiRZmQ/cHzbwQfMf9HcV+vEb j+1lHcEajKcpTfzQvEy91SEELzHgL3JrufTfZeDHW7iDvAnL16tjI8bSQI37Ib7yV3TFXA ERjlyrK58CpP4P269d3l6jHNJ3d3iUIwe1E0K8MMhEyqPOs+2sDf8yvDFLh7BA1+FgK1mG BEFi4INXC6M/WVutrwc/kQuaG3Dwu08LnQuKRUCYW/LweZiMk0ofAwwknce2+hBbIgMp0B DS/zPB+/ItNJ1430S3sXgyuNIUi8X0OiocYPWFG3s36sQ9evpAc2VoZEONeB6Q== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=gmail.com header.s=20230601 header.b=foqA3VrJ; dmarc=fail reason="SPF not aligned (relaxed)" header.from=gmail.com (policy=none); spf=pass (aspmx1.migadu.com: domain of "guix-patches-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-patches-bounces+larch=yhetil.org@gnu.org" Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 5F6EF622E0 for ; Sat, 22 Jun 2024 21:37:28 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1sL6Xp-0001QP-N6; Sat, 22 Jun 2024 15:37:05 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1sL6Xn-0001Pa-DJ for guix-patches@gnu.org; Sat, 22 Jun 2024 15:37:03 -0400 Received: from debbugs.gnu.org ([2001:470:142:5::43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1sL6Xn-0000PK-4V for guix-patches@gnu.org; Sat, 22 Jun 2024 15:37:03 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1sL6Xn-0001Q9-0L for guix-patches@gnu.org; Sat, 22 Jun 2024 15:37:03 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#71722] [PATCH 2/2] services: agate-service-type: Update documentation. Resent-From: Rodion Goritskov Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 22 Jun 2024 19:37:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 71722 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 71722@debbugs.gnu.org Cc: Rodion Goritskov Received: via spool by 71722-submit@debbugs.gnu.org id=B71722.17190849995413 (code B ref 71722); Sat, 22 Jun 2024 19:37:02 +0000 Received: (at 71722) by debbugs.gnu.org; 22 Jun 2024 19:36:39 +0000 Received: from localhost ([127.0.0.1]:57788 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sL6XO-0001PE-MB for submit@debbugs.gnu.org; Sat, 22 Jun 2024 15:36:39 -0400 Received: from mail-wr1-f51.google.com ([209.85.221.51]:61682) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1sL6XN-0001Oy-3j for 71722@debbugs.gnu.org; Sat, 22 Jun 2024 15:36:37 -0400 Received: by mail-wr1-f51.google.com with SMTP id ffacd0b85a97d-364b2f92388so2044583f8f.2 for <71722@debbugs.gnu.org>; Sat, 22 Jun 2024 12:36:37 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20230601; t=1719084931; x=1719689731; darn=debbugs.gnu.org; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:from:to:cc:subject:date :message-id:reply-to; bh=N1aXpfejDC0OoBW0DuXaBkhE9Tl2WF+PbORDgm0v8lI=; b=foqA3VrJdFO9ga0IAFeMEWbVLMCxjLb9Hs5jrb9KiHoEuicYuxw9rK+uKSeDiirjqj smW6AFqzUWFN1WCurnAci1dpUJ5P/CmydZoKyH4UJz2TVWllHOWfiAQJSFm6psYGoEGT /EHSRd7cg6aEq/A+TObToxZJXuKqrP0ZyZJdPTm7KMLG6oXuqrdnLhfeh6Si7MIeVRth D4OCeyC0R8U1cdwGqkW/w6KVbKM0GvAf5/cZORV9G3DUGdH3vUACFGiWAQRyHCqGuTch TgncfLtq78rYQdqDDgKzOrc9BSMyKZH28ZufSOhnQrfWfVPVjS3KBdr2wslqVNxPtyaM KuMw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1719084931; x=1719689731; h=content-transfer-encoding:mime-version:references:in-reply-to :message-id:date:subject:cc:to:from:x-gm-message-state:from:to:cc :subject:date:message-id:reply-to; bh=N1aXpfejDC0OoBW0DuXaBkhE9Tl2WF+PbORDgm0v8lI=; b=eoMh/iv9eeh9LBdLDDWO8MW2dR0N6eiMZpA2sMuSpLoPt3XHJ+u/WqRJOS4nu5NTLN /0jfKx+MtoVS9Cvw+Ff5pvSzmnNhU+GvojYmzz/QyoYG7/QfrOL72XxzpxpDXKxxRpYo nqQx/cmlYcP5kmrZojw+qrHDdtBSv+xsNiCRHg3kSZymSDy0+uklFyegMCcUeqMGLfjh Wtm5aNqllmmF/UKBTRHWsuDihWsXhRZOXNBHkgUM/jKbRvKHeQ/vvqhsrQulUwfU/NOs 2mrt3AGGmfZ6y6KGKIrMvdUaI6d00YxnTDg25j4YZRFM4MS+fwSkB4OVhusFLqPGHCic LZbw== X-Gm-Message-State: AOJu0YzkJ5t9yZ1XSQuiNP46nx1Jkf05dPDS1AozBhzofkgMfanE9BrY Tm/NydGC5WkwDbgvdR5SZzRFtlg6R0WZpKkElGiJrDJafN00HIR5gWF1sQ== X-Google-Smtp-Source: AGHT+IEd05W2V78xhC4stBg3Ai+cQqzrI2PBHcbCFRkmSSHNjOkvX9wT5U/zodG8lfQahfMQnKT7fg== X-Received: by 2002:a5d:4a47:0:b0:35f:22e4:fb58 with SMTP id ffacd0b85a97d-366e9463f42mr319110f8f.8.1719084930568; Sat, 22 Jun 2024 12:35:30 -0700 (PDT) Received: from bumblebee-mighty.lan ([92.51.75.166]) by smtp.gmail.com with ESMTPSA id ffacd0b85a97d-366389b8ab0sm5433576f8f.27.2024.06.22.12.35.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 22 Jun 2024 12:35:30 -0700 (PDT) From: Rodion Goritskov Date: Sat, 22 Jun 2024 23:33:55 +0400 Message-ID: <60dbc3caee3fc6038fceeeb5ca677cf1d626c8a7.1719082137.git.rodion.goritskov@gmail.com> X-Mailer: git-send-email 2.45.1 In-Reply-To: References: MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+larch=yhetil.org@gnu.org Sender: guix-patches-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Queue-Id: 5F6EF622E0 X-Migadu-Scanner: mx12.migadu.com X-Migadu-Spam-Score: -4.76 X-Spam-Score: -4.76 X-TUID: Fkr8UE7ogEq+ * doc/guix.texi: Document (agate-service-type) updated options. Change-Id: Ifb4968d704627344913bb69f20636d710a4fe738 --- doc/guix.texi | 51 ++++++++++++++++++++++++++++++++------------------- 1 file changed, 32 insertions(+), 19 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 0102fd0fad..c75de94486 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -32734,25 +32734,30 @@ Web Services (service agate-service-type (agate-configuration (content "/srv/gemini") - (cert "/srv/cert.pem") - (key "/srv/key.rsa"))) + (certs "/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 is +up and running. Specifying the path to the certificate and key directory is always necessary, as the Gemini protocol requires TLS by default. -To obtain a certificate and a key, you could, for example, use OpenSSL, -running a command similar to the following example: +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. + +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: @example -openssl req -x509 -newkey rsa:4096 -keyout key.rsa -out cert.pem \ - -days 3650 -nodes -subj "/CN=example.com" +openssl genpkey -out key.der -outform DER -algorithm RSA \ + -pkeyopt rsa_keygen_bits:4096 +openssl req -x509 -key key.der -outform DER -days 3650 -out cert.der \ + -subj "/CN=example.com" @end example 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 -generated key and certificate. +directory with the generated key and certificate using the @code{certs} option. @end defvar @@ -32766,30 +32771,38 @@ Web Services @item @code{content} (default: @file{"/srv/gemini"}) The directory from which Agate will serve files. -@item @code{cert} (default: @code{#f}) -The path to the TLS certificate PEM file to be used for encrypted -connections. Must be filled in with a value from the user. - -@item @code{key} (default: @code{#f}) -The path to the PKCS8 private key file to be used for encrypted -connections. Must be filled in with a value from the user. +@item @code{certs} (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")}) A list of the addresses to listen on. -@item @code{hostname} (default: @code{#f}) -The domain name of this Gemini server. Optional. +@item @code{hostnames} (default: @code{'()}) +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}) RFC 4646 language code(s) for text/gemini documents. Optional. -@item @code{silent?} (default: @code{#f}) -Set to @code{#t} to disable logging output. +@item @code{only-tls13?} (default: @code{#f}) +Set to @code{#t} to disable support for TLSv1.2. @item @code{serve-secret?} (default: @code{#f}) Set to @code{#t} to serve secret files (files/directories starting with a dot). +@item @code{central-conf?} (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 + +@item @code{ed25519?} (default: @code{#f}) +Set to @code{#t} to generate keys using the Ed25519 signature algorithm +instead of the default ECDSA. + +@item @code{skip-port-check?} (default: @code{#f}) +Set to @code{#t} to skip URL port check even when a @code{hostname} is specified. + @item @code{log-ip?} (default: @code{#t}) Whether or not to output IP addresses when logging. -- 2.45.1