path: root/README
diff options
authorSergey Poznyakoff <gray@gnu.org>2019-08-26 13:43:13 +0300
committerSergey Poznyakoff <gray@gnu.org>2019-08-26 13:57:25 +0300
commitd9d63339f7df96d7dfcdbd11edbe996359b5813e (patch)
treecce58ed960a40e05850a3eb7858d4be1b7f0f3ed /README
parent5d0c176c8f14151e54959bd898df69c82b5289c0 (diff)
Improve docs.
Diffstat (limited to 'README')
1 files changed, 40 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..bb6da72
--- /dev/null
+++ b/README
@@ -0,0 +1,40 @@
+Command line utility for issuing and maintaining ACME SSL certificates.
+While most existing ACME tools take a list of domain names for which to
+issue certificates from their command line or configuration file, acmeman
+gathers domain names directly from the configuration of the http server
+that serves them. Thus, a domain name obtains its certificate automatically,
+once the administrator configures the http server to serve it via https.
+The utility is normally run as a cron job.
+To build run:
+ perl Makefile.PL
+as usual. The created Makefile will install the missing dependencies
+from CPAN automatically. If this is not desirable, run
+ perl Makefile.PL --no-autoinstall
+See "man acmeman" (or "perldoc acmeman", or "acmeman --help"), for a
+detailed manual.
+This package 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, or (at your option)
+any later version.
+See http://www.gnu.org/licenses.

Return to:

Send suggestions and report system problems to the System administrator.