From 78683c593297d4bff4bf11a853babad95e2b3a4e Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Fri, 29 May 2020 01:02:02 +0200 Subject: [PATCH 1/2] acmed.toml(5): Fix config key: hook_type -> type --- man/en/acmed.toml.5 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/en/acmed.toml.5 b/man/en/acmed.toml.5 index 6ab9438..4783b06 100644 --- a/man/en/acmed.toml.5 +++ b/man/en/acmed.toml.5 @@ -99,7 +99,7 @@ for more details. Defines if an error return value for this hook is allowed or not. If not allowed, a failure in this hook will fail the whole certificate request process. Default is false. .It Cm name Ar string The name the hook is registered under. Must be unique. -.It Cm hook_type Ar array +.It Cm type Ar array Array of strings. Possible types are: .Bl -dash -compact .It From bd3b7cc0861221ce19180c12943607f2a57c3fc9 Mon Sep 17 00:00:00 2001 From: Danilo Bargen Date: Fri, 29 May 2020 01:02:19 +0200 Subject: [PATCH 2/2] acmed.toml(5): Grammar fixes --- man/en/acmed.toml.5 | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/man/en/acmed.toml.5 b/man/en/acmed.toml.5 index 4783b06..93ae22b 100644 --- a/man/en/acmed.toml.5 +++ b/man/en/acmed.toml.5 @@ -204,15 +204,15 @@ Path to the directory where certificates and their associated private keys are s Names of hooks that will be called when requesting a new certificate. The hooks are guaranteed to be called sequentially in the declaration order. .El .Sh WRITING A HOOK -When requesting a certificate to a CA using ACME, there is three steps that are hard to automatize. The first one is solving challenges in order to prove the ownership of every domains to be included: it requires to interact with the configuration of other services, hence depends on how the infrastructure works. The second one is restarting all the services that uses a given certificate, for the same reason. The last one is archiving: although several default methods can be implemented, sometimes admins wants or are required to do it in a different way. +When requesting a certificate from a CA using ACME, there are three steps that are hard to automatize. The first one is solving challenges in order to prove the ownership of every domains to be included: It requires to interact with the configuration of other services, hence depends on how the infrastructure works. The second one is restarting all the services that use a given certificate, for the same reason. The last one is archiving: Although several default methods can be implemented, sometimes admins wants or are required to do it in a different way. .Pp -In order to allow a full automation of the three above steps without imposing arbitrary restrictions or methods, +In order to allow full automation of the three above steps without imposing arbitrary restrictions or methods, .Xr acmed 8 -uses hooks. Fundamentally, a hook is a command line template that will be called at a specific time of the process. Such approach allows admins to use any executable script or program located on the machine to customize the process. +uses hooks. Fundamentally, a hook is a command line template that will be called at a specific time of the process. Such an approach allows admins to use any executable script or program located on the machine to customize the process. .Pp For a given certificate, hooks are guaranteed to be called sequentially in the declaration order. It is therefore possible to have a hook that depends on another one. Nevertheless, several certificates may be renewed at the same time. Hence, hooks shall not use globing or any other action that may disrupt hooks called by a different certificate. .Pp -A hook have a type that will influence both the moment it is called and the available template variables. It is possible to declare several types. In such a case, the hook will be invoked whenever one of its type request it. When called, the hook only have access to template variable for the current type. If a hook uses a template variable that does not exists for the current type it is invoked for, the variable is empty. +A hook has a type that will influence both the moment it is called and the available template variables. It is possible to declare several types. In such a case, the hook will be invoked whenever one of its type request it. When called, the hook only have access to template variable for the current type. If a hook uses a template variable that does not exists for the current type it is invoked for, the variable is empty. .Pp When writing a hook, the values of .Em args ,