mirror of
https://github.com/aljazceru/addons.git
synced 2025-12-18 21:54:20 +01:00
✏️ Re-branding and updating for latest supervisor (#1047)
This commit is contained in:
Franck Nijhof
@@ -15,7 +15,7 @@ The generated certificate can be used within others addons. By default the path
|
||||
|
||||
Follow these steps to get the add-on installed on your system:
|
||||
|
||||
1. Navigate in your Home Assistant frontend to **Hass.io** -> **Add-on Store**.
|
||||
1. Navigate in your Home Assistant frontend to **Supervisor** -> **Add-on Store**.
|
||||
2. Find the "letsencrypt" add-on and click it.
|
||||
3. Click on the "INSTALL" button.
|
||||
|
||||
@@ -23,126 +23,119 @@ Follow these steps to get the add-on installed on your system:
|
||||
|
||||
To use this add-on, you have two options on how to get your certificate:
|
||||
|
||||
### 1. http challenge:
|
||||
- Requires Port 80 to be available from the internet and your domain assigned to the externally assigned IP address
|
||||
- Doesnt allow wildcard certificates (*.yourdomain.com).
|
||||
### 1. http challenge
|
||||
|
||||
- Requires Port 80 to be available from the internet and your domain assigned to the externally assigned IP address
|
||||
- Doesnt allow wildcard certificates (*.yourdomain.com).
|
||||
|
||||
### 2. dns challenge
|
||||
- Requires you to use one of the supported DNS providers (See "Supported DNS providers" below)
|
||||
- Allows to request wildcard certificates (*.yourdomain.com)
|
||||
- Doesn’t need you to open a port to your Home Assistant host on your router.
|
||||
|
||||
### You always need to provide the following entries within the configuration:
|
||||
- Requires you to use one of the supported DNS providers (See "Supported DNS providers" below)
|
||||
- Allows to request wildcard certificates (*.yourdomain.com)
|
||||
- Doesn’t need you to open a port to your Home Assistant host on your router.
|
||||
|
||||
```json
|
||||
"email": "your@email.com"
|
||||
"domains": ["yourdomain.com"] // use "*.yourdomain.com" for wildcard certificates.
|
||||
"challenge": "http OR dns"
|
||||
### You always need to provide the following entries within the configuration
|
||||
|
||||
```yaml
|
||||
email: your@email.com
|
||||
domains:
|
||||
# use "*.yourdomain.com" for wildcard certificates.
|
||||
- yourdomain.com
|
||||
challenge: http OR dns
|
||||
```
|
||||
|
||||
IF you choose "dns" as "challenge", you will also need to fill:
|
||||
|
||||
```json
|
||||
"dnsprovider": "" (Add the dnsprovider of your choice from the list of "Supported DNS providers" below)
|
||||
```yaml
|
||||
# Add the dnsprovider of your choice from the list of "Supported DNS providers" below
|
||||
dnsprovider: ""
|
||||
```
|
||||
|
||||
In addition add the fields according to the credentials required by your dns provider:
|
||||
|
||||
```json
|
||||
"cloudflare_email": "",
|
||||
"cloudflare_api_key": "",
|
||||
"cloudxns_api_key": "",
|
||||
"cloudxns_secret_key": "",
|
||||
"digitalocean_token": "",
|
||||
"dnsimple_token": "",
|
||||
"dnsmadeeasy_api_key": "",
|
||||
"dnsmadeeasy_secret_key": "",
|
||||
"google_creds": "", (Credentials file)
|
||||
"gehirn_api_token": "",
|
||||
"gehirn_api_secret": "",
|
||||
"linode_key": "",
|
||||
"linode_version": "",
|
||||
"luadns_email": "",
|
||||
"luadns_token": "",
|
||||
"nsone_api_key": "",
|
||||
"ovh_endpoint": "",
|
||||
"ovh_application_key": "",
|
||||
"ovh_application_secret": "",
|
||||
"ovh_consumer_key": "",
|
||||
"rfc2136_server": "",
|
||||
"rfc2136_port": "",
|
||||
"rfc2136_name": "",
|
||||
"rfc2136_secret": "",
|
||||
"rfc2136_algorithm": "",
|
||||
"aws_access_key_id": "",
|
||||
"aws_secret_access_key": "",
|
||||
"sakuracloud_api_token": "",
|
||||
"sakuracloud_api_secret": ""
|
||||
```yaml
|
||||
cloudflare_email: ''
|
||||
cloudflare_api_key: ''
|
||||
cloudxns_api_key: ''
|
||||
cloudxns_secret_key: ''
|
||||
digitalocean_token: ''
|
||||
dnsimple_token: ''
|
||||
dnsmadeeasy_api_key: ''
|
||||
dnsmadeeasy_secret_key: ''
|
||||
google_creds: ''
|
||||
gehirn_api_token: ''
|
||||
gehirn_api_secret: ''
|
||||
linode_key: ''
|
||||
linode_version: ''
|
||||
luadns_email: ''
|
||||
luadns_token: ''
|
||||
nsone_api_key: ''
|
||||
ovh_endpoint: ''
|
||||
ovh_application_key: ''
|
||||
ovh_application_secret: ''
|
||||
ovh_consumer_key: ''
|
||||
rfc2136_server: ''
|
||||
rfc2136_port: ''
|
||||
rfc2136_name: ''
|
||||
rfc2136_secret: ''
|
||||
rfc2136_algorithm: ''
|
||||
aws_access_key_id: ''
|
||||
aws_secret_access_key: ''
|
||||
sakuracloud_api_token: ''
|
||||
sakuracloud_api_secret: ''
|
||||
```
|
||||
|
||||
## Example Configurations
|
||||
|
||||
### http challenge
|
||||
|
||||
### http challenge:
|
||||
```json
|
||||
{
|
||||
"email": "hello@home-assistant.io",
|
||||
"domains": [
|
||||
"home-assistant.io"
|
||||
],
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem",
|
||||
"challenge": "http",
|
||||
"dns": {
|
||||
}
|
||||
}
|
||||
```yaml
|
||||
email: hello@home-assistant.io
|
||||
domains:
|
||||
- home-assistant.io
|
||||
certfile: fullchain.pem
|
||||
keyfile: privkey.pem
|
||||
challenge: http
|
||||
dns: {}
|
||||
```
|
||||
|
||||
### dns challenge
|
||||
|
||||
### dns challenge:
|
||||
```json
|
||||
{
|
||||
"email": "hello@home-assistant.io",
|
||||
"domains": [
|
||||
"home-assistant.io"
|
||||
],
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem",
|
||||
"challenge": "dns",
|
||||
"dns": {
|
||||
"provider": "dns-cloudflare",
|
||||
"cloudflare_email": "cf@home-assistant.io",
|
||||
"cloudflare_api_key": "31242lk3j4ljlfdwsjf0"
|
||||
}
|
||||
}
|
||||
```yaml
|
||||
email: hello@home-assistant.io
|
||||
domains:
|
||||
- home-assistant.io
|
||||
certfile: fullchain.pem
|
||||
keyfile: privkey.pem
|
||||
challenge: dns
|
||||
dns:
|
||||
provider: dns-cloudflare
|
||||
cloudflare_email: cf@home-assistant.io
|
||||
cloudflare_api_key: 31242lk3j4ljlfdwsjf0
|
||||
```
|
||||
|
||||
### google dns challenge
|
||||
|
||||
### google dns challenge:
|
||||
```json
|
||||
{
|
||||
"email": "hello@home-assistant.io",
|
||||
"domains": [
|
||||
"home-assistant.io"
|
||||
],
|
||||
"certfile": "fullchain.pem",
|
||||
"keyfile": "privkey.pem",
|
||||
"challenge": "dns",
|
||||
"dns": {
|
||||
"provider": "dns-google",
|
||||
"google_creds": "google.json"
|
||||
}
|
||||
}
|
||||
```yaml
|
||||
email: hello@home-assistant.io
|
||||
domains:
|
||||
- home-assistant.io
|
||||
certfile: fullchain.pem
|
||||
keyfile: privkey.pem
|
||||
challenge: dns
|
||||
dns:
|
||||
provider: dns-google
|
||||
google_creds: google.json
|
||||
```
|
||||
Please copy your credentials file "google.json" into the "share" shared folder on the Home Assistant host before starting the service.
|
||||
|
||||
Please copy your credentials file "google.json" into the "share" shared folder on the Home Assistant host before starting the service.
|
||||
|
||||
One way is to use the "Samba" add on to make the folder available via network or SSH Add-on.
|
||||
|
||||
|
||||
The credential file can be created and downloaded when creating the service user within the Google cloud.
|
||||
You can find additional information in regards to the required permissions in the "credentials" section here:
|
||||
|
||||
https://github.com/certbot/certbot/blob/master/certbot-dns-google/certbot_dns_google/__init__.py
|
||||
<https://github.com/certbot/certbot/blob/master/certbot-dns-google/certbot_dns_google/__init__.py>
|
||||
|
||||
## Certificate files
|
||||
|
||||
@@ -151,10 +144,9 @@ The certificate files will be available within the "ssl" share after sucessful r
|
||||
By default other addons are refering to the correct path of the certificates.
|
||||
You can in addition find the files via the "samba" addon within the "ssl" share.
|
||||
|
||||
|
||||
## Supported DNS providers
|
||||
|
||||
```json
|
||||
```txt
|
||||
dns-cloudflare
|
||||
dns-cloudxns
|
||||
dns-digitalocean
|
||||
@@ -171,9 +163,6 @@ dns-route53
|
||||
dns-sakuracloud
|
||||
```
|
||||
|
||||
## Known issues and limitations
|
||||
|
||||
|
||||
## Support
|
||||
|
||||
Got questions?
|
||||
|
||||
Reference in New Issue
Block a user