From d55a426092b6d3f432c2126ef5fbda7a566e3ed2 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Tue, 7 Sep 2021 05:58:56 +0200 Subject: Adding initial dehydrated-hook manpage. Signed-off-by: Daniel Baumann --- dehydrated/share/man/dehydrated-hook.1.rst | 109 +++++++++++++++++++++++++++++ 1 file changed, 109 insertions(+) create mode 100644 dehydrated/share/man/dehydrated-hook.1.rst (limited to 'dehydrated/share') diff --git a/dehydrated/share/man/dehydrated-hook.1.rst b/dehydrated/share/man/dehydrated-hook.1.rst new file mode 100644 index 0000000..6aef673 --- /dev/null +++ b/dehydrated/share/man/dehydrated-hook.1.rst @@ -0,0 +1,109 @@ +.. Open Infrastructure: service-tools + +.. Copyright (C) 2014-2021 Daniel Baumann +.. +.. SPDX-License-Identifier: GPL-3.0+ +.. +.. This program is free software: you can redistribute it and/or modify +.. it under the terms of the GNU General Public License as published by +.. the Free Software Foundation, either version 3 of the License, or +.. (at your option) any later version. +.. +.. This program is distributed in the hope that it will be useful, +.. but WITHOUT ANY WARRANTY; without even the implied warranty of +.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.. GNU General Public License for more details. +.. +.. You should have received a copy of the GNU General Public License +.. along with this program. If not, see . + +=============== +dehydrated-hook +=============== + +------------------------- +dehydrated run-parts hook +------------------------- + +:manual section: 1 +:manual group: Open Infrastructure + +Synopsis +======== + +| **dehydrated-hook** 'HANDLER' + +Description +=========== + +**dehydrated** is a client for ACME-based Certificate Authorities, such as +LetsEncrypt. It can be used to request and obtain TLS certificates from an +ACME-based certificate authority. + +The **dehydrated-hook** makes it possible to run multiple scripts in every +stage within the process of creating, signing and deploying a certificate. + +Scripts need to be placed in /etc/dehydrated/hook.d and need to be prefixed +with the name of the handler, e.g. exit_hook.example1 or exit_hook.example2.sh + +Handlers +======== + +The following **dehydrated** handlers are available: + +| deploy_challenge + +| clean_challenge + +| sync_cert + +| deploy_cert + +| deploy_ocsp + +| unchanged_cert + +| invalid_challenge + +| request_failure + +| generate_csr + +| startup_hook + +| exit_hook + +Files +===== + +The following files are used: + +/etc/dehydrated/hook.d: + directory to place individual hooks. + +See also +======== + +| dehydrated(1) + +Homepage +======== + +More information about service-tools and the Open Infrastructure project can be +found on the homepage (https://open-infrastructure.net). + +Contact +======= + +Bug reports, feature requests, help, patches, support and everything else are +welcome on the Open Infrastructure Software Mailing List +. + +Debian specific bugs can also be reported in the Debian Bug Tracking System +(https://bugs.debian.org). + +Authors +======= + +service-tools were written by Daniel Baumann + and others. -- cgit v1.2.3