.. Open Infrastructure: service-tools

.. Copyright (C) 2014-2025 Daniel Baumann <daniel.baumann@open-infrastructure.net>
..
.. 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 <https://www.gnu.org/licenses/>.

===============
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

Usage
=====

Installation
------------

| sudo echo HOOK="/usr/bin/dehydrated-hook" > /etc/dehydrated/conf.d/zz-hook.sh
| sudo mkdir -p /etc/dehydrated/hook.d

Removal
-------

| sudo rm -f /etc/dehydrated/conf.d/zz-hook.sh
| sudo rmdir /etc/dehydrated/hook.d

Files
=====

The following files are used:

/etc/dehydrated/hook.d:
  directory to place individual hooks.

See also
========

| dehydrated(1),
| dehydrated-cron(1),
| dehydrated-nsupdate(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 <software@lists.open-infrastructure.net>.

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 <daniel.baumann@open-infrastructure.net> and others.
