From patchwork Wed Apr 30 15:34:37 2025 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Felix Lechner X-Patchwork-Id: 42181 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 E208427BC4B; Wed, 30 Apr 2025 16:36:31 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-6.4 required=5.0 tests=BAYES_00,DKIM_INVALID, DKIM_SIGNED,MAILING_LIST_MULTI,RCVD_IN_DNSWL_BLOCKED, RCVD_IN_VALIDITY_CERTIFIED,RCVD_IN_VALIDITY_RPBL,RCVD_IN_VALIDITY_SAFE, SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable 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 A732A27BC49 for ; Wed, 30 Apr 2025 16:36:30 +0100 (BST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1uA9Ti-0008Cm-HP; Wed, 30 Apr 2025 11:36:06 -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 1uA9Th-0008Bz-8A for guix-patches@gnu.org; Wed, 30 Apr 2025 11:36:05 -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 1uA9Tg-00087h-Tn; Wed, 30 Apr 2025 11:36:04 -0400 DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; d=debbugs.gnu.org; s=debbugs-gnu-org; h=MIME-Version:References:In-Reply-To:Date:From:To:Subject; bh=1tETzwYAOftCLDa/hqH6jzIVTXrNp2JAhTEPHEERjmQ=; b=lKpehxoNSMPA44nJqUQQhvIcHsTAAtWUjGrwUILhPzgra9O1On1784Nu5lFzlkAQay1mbqtArhZZMayvVTY4Bj+PEC5lR/bYvQ7cu6gbyXDo8IRq5GTgHal3vLKc78AZc/d7mHccSM2ABY9710A4bLtXbZjx/mPt+87JbUa1WAAfj/Ah468dbBLCsk3LGXd/CW25sV39ThgReyhuHX4qCXFjKyZuqH91/2MNu8QDeaFVeJCDj7df/VYC0ku82xbWIMkLXWeXqavgxY71HSfbrRgfMsrorH5j0LMZkUQ3rF/5aZ1/lVvWHu1Dda7+EQ0jYi/yhopsmUcT/0JxtMGAvA==; Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1uA9Tf-0002UY-0C; Wed, 30 Apr 2025 11:36:03 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#67497] [PATCH v2 2/4] In certbot documentation, call environment variables by their proper name. Resent-From: Felix Lechner Original-Sender: "Debbugs-submit" Resent-CC: gabriel@erlikon.ch, ludo@gnu.org, maxim.cournoyer@gmail.com, guix-patches@gnu.org Resent-Date: Wed, 30 Apr 2025 15:36: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 help To: 67497@debbugs.gnu.org Cc: Carlo Zancanaro , Bruno Victal , Felix Lechner , Maxim Cournoyer , Gabriel Wicki , Ludovic =?utf-8?q?Court=C3=A8s?= , Maxim Cournoyer X-Debbugs-Original-Xcc: Gabriel Wicki , Ludovic =?utf-8?q?Court=C3=A8s?= , Maxim Cournoyer Received: via spool by 67497-submit@debbugs.gnu.org id=B67497.17460273179433 (code B ref 67497); Wed, 30 Apr 2025 15:36:02 +0000 Received: (at 67497) by debbugs.gnu.org; 30 Apr 2025 15:35:17 +0000 Received: from localhost ([127.0.0.1]:43925 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1uA9Sv-0002Rp-8r for submit@debbugs.gnu.org; Wed, 30 Apr 2025 11:35:17 -0400 Received: from sail-ipv4.us-core.com ([208.82.101.137]:49108) by debbugs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.84_2) (envelope-from ) id 1uA9Sm-0002M8-D0 for 67497@debbugs.gnu.org; Wed, 30 Apr 2025 11:35:09 -0400 DKIM-Signature: v=1; a=rsa-sha256; c=simple/simple; s=2017; bh=m07dR0mb10lL5cW Oa5LSDtsYMk2tsHDsvBEVpeGOCbM=; h=references:in-reply-to:date:subject: cc:to:from; d=lease-up.com; b=aNuFbiNqx4tHrRyV6XVsReNlwVI4sT932plZbyni enVj3mVR3dFGUv4alZxM8y4y1YCjYhA+XIdS6kgad1cFrhNVWgOwIW5qYV/9gVogKS10dh o+lOK1gLDTxPnZL+bVXJh6Oo2DCCfuMUvCHPz/ygrhkR+ecZQpDii+7np6Ey8= Received: by sail-ipv4.us-core.com (OpenSMTPD) with ESMTPSA id 7d2d8054 (TLSv1.3:TLS_AES_256_GCM_SHA384:256:NO); Wed, 30 Apr 2025 15:35:04 +0000 (UTC) Received: from localhost (localhost [local]) by localhost (OpenSMTPD) with ESMTPA id f371d704; Wed, 30 Apr 2025 15:35:03 +0000 (UTC) Date: Wed, 30 Apr 2025 08:34:37 -0700 Message-ID: X-Mailer: git-send-email 2.49.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 b48255a16e0..1b0fa4f2a3a 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -35471,24 +35471,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"}.