.\" Generated by scdoc 1.11.3
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "acme-redirect.conf" "5" "2024-10-05"
.PP
.SH NAME
.PP
acme-redirect.\&conf - \fBacme-redirect\fR configuration files
.PP
.SH SYNOPSIS
.PP
/etc/acme-redirect.\&conf
.PP
.SH DESCRIPTION
.PP
This file configures general settings for \fBacme-redirect\fR.\& To configure
certificates have a look at \fBacme-redirect.\&d\fR(5).\&
.PP
.SH OPTIONS ([acme])
.PP
\fIacme_email=\fR
.RS 4
The contact email for your acme provider to reach out to you.\& They are
usually going to notify you if your automatic renew doesn'\&t seem to be
working, or if the acme protocol is going to be updated.\&
.PP
.RE
\fIacme_url=\fR
.RS 4
The acme endpoint to use.\& The default is LetsEncrypt production.\&
.PP
.RE
\fIrenew_if_days_left=\fR
.RS 4
Renew the certificate if the number of days is \fBequal or lower\fR.\& You are
going to run into issues if you set it lower than 1.\& The default is 30.\&
.PP
.RE
.SH OPTIONS ([system])
.PP
\fIexec=\fR
.RS 4
A list of global fallback hooks that are executed if the certificate
config didn'\&t specify any hooks.\& The hooks are expected to be shell
commands.\&
.PP
.RE
\fIexec_extra=\fR
.RS 4
A list of global hooks that are executed after any certificate is renewed and
its hooks have been executed.\& The hooks are expected to be shell commands.\&
.PP
.RE
.SH EXAMPLE
.PP
.nf
.RS 4
[acme]
acme_email = "nobody@example\&.com"
acme_url = "https://acme-staging-v02\&.api\&.letsencrypt\&.org/directory"
renew_if_days_left = 30

[system]
## Default hooks if the certificate config doesn\&'t define any
exec = [
    "systemctl reload nginx",
]
## Execute these hooks globally for all certificates
exec_extra = [
    "systemctl reload dovecot",
]
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fBacme-redirect\fR(1), \fBacme-redirect.\&d\fR(5).\&
.PP
.SH AUTHORS
.PP
acme-redirect was originally written by kpcyrd and is hosted at
https://github.\&com/kpcyrd/acme-redirect