1
0
mirror of https://github.com/certbot/certbot.git synced 2026-01-26 07:41:33 +03:00

Document hook error handling (#4418)

* Document hook error handling

* Clarify wording around hook failure exit codes
This commit is contained in:
Alex Jordan
2017-04-07 13:16:59 -04:00
committed by Brad Warren
parent 4b91f7fbbc
commit dfd4d0c10e

View File

@@ -378,10 +378,16 @@ then restart it after the plugin is finished. Example::
certbot renew --pre-hook "service nginx stop" --post-hook "service nginx start"
The hooks will only be
run if a certificate is due for renewal, so you can run this command
frequently without unnecessarily stopping your webserver. More
information about renewal hooks can be found by running
If a hook exits with a non-zero exit code, the error will be printed
to ``stderr`` but renewal will be attempted anyway. A failing hook
doesn't directly cause Certbot to exit with a non-zero exit code, but
since Certbot exits with a non-zero exit code when renewals fail, a
failed hook causing renewal failures will indirectly result in a
non-zero exit code. Hooks will only be run if a certificate is due for
renewal, so you can run the above command frequently without
unnecessarily stopping your webserver.
More information about renewal hooks can be found by running
``certbot --help renew``.
If you're sure that this command executes successfully without human