From patchwork Mon Nov 27 21:20:52 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felix Lechner X-Patchwork-Id: 56876 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id 34D4A27BBE2; Mon, 27 Nov 2023 21:22:13 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.7 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,SPF_HELO_PASS,URIBL_BLOCKED autolearn=ham autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 5087627BBEA for ; Mon, 27 Nov 2023 21:22:11 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1r7j3G-0000zF-U3; Mon, 27 Nov 2023 16:21:58 -0500 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 1r7j3F-0000yI-1h for guix-patches@gnu.org; Mon, 27 Nov 2023 16:21:57 -0500 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 1r7j3E-0005n5-FF for guix-patches@gnu.org; Mon, 27 Nov 2023 16:21:56 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1r7j3K-00018w-Ta for guix-patches@gnu.org; Mon, 27 Nov 2023 16:22:02 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#67497] [PATCH 2/4] In certbot documentation, call environment variables by their proper name. Resent-From: Felix Lechner Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Mon, 27 Nov 2023 21:22:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 67497 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 67497@debbugs.gnu.org Cc: Bruno Victal , Felix Lechner Received: via spool by 67497-submit@debbugs.gnu.org id=B67497.17011200984339 (code B ref 67497); Mon, 27 Nov 2023 21:22:02 +0000 Received: (at 67497) by debbugs.gnu.org; 27 Nov 2023 21:21:38 +0000 Received: from localhost ([127.0.0.1]:44987 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r7j2v-00017u-OS for submit@debbugs.gnu.org; Mon, 27 Nov 2023 16:21:38 -0500 Received: from sail-ipv4.us-core.com ([208.82.101.137]:56770) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1r7j2s-00017R-7n for 67497@debbugs.gnu.org; Mon, 27 Nov 2023 16:21:35 -0500 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; s=2017; bh=fvjhNjgOq6aLOZO RmF4VZEHyzgSdcD/CUrbIl3wI0/c=; h=references:in-reply-to:date:subject: cc:to:from; d=lease-up.com; b=ZP2JzvE2snqTnN+SJnNRw/HPPR8hxX78Rj4dqEqg EcIZHcmWIrhiGtE25DAhr5TLcaHVwpa16irPvNysdpph5Lky1Jf/iBFWG0eqaRxQJQcZ9k q5fOIQezwjdfYphlSa905m+7EotHPsRfGu7zYezMWZWHA+GSliJj9bo6BGLW8= Received: by sail-ipv4.us-core.com (OpenSMTPD) with ESMTPSA id 79edd8b4 (TLSv1.3:TLS_CHACHA20_POLY1305_SHA256:256:NO); Mon, 27 Nov 2023 21:21:27 +0000 (UTC) Received: from localhost (localhost [local]) by localhost (OpenSMTPD) with ESMTPA id de854032; Mon, 27 Nov 2023 21:21:26 +0000 (UTC) Date: Mon, 27 Nov 2023 13:20:52 -0800 Message-ID: X-Mailer: git-send-email 2.41.0 In-Reply-To: References: MIME-Version: 1.0 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: , Reply-to: Felix Lechner X-ACL-Warn: , Felix Lechner via Guix-patches X-Patchwork-Original-From: Felix Lechner via Guix-patches via From: Felix Lechner Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches Certbot's hooks can be written in any language. in fact, they can be any kind of executable. Environment variables are widely used to communicate values across that type of fork(2) boundary. In the context here, it is more accurate to talk about environment variables. Change-Id: If0b476c3367a3108d9365d718a74faa7d9fe7530 --- doc/guix.texi | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index b0b1c05c73..440a5f3efa 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -32139,24 +32139,24 @@ Certificate Services @item @code{authentication-hook} (default: @code{#f}) Command to be run in a shell once for each certificate challenge to be -answered. For this command, the shell variable @code{$CERTBOT_DOMAIN} +answered. For this command, the environment variable @code{$CERTBOT_DOMAIN} will contain the domain being authenticated, @code{$CERTBOT_VALIDATION} contains the validation string and @code{$CERTBOT_TOKEN} contains the file name of the resource requested when performing an HTTP-01 challenge. @item @code{cleanup-hook} (default: @code{#f}) Command to be run in a shell once for each certificate challenge that -have been answered by the @code{auth-hook}. For this command, the shell +have been answered by the @code{auth-hook}. For this command, the environment variables available in the @code{auth-hook} script are still available, and additionally @code{$CERTBOT_AUTH_OUTPUT} will contain the standard output of the @code{auth-hook} script. @item @code{deploy-hook} (default: @code{#f}) Command to be run in a shell once for each successfully issued -certificate. For this command, the shell variable +certificate. For this command, the environment variable @code{$RENEWED_LINEAGE} will point to the config live subdirectory (for example, @samp{"/etc/letsencrypt/live/example.com"}) containing the new -certificates and keys; the shell variable @code{$RENEWED_DOMAINS} will +certificates and keys; the environment variable @code{$RENEWED_DOMAINS} will contain a space-delimited list of renewed certificate domains (for example, @samp{"example.com www.example.com"}.