Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janeczku/rancher-letsencrypt
:cow: Rancher service that obtains and manages free SSL certificates from the Let's Encrypt CA
https://github.com/janeczku/rancher-letsencrypt
certificate dns letsencrypt rancher ssl-certificates
Last synced: about 2 months ago
JSON representation
:cow: Rancher service that obtains and manages free SSL certificates from the Let's Encrypt CA
- Host: GitHub
- URL: https://github.com/janeczku/rancher-letsencrypt
- Owner: janeczku
- License: apache-2.0
- Created: 2016-02-02T01:09:59.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2019-06-14T22:06:26.000Z (over 5 years ago)
- Last Synced: 2024-06-22T09:40:20.347Z (3 months ago)
- Topics: certificate, dns, letsencrypt, rancher, ssl-certificates
- Language: Go
- Homepage:
- Size: 2.69 MB
- Stars: 326
- Watchers: 15
- Forks: 114
- Open Issues: 51
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-rancher - Rancher Let's Encrypt - Rancher service that obtains and manages free SSL certificates from the Let's Encrypt CA using DNS & webroot verification (Rancher 1.0 / Community projects 1.0)
README
# Let's Encrypt Certificate Manager for Rancher
[][release]
[][circleci]
[][hub]
[]()
[release]: https://github.com/janeczku/rancher-letsencrypt/releases
[circleci]: https://circleci.com/gh/janeczku/rancher-letsencrypt
[hub]: https://hub.docker.com/r/janeczku/rancher-letsencrypt/
A [Rancher](http://rancher.com/rancher/) service that obtains free SSL/TLS certificates from the [Let's Encrypt CA](https://letsencrypt.org/), adds them to Rancher's certificate store and manages renewal and propagation of updated certificates to load balancers.
#### Requirements
* Rancher Server >= v1.5.0
* If using a DNS-based challenge, existing account with one of the supported DNS providers:
* `Aurora DNS`
* `AWS Route 53`
* `Azure DNS`
* `CloudFlare`
* `DigitalOcean`
* `DNSimple`
* `Dyn`
* `Gandi`
* `NS1`
* `Ovh`
* `Vultr`
* If using the HTTP challenge, a reverse proxy that routes `example.com/.well-known/acme-challenge` to `rancher-letsencrypt`.
### How to use
This application is distributed via the [Rancher Community Catalog](https://github.com/rancher/community-catalog).
Enable the Community Catalog under `Admin` => `Settings` in the Rancher UI.
Then locate the `Let's Encrypt` template in the Catalog section of the UI and follow the instructions.
### Storing certificate in shared storage volume
By default the created SSL certificate is stored in Rancher's certificate store for usage in Rancher load balancers.
You can specify a volume name to store account data, certificate and private key in a (host scoped) named Docker volume.
To share the certificates with other services you may specify a persistent storage driver (e.g. rancher-nfs).
See the README in the Rancher catalog for more information.
### Provider specific usage
#### AWS Route 53
Note: If you have both a private and public zone in Route53 for the domain, you need to run the service configured with public DNS resolvers (this is now the default).
The following IAM policy describes the minimum permissions required when using AWS Route 53 for domain authorization.
Replace `` with the ID of the hosted zone that encloses the domain(s) for which you are going to obtain certificates. You may use a wildcard (*) in place of the ID to make this policy work with all of the hosted zones associated with an AWS account.
```json
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Action": [
"route53:GetChange",
"route53:ListHostedZonesByName"
],
"Resource": [
"*"
]
},
{
"Effect": "Allow",
"Action": [
"route53:ChangeResourceRecordSets"
],
"Resource": [
"arn:aws:route53:::hostedzone/"
]
}
]
}
```
#### OVH
First create your credentials on https://eu.api.ovh.com/createToken/ by filling out the form like this:
- `Account ID`: Your OVH account ID
- `Password`: Your password
- `Script name`: letsencrypt
- `Script description`: Letsencrypt for Rancher
- `Validity`: Unlimited
- `Rights`:
- GET /domain/zone/*
- POST /domain/zone/*
- DELETE /domain/zone/*
Then deploy this service using the generated key, application secret and consumer key.
#### HTTP
If you prefer not to use a DNS-based challenge or your provider is not supported, you can use the HTTP challenge.
Simply choose `HTTP` from the list of providers.
Then make sure that HTTP requests to `domain.com/.well-known/acme-challenge` are forwarded to port 80 of the `rancher-letsencrypt` service, e.g. by configuring a Rancher load balancer accordingly. If you are using another reverse proxy (e.g. Nginx) you need to make sure it passed the original `host` header through to the backend.
### Building the image
`make build && make image`
### Contributions
PR's welcome!