letsencrypt: Collection of small improvements (#908)

* letsencrypt: Prettier YAML files

* letsencrypt: Sort build.json

* letsencrypt: Update add-on URL

* letsencrypt: Styling improvements to Dockerfile

* letsencrypt: Tweak and linter fixes to documentation
This commit is contained in:
Franck Nijhof
2019-12-18 23:48:14 +01:00
committed by Pascal Vizeli
parent 4e0a25af1e
commit b30fe9c749
5 changed files with 28 additions and 21 deletions

View File

@@ -5,9 +5,14 @@ FROM $BUILD_FROM
ARG CERTBOT_VERSION
RUN apk add --no-cache --update \
openssl libffi musl \
libffi \
musl \
openssl \
&& apk add --no-cache --virtual .build-dependencies \
g++ musl-dev openssl-dev libffi-dev \
g++ \
libffi-dev \
musl-dev \
openssl-dev \
&& pip3 install --no-cache-dir certbot==${CERTBOT_VERSION} \
certbot-dns-cloudflare==${CERTBOT_VERSION} \
certbot-dns-cloudxns==${CERTBOT_VERSION} \

View File

@@ -13,7 +13,7 @@ The generated certificate can be used within others addons.
## Installation
The installation of this add-on is straightforward and easy to do.
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**.
2. Find the "letsencrypt" add-on and click it.
@@ -23,26 +23,28 @@ The installation of this add-on is straightforward and easy to do.
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)
- Doesnt need you to open a port to your hass.io host on your router.
- Requires you to use one of the supported DNS providers (See "Supported DNS providers" below)
- Allows to request wildcard certificates (*.yourdomain.com)
- Doesnt need you to open a port to your hass.io host on your router.
You always need to provide the following entries within the configuration:
```json
"email": "your@email.com"
"domains": "yourdomain.com" /// in case of requesting a wildcard certificate, add "*.yourdomain.com".
"domains": "yourdomain.com" // use "*.yourdomain.com" for wildcard certificates.
"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)
```
In addition add the fields according to the credentials required by your dns provider:
@@ -95,6 +97,7 @@ Add-on configuration:
}
}
```
## Supported DNS providers
```json

View File

@@ -3,20 +3,19 @@
trigger:
branches:
include:
- master
- master
paths:
include:
- letsencrypt/*
- letsencrypt/*
pr: none
variables:
- name: versionBuilder
value: '2.0'
value: "2.0"
- group: docker
jobs:
- template: /.azure/azp-template-addon.yml
parameters:
addon: 'letsencrypt'
arch: '--all'
- template: /.azure/azp-template-addon.yml
parameters:
addon: "letsencrypt"
arch: "--all"

View File

@@ -1,10 +1,10 @@
{
"build_from": {
"aarch64": "homeassistant/aarch64-base-python:3.7-alpine3.10",
"amd64": "homeassistant/amd64-base-python:3.7-alpine3.10",
"i386": "homeassistant/i386-base-python:3.7-alpine3.10",
"armhf": "homeassistant/armhf-base-python:3.7-alpine3.10",
"armv7": "homeassistant/armv7-base-python:3.7-alpine3.10",
"aarch64": "homeassistant/aarch64-base-python:3.7-alpine3.10"
"i386": "homeassistant/i386-base-python:3.7-alpine3.10"
},
"args": {
"CERTBOT_VERSION": "1.0.0"

View File

@@ -3,7 +3,7 @@
"version": "4.2",
"slug": "letsencrypt",
"description": "Manage certificate from Let's Encrypt",
"url": "https://home-assistant.io/addons/lets_encrypt/",
"url": "https://github.com/home-assistant/hassio-addons/tree/master/letsencrypt",
"arch": ["armhf", "armv7", "aarch64", "amd64", "i386"],
"startup": "once",
"boot": "manual",