lego/README.md

# lego

Let's Encrypt client and ACME library written in Go.

[![GoDoc](https://godoc.org/github.com/go-acme/lego?status.svg)](https://godoc.org/github.com/go-acme/lego/acme)
[![Build Status](https://travis-ci.com/go-acme/lego.svg?branch=master)](https://travis-ci.com/go-acme/lego)
[![Docker Pulls](https://img.shields.io/docker/pulls/goacme/lego.svg)](https://hub.docker.com/r/goacme/lego/)

## Features

- Register with CA
- Obtain certificates, both from scratch or with an existing CSR
- Renew certificates
- Revoke certificates
- Robust implementation of all ACME challenges
  - HTTP (http-01)
  - DNS (dns-01)
  - TLS (tls-alpn-01)
- SAN certificate support
- Comes with multiple optional [DNS providers](https://go-acme.github.io/lego/dns)
- [Custom challenge solvers](https://go-acme.github.io/lego/usage/library/writing-a-challenge-solver/)
- Certificate bundling
- OCSP helper function

lego introduced support for ACME v2 in [v1.0.0](https://github.com/go-acme/lego/releases/tag/v1.0.0). If you still need to utilize ACME v1, you can do so by using the [v0.5.0](https://github.com/go-acme/lego/releases/tag/v0.5.0) version.

## Installation

How to [install](https://go-acme.github.io/lego/installation/).

## Usage

- as a [CLI](https://go-acme.github.io/lego/usage/cli)
- as a [library](https://go-acme.github.io/lego/usage/library)

## Documentation

Documentation is hosted live at https://go-acme.github.io/lego/.

## DNS providers

Detailed documentation is available [here](https://go-acme.github.io/lego/dns).

|                                                                                 |                                                                                 |                                                                                 |                                                                                 |
|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------|---------------------------------------------------------------------------------|
| [Alibaba Cloud DNS](https://go-acme.github.io/lego/dns/alidns/)                 | [Amazon Lightsail](https://go-acme.github.io/lego/dns/lightsail/)               | [Amazon Route 53](https://go-acme.github.io/lego/dns/route53/)                  | [Aurora DNS](https://go-acme.github.io/lego/dns/auroradns/)                     |
| [Autodns](https://go-acme.github.io/lego/dns/autodns/)                          | [Azure](https://go-acme.github.io/lego/dns/azure/)                              | [Bindman](https://go-acme.github.io/lego/dns/bindman/)                          | [Bluecat](https://go-acme.github.io/lego/dns/bluecat/)                          |
| [Checkdomain](https://go-acme.github.io/lego/dns/checkdomain/)                  | [Cloudflare](https://go-acme.github.io/lego/dns/cloudflare/)                    | [ClouDNS](https://go-acme.github.io/lego/dns/cloudns/)                          | [CloudXNS](https://go-acme.github.io/lego/dns/cloudxns/)                        |
| [ConoHa](https://go-acme.github.io/lego/dns/conoha/)                            | [Constellix](https://go-acme.github.io/lego/dns/constellix/)                    | [Designate DNSaaS for Openstack](https://go-acme.github.io/lego/dns/designate/) | [Digital Ocean](https://go-acme.github.io/lego/dns/digitalocean/)               |
| [DNS Made Easy](https://go-acme.github.io/lego/dns/dnsmadeeasy/)                | [DNSimple](https://go-acme.github.io/lego/dns/dnsimple/)                        | [DNSPod](https://go-acme.github.io/lego/dns/dnspod/)                            | [Domain Offensive (do.de)](https://go-acme.github.io/lego/dns/dode/)            |
| [DreamHost](https://go-acme.github.io/lego/dns/dreamhost/)                      | [Duck DNS](https://go-acme.github.io/lego/dns/duckdns/)                         | [Dyn](https://go-acme.github.io/lego/dns/dyn/)                                  | [EasyDNS](https://go-acme.github.io/lego/dns/easydns/)                          |
| [Exoscale](https://go-acme.github.io/lego/dns/exoscale/)                        | [External program](https://go-acme.github.io/lego/dns/exec/)                    | [FastDNS](https://go-acme.github.io/lego/dns/fastdns/)                          | [Gandi Live DNS (v5)](https://go-acme.github.io/lego/dns/gandiv5/)              |
| [Gandi](https://go-acme.github.io/lego/dns/gandi/)                              | [Glesys](https://go-acme.github.io/lego/dns/glesys/)                            | [Go Daddy](https://go-acme.github.io/lego/dns/godaddy/)                         | [Google Cloud](https://go-acme.github.io/lego/dns/gcloud/)                      |
| [Hosting.de](https://go-acme.github.io/lego/dns/hostingde/)                     | [HTTP request](https://go-acme.github.io/lego/dns/httpreq/)                     | [Internet Initiative Japan](https://go-acme.github.io/lego/dns/iij/)            | [INWX](https://go-acme.github.io/lego/dns/inwx/)                                |
| [Joker](https://go-acme.github.io/lego/dns/joker/)                              | [Joohoi's ACME-DNS](https://go-acme.github.io/lego/dns/acme-dns)                | [Linode (deprecated)](https://go-acme.github.io/lego/dns/linode/)               | [Linode (v4)](https://go-acme.github.io/lego/dns/linodev4/)                     |
| [Liquid Web](https://go-acme.github.io/lego/dns/liquidweb/)                     | [Manual](https://go-acme.github.io/lego/dns/manual/)                            | [MyDNS.jp](https://go-acme.github.io/lego/dns/mydnsjp/)                         | [Name.com](https://go-acme.github.io/lego/dns/namedotcom/)                      |
| [Namecheap](https://go-acme.github.io/lego/dns/namecheap/)                      | [Namesilo](https://go-acme.github.io/lego/dns/namesilo/)                        | [Netcup](https://go-acme.github.io/lego/dns/netcup/)                            | [NIFCloud](https://go-acme.github.io/lego/dns/nifcloud/)                        |
| [NS1](https://go-acme.github.io/lego/dns/ns1/)                                  | [Open Telekom Cloud](https://go-acme.github.io/lego/dns/otc/)                   | [Oracle Cloud](https://go-acme.github.io/lego/dns/oraclecloud/)                 | [OVH](https://go-acme.github.io/lego/dns/ovh/)                                  |
| [PowerDNS](https://go-acme.github.io/lego/dns/pdns/)                            | [Rackspace](https://go-acme.github.io/lego/dns/rackspace/)                      | [RFC2136](https://go-acme.github.io/lego/dns/rfc2136/)                          | [Sakura Cloud](https://go-acme.github.io/lego/dns/sakuracloud/)                 |
| [Scaleway](https://go-acme.github.io/lego/dns/scaleway/)                        | [Selectel](https://go-acme.github.io/lego/dns/selectel/)                        | [Servercow](https://go-acme.github.io/lego/dns/servercow/)                      | [Stackpath](https://go-acme.github.io/lego/dns/stackpath/)                      |
| [TransIP](https://go-acme.github.io/lego/dns/transip/)                          | [VegaDNS](https://go-acme.github.io/lego/dns/vegadns/)                          | [Vscale](https://go-acme.github.io/lego/dns/vscale/)                            | [Versio](https://go-acme.github.io/lego/dns/versio/)                            |
| [Vultr](https://go-acme.github.io/lego/dns/vultr/)                              | [Zone.ee](https://go-acme.github.io/lego/dns/zoneee/)                           |                                                                                 |                                                                                 |
Create README.md 2015-06-13 04:45:04 +02:00			`# lego`
Prepare release v1.0.0 (#559) * Prepare release v1.0.0 * review: remove infrastructure items from CHANGELOG.md * review: updated CHANGELOG.md message * review: added ACME v1 reference in README.md * review: README.md updates * review: removed experimental note 2018-05-31 02:03:08 +02:00
Automatic generation of documentation (#818) * generate a detailed CLI help * generate a documentation site * new readme 2019-03-08 20:47:06 +02:00			`Let's Encrypt client and ACME library written in Go.`
Create README.md 2015-06-13 04:45:04 +02:00
Use canonical imports (#822) * fix: challenge are not required for revoke. 2019-03-11 17:54:35 +02:00			`[![GoDoc](https://godoc.org/github.com/go-acme/lego?status.svg)](https://godoc.org/github.com/go-acme/lego/acme)`
doc: fix badges. 2019-03-11 21:00:39 +02:00			`[![Build Status](https://travis-ci.com/go-acme/lego.svg?branch=master)](https://travis-ci.com/go-acme/lego)`
doc: fix badges. 2019-03-11 20:26:14 +02:00			`[![Docker Pulls](https://img.shields.io/docker/pulls/goacme/lego.svg)](https://hub.docker.com/r/goacme/lego/)`
Update README.md Add travis build status 2015-06-13 21:23:27 +02:00
Prepare release v1.0.0 (#559) * Prepare release v1.0.0 * review: remove infrastructure items from CHANGELOG.md * review: updated CHANGELOG.md message * review: added ACME v1 reference in README.md * review: README.md updates * review: removed experimental note 2018-05-31 02:03:08 +02:00			`## Features`
Update README and version 2016-03-23 20:12:47 +02:00
			`- Register with CA`
Document --csr flag 2016-02-12 03:08:36 +02:00			`- Obtain certificates, both from scratch or with an existing CSR`
Update README and version 2016-03-23 20:12:47 +02:00			`- Renew certificates`
			`- Revoke certificates`
			`- Robust implementation of all ACME challenges`
			`- HTTP (http-01)`
			`- DNS (dns-01)`
TLS-ALPN-01 Challenge (#572) * feat: implemented TLS-ALPN-01 challenge 2018-06-14 01:20:56 +02:00			`- TLS (tls-alpn-01)`
Update README and version 2016-03-23 20:12:47 +02:00			`- SAN certificate support`
doc: fix badges. 2019-03-11 21:00:39 +02:00			`- Comes with multiple optional [DNS providers](https://go-acme.github.io/lego/dns)`
Use canonical imports (#822) * fix: challenge are not required for revoke. 2019-03-11 17:54:35 +02:00			`- [Custom challenge solvers](https://go-acme.github.io/lego/usage/library/writing-a-challenge-solver/)`
Update README and version 2016-03-23 20:12:47 +02:00			`- Certificate bundling`
			`- OCSP helper function`
Create README.md 2015-06-13 04:45:04 +02:00
Use canonical imports (#822) * fix: challenge are not required for revoke. 2019-03-11 17:54:35 +02:00			`lego introduced support for ACME v2 in [v1.0.0](https://github.com/go-acme/lego/releases/tag/v1.0.0). If you still need to utilize ACME v1, you can do so by using the [v0.5.0](https://github.com/go-acme/lego/releases/tag/v0.5.0) version.`
Stub out simple CLI example 2015-12-08 04:33:40 +02:00
Automatic generation of documentation (#818) * generate a detailed CLI help * generate a documentation site * new readme 2019-03-08 20:47:06 +02:00			`## Installation`
Add bare-bones acme usage example 2015-10-17 23:02:52 +02:00
Use canonical imports (#822) * fix: challenge are not required for revoke. 2019-03-11 17:54:35 +02:00			`How to [install](https://go-acme.github.io/lego/installation/).`
Prepare release v1.0.0 (#559) * Prepare release v1.0.0 * review: remove infrastructure items from CHANGELOG.md * review: updated CHANGELOG.md message * review: added ACME v1 reference in README.md * review: README.md updates * review: removed experimental note 2018-05-31 02:03:08 +02:00
Automatic generation of documentation (#818) * generate a detailed CLI help * generate a documentation site * new readme 2019-03-08 20:47:06 +02:00			`## Usage`
Prepare release v1.0.0 (#559) * Prepare release v1.0.0 * review: remove infrastructure items from CHANGELOG.md * review: updated CHANGELOG.md message * review: added ACME v1 reference in README.md * review: README.md updates * review: removed experimental note 2018-05-31 02:03:08 +02:00
Use canonical imports (#822) * fix: challenge are not required for revoke. 2019-03-11 17:54:35 +02:00			`- as a [CLI](https://go-acme.github.io/lego/usage/cli)`
fix broken link to library usage docs. (#832) 2019-03-19 17:50:05 +02:00			`- as a [library](https://go-acme.github.io/lego/usage/library)`
Automatic generation of documentation (#818) * generate a detailed CLI help * generate a documentation site * new readme 2019-03-08 20:47:06 +02:00
			`## Documentation`

Use canonical imports (#822) * fix: challenge are not required for revoke. 2019-03-11 17:54:35 +02:00			`Documentation is hosted live at https://go-acme.github.io/lego/.`
Automatic generation of documentation (#818) * generate a detailed CLI help * generate a documentation site * new readme 2019-03-08 20:47:06 +02:00
			`## DNS providers`

Use canonical imports (#822) * fix: challenge are not required for revoke. 2019-03-11 17:54:35 +02:00			`Detailed documentation is available [here](https://go-acme.github.io/lego/dns).`
Automatic generation of documentation (#818) * generate a detailed CLI help * generate a documentation site * new readme 2019-03-08 20:47:06 +02:00
Add DNS Provider for Domain Offensive (do.de) (#835) 2019-03-21 12:52:01 +02:00			`\| \| \| \| \|`
			`\|---------------------------------------------------------------------------------\|---------------------------------------------------------------------------------\|---------------------------------------------------------------------------------\|---------------------------------------------------------------------------------\|`
			`\| [Alibaba Cloud DNS](https://go-acme.github.io/lego/dns/alidns/) \| [Amazon Lightsail](https://go-acme.github.io/lego/dns/lightsail/) \| [Amazon Route 53](https://go-acme.github.io/lego/dns/route53/) \| [Aurora DNS](https://go-acme.github.io/lego/dns/auroradns/) \|`
Add support for autodns (#957) 2019-11-01 12:20:34 +02:00			`\| [Autodns](https://go-acme.github.io/lego/dns/autodns/) \| [Azure](https://go-acme.github.io/lego/dns/azure/) \| [Bindman](https://go-acme.github.io/lego/dns/bindman/) \| [Bluecat](https://go-acme.github.io/lego/dns/bluecat/) \|`
Add DNS provider for Checkdomain (#1017) 2019-12-08 00:59:59 +02:00			`\| [Checkdomain](https://go-acme.github.io/lego/dns/checkdomain/) \| [Cloudflare](https://go-acme.github.io/lego/dns/cloudflare/) \| [ClouDNS](https://go-acme.github.io/lego/dns/cloudns/) \| [CloudXNS](https://go-acme.github.io/lego/dns/cloudxns/) \|`
Add DNS provider for Constellix (#1051) 2020-02-25 22:56:40 +02:00			`\| [ConoHa](https://go-acme.github.io/lego/dns/conoha/) \| [Constellix](https://go-acme.github.io/lego/dns/constellix/) \| [Designate DNSaaS for Openstack](https://go-acme.github.io/lego/dns/designate/) \| [Digital Ocean](https://go-acme.github.io/lego/dns/digitalocean/) \|`
			`\| [DNS Made Easy](https://go-acme.github.io/lego/dns/dnsmadeeasy/) \| [DNSimple](https://go-acme.github.io/lego/dns/dnsimple/) \| [DNSPod](https://go-acme.github.io/lego/dns/dnspod/) \| [Domain Offensive (do.de)](https://go-acme.github.io/lego/dns/dode/) \|`
			`\| [DreamHost](https://go-acme.github.io/lego/dns/dreamhost/) \| [Duck DNS](https://go-acme.github.io/lego/dns/duckdns/) \| [Dyn](https://go-acme.github.io/lego/dns/dyn/) \| [EasyDNS](https://go-acme.github.io/lego/dns/easydns/) \|`
			`\| [Exoscale](https://go-acme.github.io/lego/dns/exoscale/) \| [External program](https://go-acme.github.io/lego/dns/exec/) \| [FastDNS](https://go-acme.github.io/lego/dns/fastdns/) \| [Gandi Live DNS (v5)](https://go-acme.github.io/lego/dns/gandiv5/) \|`
			`\| [Gandi](https://go-acme.github.io/lego/dns/gandi/) \| [Glesys](https://go-acme.github.io/lego/dns/glesys/) \| [Go Daddy](https://go-acme.github.io/lego/dns/godaddy/) \| [Google Cloud](https://go-acme.github.io/lego/dns/gcloud/) \|`
			`\| [Hosting.de](https://go-acme.github.io/lego/dns/hostingde/) \| [HTTP request](https://go-acme.github.io/lego/dns/httpreq/) \| [Internet Initiative Japan](https://go-acme.github.io/lego/dns/iij/) \| [INWX](https://go-acme.github.io/lego/dns/inwx/) \|`
			`\| [Joker](https://go-acme.github.io/lego/dns/joker/) \| [Joohoi's ACME-DNS](https://go-acme.github.io/lego/dns/acme-dns) \| [Linode (deprecated)](https://go-acme.github.io/lego/dns/linode/) \| [Linode (v4)](https://go-acme.github.io/lego/dns/linodev4/) \|`
			`\| [Liquid Web](https://go-acme.github.io/lego/dns/liquidweb/) \| [Manual](https://go-acme.github.io/lego/dns/manual/) \| [MyDNS.jp](https://go-acme.github.io/lego/dns/mydnsjp/) \| [Name.com](https://go-acme.github.io/lego/dns/namedotcom/) \|`
			`\| [Namecheap](https://go-acme.github.io/lego/dns/namecheap/) \| [Namesilo](https://go-acme.github.io/lego/dns/namesilo/) \| [Netcup](https://go-acme.github.io/lego/dns/netcup/) \| [NIFCloud](https://go-acme.github.io/lego/dns/nifcloud/) \|`
			`\| [NS1](https://go-acme.github.io/lego/dns/ns1/) \| [Open Telekom Cloud](https://go-acme.github.io/lego/dns/otc/) \| [Oracle Cloud](https://go-acme.github.io/lego/dns/oraclecloud/) \| [OVH](https://go-acme.github.io/lego/dns/ovh/) \|`
			`\| [PowerDNS](https://go-acme.github.io/lego/dns/pdns/) \| [Rackspace](https://go-acme.github.io/lego/dns/rackspace/) \| [RFC2136](https://go-acme.github.io/lego/dns/rfc2136/) \| [Sakura Cloud](https://go-acme.github.io/lego/dns/sakuracloud/) \|`
			`\| [Scaleway](https://go-acme.github.io/lego/dns/scaleway/) \| [Selectel](https://go-acme.github.io/lego/dns/selectel/) \| [Servercow](https://go-acme.github.io/lego/dns/servercow/) \| [Stackpath](https://go-acme.github.io/lego/dns/stackpath/) \|`
			`\| [TransIP](https://go-acme.github.io/lego/dns/transip/) \| [VegaDNS](https://go-acme.github.io/lego/dns/vegadns/) \| [Vscale](https://go-acme.github.io/lego/dns/vscale/) \| [Versio](https://go-acme.github.io/lego/dns/versio/) \|`
			`\| [Vultr](https://go-acme.github.io/lego/dns/vultr/) \| [Zone.ee](https://go-acme.github.io/lego/dns/zoneee/) \| \| \|`