2015-06-13 02:45:04 +00:00
# lego
2018-05-31 00:03:08 +00:00
2019-03-08 18:47:06 +00:00
Let's Encrypt client and ACME library written in Go.
2015-06-13 02:45:04 +00:00
2018-10-18 20:32:00 +00:00
[](https://godoc.org/github.com/xenolf/lego/acme)
2015-06-13 19:23:27 +00:00
[](https://travis-ci.org/xenolf/lego)
2018-10-18 20:32:00 +00:00
[](https://hub.docker.com/r/xenolf/lego/)
2015-12-23 22:23:21 +00:00
[](https://gitter.im/xenolf/lego)
2017-07-17 20:54:51 +00:00
[](https://beerpay.io/xenolf/lego)
2015-06-13 19:23:27 +00:00
2018-05-31 00:03:08 +00:00
## Features
2016-03-23 18:12:47 +00:00
- Register with CA
2016-02-12 01:08:36 +00:00
- Obtain certificates, both from scratch or with an existing CSR
2016-03-23 18:12:47 +00:00
- Renew certificates
- Revoke certificates
- Robust implementation of all ACME challenges
- HTTP (http-01)
- DNS (dns-01)
2018-06-13 23:20:56 +00:00
- TLS (tls-alpn-01)
2016-03-23 18:12:47 +00:00
- SAN certificate support
- Comes with multiple optional [DNS providers ](https://github.com/xenolf/lego/tree/master/providers/dns )
- [Custom challenge solvers ](https://github.com/xenolf/lego/wiki/Writing-a-Challenge-Solver )
- Certificate bundling
- OCSP helper function
2015-06-13 02:45:04 +00:00
2019-03-08 18:47:06 +00:00
lego introduced support for ACME v2 in [v1.0.0 ](https://github.com/xenolf/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/xenolf/lego/releases/tag/v0.5.0 ) version.
2015-12-08 02:33:40 +00:00
2019-03-08 18:47:06 +00:00
## Installation
2015-10-17 21:02:52 +00:00
2019-03-08 18:47:06 +00:00
How to [install ](https://xenolf.github.io/lego/installation/ ).
2018-05-31 00:03:08 +00:00
2019-03-08 18:47:06 +00:00
## Usage
2018-05-31 00:03:08 +00:00
2019-03-08 18:47:06 +00:00
- as a [CLI ](https://xenolf.github.io/lego/usage/cli )
- as a [library ](https://xenolf.github.io/lego/usage/lib )
## Documentation
Documentation is hosted live at https://xenolf.github.io/lego/.
## DNS providers
Detailed documentation is available [here ](https://xenolf.github.io/lego/dns ).
| | | | |
|----------------------------------------------------------------|--------------------------------------------------------------------------------|-------------------------------------------------------------------|------------------------------------------------------------------|
| [Alibaba Cloud DNS ](https://xenolf.github.io/lego/dns/alidns/ ) | [Amazon Lightsail ](https://xenolf.github.io/lego/dns/lightsail/ ) | [Amazon Route 53 ](https://xenolf.github.io/lego/dns/route53/ ) | [Aurora DNS ](https://xenolf.github.io/lego/dns/auroradns/ ) |
| [Azure ](https://xenolf.github.io/lego/dns/azure/ ) | [Bluecat ](https://xenolf.github.io/lego/dns/bluecat/ ) | [ClouDNS ](https://xenolf.github.io/lego/dns/cloudns/ ) | [CloudXNS ](https://xenolf.github.io/lego/dns/cloudxns/ ) |
| [Cloudflare ](https://xenolf.github.io/lego/dns/cloudflare/ ) | [ConoHa ](https://xenolf.github.io/lego/dns/conoha/ ) | [DNS Made Easy ](https://xenolf.github.io/lego/dns/dnsmadeeasy/ ) | [DNSPod ](https://xenolf.github.io/lego/dns/dnspod/ ) |
| [DNSimple ](https://xenolf.github.io/lego/dns/dnsimple/ ) | [Designate DNSaaS for Openstack ](https://xenolf.github.io/lego/dns/designate/ ) | [Digital Ocean ](https://xenolf.github.io/lego/dns/digitalocean/ ) | [DreamHost ](https://xenolf.github.io/lego/dns/dreamhost/ ) |
| [Duck DNS ](https://xenolf.github.io/lego/dns/duckdns/ ) | [Dyn ](https://xenolf.github.io/lego/dns/dyn/ ) | [Exoscale ](https://xenolf.github.io/lego/dns/exoscale/ ) | [External program ](https://xenolf.github.io/lego/dns/exec/ ) |
| [FastDNS ](https://xenolf.github.io/lego/dns/fastdns/ ) | [Gandi ](https://xenolf.github.io/lego/dns/gandi/ ) | [Gandi Live DNS (v5) ](https://xenolf.github.io/lego/dns/gandiv5/ ) | [Glesys ](https://xenolf.github.io/lego/dns/glesys/ ) |
| [Go Daddy ](https://xenolf.github.io/lego/dns/godaddy/ ) | [Google Cloud ](https://xenolf.github.io/lego/dns/gcloud/ ) | [HTTP request ](https://xenolf.github.io/lego/dns/httpreq/ ) | [Hosting.de ](https://xenolf.github.io/lego/dns/hostingde/ ) |
| [INWX ](https://xenolf.github.io/lego/dns/inwx/ ) | [Internet Initiative Japan ](https://xenolf.github.io/lego/dns/iij/ ) | [Joohoi's ACME-DNS ](https://xenolf.github.io/lego/dns/acme-dns ) | [Linode (deprecated) ](https://xenolf.github.io/lego/dns/linode/ ) |
| [Linode (v4) ](https://xenolf.github.io/lego/dns/linodev4/ ) | [Manual ](https://xenolf.github.io/lego/dns/manual/ ) | [MyDNS.jp ](https://xenolf.github.io/lego/dns/mydnsjp/ ) | [NIFCloud ](https://xenolf.github.io/lego/dns/nifcloud/ ) |
| [NS1 ](https://xenolf.github.io/lego/dns/ns1/ ) | [Name.com ](https://xenolf.github.io/lego/dns/namedotcom/ ) | [Namecheap ](https://xenolf.github.io/lego/dns/namecheap/ ) | [Netcup ](https://xenolf.github.io/lego/dns/netcup/ ) |
| [OVH ](https://xenolf.github.io/lego/dns/ovh/ ) | [Open Telekom Cloud ](https://xenolf.github.io/lego/dns/otc/ ) | [Oracle Cloud ](https://xenolf.github.io/lego/dns/oraclecloud/ ) | [PowerDNS ](https://xenolf.github.io/lego/dns/pdns/ ) |
| [RFC2136 ](https://xenolf.github.io/lego/dns/rfc2136/ ) | [Rackspace ](https://xenolf.github.io/lego/dns/rackspace/ ) | [Sakura Cloud ](https://xenolf.github.io/lego/dns/sakuracloud/ ) | [Selectel ](https://xenolf.github.io/lego/dns/selectel/ ) |
| [Stackpath ](https://xenolf.github.io/lego/dns/stackpath/ ) | [TransIP ](https://xenolf.github.io/lego/dns/transip/ ) | [VegaDNS ](https://xenolf.github.io/lego/dns/vegadns/ ) | [Vscale ](https://xenolf.github.io/lego/dns/vscale/ ) |
| [Vultr ](https://xenolf.github.io/lego/dns/vultr/ ) | [Zone.ee ](https://xenolf.github.io/lego/dns/zoneee/ ) | | |
