aboutsummaryrefslogtreecommitdiffstats
path: root/lfacme.8.in
diff options
context:
space:
mode:
authorLexi Winter <lexi@le-fay.org>2025-06-04 19:33:21 +0100
committerLexi Winter <lexi@le-fay.org>2025-06-04 19:33:21 +0100
commitace580c522836e5287f4603ceea5da41881a4651 (patch)
treebaf0ed9518439f94c57570b5b2272d2b2329845e /lfacme.8.in
parent81ea52277cfe0396d4a2a2a2cc3ab9e98c3c99f7 (diff)
downloadlfacme-ace580c522836e5287f4603ceea5da41881a4651.tar.gz
lfacme-ace580c522836e5287f4603ceea5da41881a4651.tar.bz2
replace lfacme-{setup,renew} with a single lfacme command
Diffstat (limited to 'lfacme.8.in')
-rw-r--r--lfacme.8.in88
1 files changed, 88 insertions, 0 deletions
diff --git a/lfacme.8.in b/lfacme.8.in
new file mode 100644
index 0000000..7dab735
--- /dev/null
+++ b/lfacme.8.in
@@ -0,0 +1,88 @@
+.\" This source code is released into the public domain.
+.Dd June 4, 2025
+.Dt LFACME 7
+.Os
+.Sh NAME
+.Nm lfacme
+.Nd issue, renew and manage ACME certificates
+.Sh SYNOPSIS
+.Nm lfacme
+.Op Fl v
+.Op Fl c Ar confdir
+.Cm setup
+.Op Fl y
+.Nm lfacme
+.Op Fl v
+.Op Fl c Ar confdir
+.Cm renew
+.Op Fl f
+.Sh DESCRIPTION
+The
+.Nm
+command supports automated management of TLS certificates using an ACME server.
+Certificates can be automatically issued and renewed, and a hook system allows
+software using those certificates to be automatically (re)configured with the
+new certificate.
+.Pp
+Prior to using
+.Nm ,
+two configuration files must be created:
+.Pa __CONFDIR__/acme.conf
+and
+.Pa __CONFDIR__/domains.conf .
+Samples of both files are provided in
+.Pa __CONFDIR__ .
+Refer to
+.Xr acme.conf 5
+and
+.Xr domains.conf 5
+for more detailed documentation on these files.
+.Pp
+The following options are supported:
+.Bl -tag -width Fl c Ar confdir
+.It Fl c Ar confdir
+Load the configuration from
+.Ar confdir
+instead of the default
+.Pa __CONFDIR__ .
+.It Fl v
+Print more detailed output while running.
+.El
+.Pp
+The following commands are supported:
+.Bl -tag -width Cm setup
+.It Cm setup
+Create a new account on the ACME server.
+This must be run prior to issuing any certificates.
+See
+.Xr lfacme-setup 8 .
+.It Cm renew
+Issue or renew any certificates based on the
+.Xr domains.conf 5
+configuration file.
+See
+.Xr lfacme-renew 8 .
+.Sh ENVIRONMENT
+The following environment variables affect the executation of
+.Nm :
+.Bl -tag -width LFACME_VERBOSE
+.It Ev LFACME_CONFDIR
+Override the default configuration directory.
+This is equivalent to specifying the
+.Fl c
+flag on the command line.
+.It Ev LFACME_VERBOSE
+If set to a non-empty string, run in verbose mode.
+This is equivalent to specifying the
+.Fl v
+flag on the command line.
+.El
+.Pp
+Additionally, any configuration settings described in
+.Xr acme.conf 5
+may also be set in the environment.
+.Sh SEE ALSO
+.Xr acme.conf 5 ,
+.Xr domains.conf 5 ,
+.Xr lfacme-renew 8 ,
+.Xr lfacme-setup 8