Raphaël G. Git Repositories - acme/blob - README

   1
   2                                   Acme 2.0.0
   3
   4                     Raphaël Gertz (Rapsys) <acme@rapsys.eu>
   5
   6              This program generate letsencrypt free certificates.
   7
   8
   9
  10  01. What's acme?
  11  ----------------
  12
  13  Acme is a fast and simple certificate generator using ACME v2 API.
  14
  15  Consult:
  16
  17  * man 1 acme: general documentation.
  18
  19  * man 1 acme-conf: about config generation.
  20
  21  * man 1 acme-cert: about certificate generation.
  22
  23  * man 1 acme-cron: about cron job setup.
  24
  25
  26
  27  02. Acme conf
  28  -------------
  29
  30  * acme conf [-(v|-verbose)] [-(c|-config)[=/etc/acme/config]]
  31    example.com[=www.example.com[,cdn.example.com]] [...] [-(d|-debian)]
  32
  33
  34
  35  03. Acme cert
  36  -------------
  37
  38  * acme cert [-(v|-verbose)] [-(c|-config)[=/etc/acme/config]] [example.com]
  39    [...]
  40
  41
  42
  43  04. Acme cron
  44  -------------
  45
  46  * acme cron [-(v|-verbose)] [-(c|-config)[=/etc/acme/config]] [example.com]
  47    [...]
  48
  49
  50
  51  05. Acme options
  52  ----------------
  53
  54  * --verbose: Produces a verbose report about the current process for the
  55               purpose of problem analysis.
  56
  57  * --config:  Use the specified configuration file. If the pathname is omitted,
  58               the file specified in Acme::CONFIG constant is assumed.
  59               Default value is /etc/acme/config
  60
  61  * --debian:  Use debian specific path schema in configuration file. If omitted,
  62               the default redhat path schema is assumed.
  63
  64
  65
  66  06. Contribute
  67  --------------
  68
  69  You may buy me a Beer, a Tea or help with Server fees with a paypal donation to
  70  the address <paypal@rapsys.eu> or via the donation page.
  71
  72  Don't forget to show your love for this project, feel free to report bugs to
  73  the author, issues which are security relevant should be disclosed privately
  74  first.
  75
  76  Patches are welcomed and grant credit when requested.
  77
  78
  79
  80  07. Documentation
  81  -----------------
  82
  83  A formated and hyperlinked copy of the lastest ACME v2 API documentation can be
  84  viewed at: https://ietf-wg-acme.github.io/acme/draft-ietf-acme-acme.html
  85
  86  This Acme implementation can be used for Let's Encrypt free, automated and open
  87  certificate authority, their documentation can be viewed at:
  88  https://letsencrypt.org/docs/
  89
  90
  91
  92  08. Author
  93  ----------
  94
  95  Raphaël Gertz (Rapsys) <acme@rapsys.eu>
  96
  97
  98
  99  09. Bugs
 100  --------
 101
 102  No known bugs.