aljaz/addons
1
0
Fork 0
mirror of https://github.com/aljazceru/addons.git synced 2025-12-17 13:14:21 +01:00
Code Issues Packages Projects Releases Wiki Activity

✏️ Re-branding and updating for latest supervisor (#1047)

Browse Source
This commit is contained in:
Franck Nijhof
2020-02-05 15:25:50 +01:00
committed by GitHub
parent 2f80548b72
commit 684e197b0e
20 changed files with 282 additions and 366 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
ada/README.md
View File

@@ -10,7 +10,7 @@ Voice assistant powered by Home Assistant.
Follow these steps to get the add-on installed on your system: 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 "Hey Ada!" add-on and click it. 2. Find the "Hey Ada!" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -26,11 +26,9 @@ The basic thing to get the add-on running would be:
Example add-on configuration: Example add-on configuration:
```json ```yaml
{ stt: cloud
"stt": "cloud", tts: cloud
"tts": "cloud"
}
``` ```
### Option: `stt` (required) ### Option: `stt` (required)

2
almond/README.md
View File

@@ -10,7 +10,7 @@ Almond For Home Servers.
Follow these steps to get the add-on installed on your system: 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 "Almond" add-on and click it. 2. Find the "Almond" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.

2
cec_scan/README.md
View File

@@ -13,7 +13,7 @@ the CEC address of your devices.
Follow these steps to get the add-on installed on your system: 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 "CEC Scanner" add-on and click it. 2. Find the "CEC Scanner" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.

8
check_config/README.md
View File

@@ -15,7 +15,7 @@ resulting in a smooth update.
Follow these steps to get the add-on installed on your system: 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 "Check Home Assistant configuration" add-on and click it. 2. Find the "Check Home Assistant configuration" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -37,10 +37,8 @@ Home Assistant version.
Add-on configuration: Add-on configuration:
```json ```yaml
{ version: latest
"version": "latest"
}
``` ```
### Option: `version` (required) ### Option: `version` (required)

17
configurator/README.md
View File

@@ -34,7 +34,7 @@ configuration files) will be automatically checked for syntax errors while editi
Follow these steps to get the add-on installed on your system: 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 "Configurator" add-on and click it. 2. Find the "Configurator" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -51,15 +51,12 @@ In general, this add-on requires no configuration from your end.
Add-on configuration: Add-on configuration:
```json ```yaml
{ dirsfirst: false
"dirsfirst": false, enforce_basepath: false
"enforce_basepath": false, ignore_pattern:
"ignore_pattern": [ - __pycache__
"__pycache__" ssh_keys: []
],
"ssh_keys": []
}
``` ```
### Option: `dirsfirst` (required) ### Option: `dirsfirst` (required)

19
deconz/README.md
View File

@@ -8,7 +8,7 @@ Control a Zigbee network using ConBee or RaspBee hardware by Dresden Elektronik.
Follow these steps to get the add-on installed on your system: 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 "deCONZ" add-on and click it. 2. Find the "deCONZ" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -140,22 +140,19 @@ These options require a number that represents the log level.
Example add-on config with `dbg_aps` enabled on log level 1: Example add-on config with `dbg_aps` enabled on log level 1:
```json ```yaml
{ device: /dev/ttyUSB0
"device": "/dev/ttyUSB0", vnc_password: ""
"vnc_password": "", dbg_aps: 1
"dbg_aps": 1
}
``` ```
## Configuration ## Configuration
Add-on configuration: Add-on configuration:
```json ```yaml
{ device: /dev/ttyAMA0
"device": "/dev/ttyAMA0"
}
``` ```
### Option: `device` (required) ### Option: `device` (required)

46
dhcp_server/README.md
View File

@@ -14,7 +14,7 @@ to ensure they always get assigned the same IP address.
Follow these steps to get the add-on installed on your system: 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 "DHCP server" add-on and click it. 2. Find the "DHCP server" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -31,31 +31,25 @@ describes each of the add-on configuration options.
Example add-on configuration: Example add-on configuration:
```json ```yaml
{ domain: mynetwork.local
"domain": "mynetwork.local", dns:
"dns": ["8.8.8.8", "8.8.4.4"], - 8.8.8.8
"default_lease": 86400, - 8.8.4.4
"max_lease": 172800, default_lease: 86400
"networks": [ max_lease: 172800
{ networks:
"subnet": "192.168.1.0", - subnet: 192.168.1.0
"netmask": "255.255.255.0", netmask: 255.255.255.0
"range_start": "192.168.1.100", range_start: 192.168.1.100
"range_end": "192.168.1.200", range_end: 192.168.1.200
"broadcast": "192.168.1.255", broadcast: 192.168.1.255
"gateway": "192.168.1.1", gateway: 192.168.1.1
"interface": "eth0" interface: eth0
} hosts:
], - name: webcam_xy
"hosts": [ mac: aa:bb:ee:cc
{ ip: 192.168.1.40
"name": "webcam_xy",
"mac": "aa:bb:ee:cc",
"ip": "192.168.1.40"
}
]
}
``` ```
### Option: `domain` (required) ### Option: `domain` (required)

22
dnsmasq/README.md
View File

@@ -14,7 +14,7 @@ an internal address inside your network.
Follow these steps to get the add-on installed on your system: 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 "Dnsmasq" add-on and click it. 2. Find the "Dnsmasq" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -32,16 +32,16 @@ describes each of the add-on configuration options.
Example add-on configuration: Example add-on configuration:
```json ```yaml
{ defaults:
"defaults": ["8.8.8.8", "8.8.4.4"], - 8.8.8.8
"forwards": [ - 8.8.4.4
{"domain": "mystuff.local", "server": "192.168.1.40"} forwards:
], - domain: mystuff.local
"hosts": [ server: 192.168.1.40
{"host": "home.mydomain.io", "ip": "192.168.1.10"} hosts:
] - host: home.mydomain.io
} ip: 192.168.1.10
``` ```
### Option: `defaults` (required) ### Option: `defaults` (required)

22
duckdns/README.md
View File

@@ -12,7 +12,7 @@ Automatically update your Duck DNS IP address with integrated HTTPS support via
Follow these steps to get the add-on installed on your system: 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 "DuckDNS" add-on and click it. 2. Find the "DuckDNS" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -29,17 +29,15 @@ Follow these steps to get the add-on installed on your system:
Add-on configuration: Add-on configuration:
```json ```yaml
{ lets_encrypt:
"lets_encrypt": { accept_terms: true
"accept_terms": true, certfile: fullchain.pem
"certfile": "fullchain.pem", keyfile: privkey.pem
"keyfile": "privkey.pem" token: sdfj-2131023-dslfjsd-12321
}, domains:
"token": "sdfj-2131023-dslfjsd-12321", - my-domain.duckdns.org
"domains": ["my-domain.duckdns.org"], seconds: 300
"seconds": 300
}
``` ```
### Option group `lets_encrypt` ### Option group `lets_encrypt`

57
git_pull/README.md
View File

@@ -13,7 +13,7 @@ repository.
Follow these steps to get the add-on installed on your system: 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 "Git pull" add-on and click it. 2. Find the "Git pull" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -40,36 +40,31 @@ to `true` and turning on "Start on boot."
Add-on configuration: Add-on configuration:
```json ```yaml
{ git_branch: master
"git_branch": "master", git_command: pull
"git_command": "pull", git_remote: origin
"git_remote": "origin", git_prune: 'false'
"git_prune": "false", repository: https://example.com/my_configs.git
"repository": "https://example.com/my_configs.git", auto_restart: false
"auto_restart": false, restart_ignore:
"restart_ignore": [ - ui-lovelace.yaml
"ui-lovelace.yaml", - ".gitignore"
".gitignore", - exampledirectory/
"exampledirectory/" repeat:
], active: false
"repeat": { interval: 300
"active": false, deployment_user: ''
"interval": 300 deployment_password: ''
}, deployment_key:
"deployment_user": "", - "-----BEGIN RSA PRIVATE KEY-----"
"deployment_password": "", - MIIEowIBAAKCAQEAv3hUrCvqGZKpXQ5ofxTOuH6pYSOZDsCqPqmaGBdUzBFgauQM
"deployment_key": [ - xDEcoODGHIsWd7t9meAFqUtKXndeiKjfP0MMKsttnDohL1kb9mRvHre4VUqMsT5F
"-----BEGIN RSA PRIVATE KEY-----", - "..."
"MIIEowIBAAKCAQEAv3hUrCvqGZKpXQ5ofxTOuH6pYSOZDsCqPqmaGBdUzBFgauQM", - i3RUtnIHxGi1NqknIY56Hwa3id2yk7cEzvQGAAko/t6PCbe20AfmSQczs7wDNtBD
"xDEcoODGHIsWd7t9meAFqUtKXndeiKjfP0MMKsttnDohL1kb9mRvHre4VUqMsT5F", - HgXRyIqIXHYk2+5w+N2eunURIBqCI9uWYK/r81TMR6V84R+XhtvM
"...", - "-----END RSA PRIVATE KEY-----"
"i3RUtnIHxGi1NqknIY56Hwa3id2yk7cEzvQGAAko/t6PCbe20AfmSQczs7wDNtBD", deployment_key_protocol: rsa
"HgXRyIqIXHYk2+5w+N2eunURIBqCI9uWYK/r81TMR6V84R+XhtvM",
"-----END RSA PRIVATE KEY-----"
],
"deployment_key_protocol": "rsa"
}
``` ```
### Option: `git_remote` (required) ### Option: `git_remote` (required)

12
google_assistant/README.md
View File

@@ -16,7 +16,7 @@ If you want to integrate your Google Home or mobile phone running Google Assista
Follow these steps to get the add-on installed on your system: 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 "Google Assistant SDK" add-on and click it. 2. Find the "Google Assistant SDK" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -49,12 +49,10 @@ The next step is to authenticate your Google account with Google Assistant. Star
Add-on configuration: Add-on configuration:
```json ```yaml
{ client_secrets: google_assistant.json
"client_secrets": "google_assistant.json", project_id: project_id_from_google
"project_id": "project_id_from_google", model_id: model_id_from_google
"model_id": "model_id_from_google"
}
``` ```
### Option: `clients_secrets` (required) ### Option: `clients_secrets` (required)

41
homematic/README.md
View File

@@ -23,7 +23,7 @@ to interface with your devices.
Follow these steps to get the add-on installed on your system: 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 "HomeMatic CCU" add-on and click it. 2. Find the "HomeMatic CCU" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -39,31 +39,20 @@ Follow these steps to get the add-on installed on your system:
Add-on configuration: Add-on configuration:
```json ```yaml
{ rf_enable: true
"rf_enable": true, rf:
"rf": [ - type: CCU2
{ device: "/dev/ttyAMA0"
"type": "CCU2", wired_enable: false
"device": "/dev/ttyAMA0" wired:
} - serial: xy
], key: abc
"wired_enable": false, ip: 192.168.0.0
"wired": [ hmip_enable: false
{ hmip:
"serial": "xy", - type: HMIP_CCU2
"key": "abc", device: "/dev/ttyUSB0"
"ip": "192.168.0.0"
}
],
"hmip_enable": false,
"hmip": [
{
"type": "HMIP_CCU2",
"device": "/dev/ttyUSB0"
}
]
}
``` ```
### Option: `rf_enable` (required) ### Option: `rf_enable` (required)

169
letsencrypt/README.md
View File

@@ -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: 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. 2. Find the "letsencrypt" add-on and click it.
3. Click on the "INSTALL" button. 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: To use this add-on, you have two options on how to get your certificate:
### 1. http challenge: ### 1. http challenge
- Requires Port 80 to be available from the internet and your domain assigned to the externally assigned IP address - 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). - Doesnt allow wildcard certificates (*.yourdomain.com).
### 2. dns challenge ### 2. dns challenge
- Requires you to use one of the supported DNS providers (See "Supported DNS providers" below) - Requires you to use one of the supported DNS providers (See "Supported DNS providers" below)
- Allows to request wildcard certificates (*.yourdomain.com) - Allows to request wildcard certificates (*.yourdomain.com)
- Doesn’t need you to open a port to your Home Assistant host on your router. - 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: ### You always need to provide the following entries within the configuration
```json ```yaml
"email": "your@email.com" email: your@email.com
"domains": ["yourdomain.com"] // use "*.yourdomain.com" for wildcard certificates. domains:
"challenge": "http OR dns" # use "*.yourdomain.com" for wildcard certificates.
- yourdomain.com
challenge: http OR dns
``` ```
IF you choose "dns" as "challenge", you will also need to fill: IF you choose "dns" as "challenge", you will also need to fill:
```json ```yaml
"dnsprovider": "" (Add the dnsprovider of your choice from the list of "Supported DNS providers" below) # 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: In addition add the fields according to the credentials required by your dns provider:
```json ```yaml
"cloudflare_email": "", cloudflare_email: ''
"cloudflare_api_key": "", cloudflare_api_key: ''
"cloudxns_api_key": "", cloudxns_api_key: ''
"cloudxns_secret_key": "", cloudxns_secret_key: ''
"digitalocean_token": "", digitalocean_token: ''
"dnsimple_token": "", dnsimple_token: ''
"dnsmadeeasy_api_key": "", dnsmadeeasy_api_key: ''
"dnsmadeeasy_secret_key": "", dnsmadeeasy_secret_key: ''
"google_creds": "", (Credentials file) google_creds: ''
"gehirn_api_token": "", gehirn_api_token: ''
"gehirn_api_secret": "", gehirn_api_secret: ''
"linode_key": "", linode_key: ''
"linode_version": "", linode_version: ''
"luadns_email": "", luadns_email: ''
"luadns_token": "", luadns_token: ''
"nsone_api_key": "", nsone_api_key: ''
"ovh_endpoint": "", ovh_endpoint: ''
"ovh_application_key": "", ovh_application_key: ''
"ovh_application_secret": "", ovh_application_secret: ''
"ovh_consumer_key": "", ovh_consumer_key: ''
"rfc2136_server": "", rfc2136_server: ''
"rfc2136_port": "", rfc2136_port: ''
"rfc2136_name": "", rfc2136_name: ''
"rfc2136_secret": "", rfc2136_secret: ''
"rfc2136_algorithm": "", rfc2136_algorithm: ''
"aws_access_key_id": "", aws_access_key_id: ''
"aws_secret_access_key": "", aws_secret_access_key: ''
"sakuracloud_api_token": "", sakuracloud_api_token: ''
"sakuracloud_api_secret": "" sakuracloud_api_secret: ''
``` ```
## Example Configurations ## Example Configurations
### http challenge
### http challenge: ```yaml
```json email: hello@home-assistant.io
{ domains:
"email": "hello@home-assistant.io", - home-assistant.io
"domains": [ certfile: fullchain.pem
"home-assistant.io" keyfile: privkey.pem
], challenge: http
"certfile": "fullchain.pem", dns: {}
"keyfile": "privkey.pem",
"challenge": "http",
"dns": {
}
}
``` ```
### dns challenge
### dns challenge: ```yaml
```json email: hello@home-assistant.io
{ domains:
"email": "hello@home-assistant.io", - home-assistant.io
"domains": [ certfile: fullchain.pem
"home-assistant.io" keyfile: privkey.pem
], challenge: dns
"certfile": "fullchain.pem", dns:
"keyfile": "privkey.pem", provider: dns-cloudflare
"challenge": "dns", cloudflare_email: cf@home-assistant.io
"dns": { cloudflare_api_key: 31242lk3j4ljlfdwsjf0
"provider": "dns-cloudflare",
"cloudflare_email": "cf@home-assistant.io",
"cloudflare_api_key": "31242lk3j4ljlfdwsjf0"
}
}
``` ```
### google dns challenge
### google dns challenge: ```yaml
```json email: hello@home-assistant.io
{ domains:
"email": "hello@home-assistant.io", - home-assistant.io
"domains": [ certfile: fullchain.pem
"home-assistant.io" keyfile: privkey.pem
], challenge: dns
"certfile": "fullchain.pem", dns:
"keyfile": "privkey.pem", provider: dns-google
"challenge": "dns", google_creds: google.json
"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. 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. 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: 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 ## 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. 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. You can in addition find the files via the "samba" addon within the "ssl" share.
## Supported DNS providers ## Supported DNS providers
```json ```txt
dns-cloudflare dns-cloudflare
dns-cloudxns dns-cloudxns
dns-digitalocean dns-digitalocean
@@ -171,9 +163,6 @@ dns-route53
dns-sakuracloud dns-sakuracloud
``` ```
## Known issues and limitations
## Support ## Support
Got questions? Got questions?

37
mariadb/README.md
View File

@@ -12,7 +12,7 @@ You can use this add-on to install MariaDB, which is an open-source (GPLv2 licen
Follow these steps to get the add-on installed on your system: 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 "MariaDB" add-on and click it. 2. Find the "MariaDB" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -30,27 +30,18 @@ describes each of the add-on configuration options.
Example add-on configuration: Example add-on configuration:
```json ```yaml
{ databases:
"databases": [ - homeassistant
"homeassistant" logins:
], - username: hass
"logins": [ host: "%"
{ password:
"username": "hass", rights:
"host": "%", - username: hass
"password": null host: "%"
} database: homeassistant
], grant: ALL PRIVILEGES ON
"rights": [
{
"username": "hass",
"host": "%",
"database": "homeassistant",
"grant": "ALL PRIVILEGES ON"
}
]
}
``` ```
### Option: `databases` (required) ### Option: `databases` (required)
@@ -99,7 +90,7 @@ MariaDB will be used by the `recorder` and `history` components within Home Assi
Example Home Assistant configuration: Example Home Assistant configuration:
```json ```yaml
recorder: recorder:
db_url: mysql://hass:password@core-mariadb/homeassistant?charset=utf8 db_url: mysql://hass:password@core-mariadb/homeassistant?charset=utf8
``` ```

32
mosquitto/README.md
View File

@@ -12,7 +12,7 @@ You can use this add-on to install Eclipse Mosquitto, which is an open-source (E
Follow these steps to get the add-on installed on your system: 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 "Mosquitto broker" add-on and click it. 2. Find the "Mosquitto broker" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -39,18 +39,15 @@ If you have old MQTT settings available, remove this old integration and restart
Add-on configuration: Add-on configuration:
```json ```yaml
{ logins: []
"logins": [], anonymous: false
"anonymous": false, customize:
"customize": { active: false
"active": false, folder: mosquitto
"folder": "mosquitto" certfile: fullchain.pem
}, keyfile: privkey.pem
"certfile": "fullchain.pem", require_certificate: false
"keyfile": "privkey.pem",
"require_certificate": false
}
``` ```
### Option: `logins` (optional) ### Option: `logins` (optional)
@@ -110,11 +107,10 @@ Add the following configuration to enable **unrestricted** access to all topics.
1. Enable the customize flag 1. Enable the customize flag
```json ```yaml
"customize": { customize:
"active": true, active: true
"folder": "mosquitto" folder: mosquitto
},
``` ```
2. Create `/share/mosquitto/acl.conf` with the contents: 2. Create `/share/mosquitto/acl.conf` with the contents:

25
nginx_proxy/README.md
View File

@@ -14,7 +14,7 @@ Make sure you have generated a certificate before you start this add-on. The [Du
Follow these steps to get the add-on installed on your system: 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 "NGINX Home Assistant SSL proxy" add-on and click it. 2. Find the "NGINX Home Assistant SSL proxy" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -38,19 +38,16 @@ The NGINX Proxy add-on is commonly used in conjunction with the [Duck DNS](https
Add-on configuration: Add-on configuration:
```json ```yaml
{ domain: home.example.com
"domain": "home.example.com", certfile: fullchain.pem
"certfile": "fullchain.pem", keyfile: privkey.pem
"keyfile": "privkey.pem", hsts: "max-age=31536000; includeSubDomains"
"hsts": "max-age=31536000; includeSubDomains", customize:
"customize": { active: false
"active": false, default: "nginx_proxy_default*.conf"
"default": "nginx_proxy_default*.conf", servers: "nginx_proxy/*.conf"
"servers": "nginx_proxy/*.conf" cloudflare: false
},
"cloudflare": false
}
``` ```
### Option: `domain` (required) ### Option: `domain` (required)

33
rpc_shutdown/README.md
View File

@@ -12,7 +12,7 @@ Allows you to shut down and Windows Computer with a service call from Home Assis
Follow these steps to get the add-on installed on your system: 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 "RPC Shutdown" add-on and click it. 2. Find the "RPC Shutdown" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -27,25 +27,18 @@ In the configuration section, define alias, address and credentials and save the
Add-on configuration: Add-on configuration:
```json ```yaml
{ computers:
"computers": [ - alias: test-pc-1
{ address: 192.168.0.1
"alias": "test-pc-1", credentials: user%password
"address": "192.168.0.1", delay: 0
"credentials": "user%password", message: Home Assistant is shutting down this PC. This cannot be canceled. Please save your work!
"delay": 0, - alias: test-pc-2
"message": "Home Assistant is shutting down this PC. This cannot be canceled. Please save your work!" address: 192.168.0.2
}, credentials: user%password
{ delay: 0
"alias": "test-pc-2", message: Home Assistant is shutting down this PC. This cannot be canceled. Please save your work!
"address": "192.168.0.2",
"credentials": "user%password",
"delay": 0,
"message": "Home Assistant is shutting down this PC. This cannot be canceled. Please save your work!"
}
]
}
``` ```
### Option: `computers` (required) ### Option: `computers` (required)

32
samba/README.md
View File

@@ -13,7 +13,7 @@ It lets you access your config files with Windows and macOS devices.
Follow these steps to get the add-on installed on your system: 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 "Samba share" add-on and click it. 2. Find the "Samba share" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -28,23 +28,19 @@ Follow these steps to get the add-on installed on your system:
Add-on configuration: Add-on configuration:
```json ```yaml
{ workgroup: WORKGROUP
"workgroup": "WORKGROUP", username: Hassio
"username": "Hassio", password: 'null'
"password": "null", interface: ''
"interface": "", allow_hosts:
"allow_hosts": [ - 10.0.0.0/8
"10.0.0.0/8", - 172.16.0.0/12
"172.16.0.0/12", - 192.168.0.0/16
"192.168.0.0/16" veto_files:
], - "._*"
"veto_files": [ - ".DS_Store"
"._*", - Thumbs.db
".DS_Store",
"Thumbs.db"
]
}
``` ```
### Option: `workgroup` (required) ### Option: `workgroup` (required)

13
ssh/README.md
View File

@@ -19,7 +19,7 @@ hassio help
Follow these steps to get the add-on installed on your system: 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 "SSH server" add-on and click it. 2. Find the "SSH server" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -45,13 +45,10 @@ The Home Assistant configuration directory is mounted on the path `/config`.
Add-on configuration: Add-on configuration:
```json ```yaml
{ authorized_keys:
"authorized_keys": [ - ssh-rsa AKDJD3839...== my-key
"ssh-rsa AKDJD3839...== my-key" password: ''
],
"password": ""
}
``` ```
### Option: `authorized_keys` ### Option: `authorized_keys`

37
tellstick/README.md
View File

@@ -20,7 +20,7 @@ For more details, please check the TellStick [protocol list][protocol-list].
Follow these steps to get the add-on installed on your system: 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 "TellStick" add-on and click it. 2. Find the "TellStick" add-on and click it.
3. Click on the "INSTALL" button. 3. Click on the "INSTALL" button.
@@ -64,27 +64,20 @@ the [valid parameters for Tellstick configuration file (tellstick.conf)][conf].
Example add-on configuration: Example add-on configuration:
```json ```yaml
{ devices:
"devices": [ - id: 1
{ name: Example device
"id": 1, protocol: everflourish
"name": "Example device", model: selflearning-switch
"protocol": "everflourish", house: A
"model": "selflearning-switch", unit: '1'
"house": "A", - id: 2
"unit": "1" name: Example device two
}, protocol: everflourish
{ model: selflearning-switch
"id": 2, house: A
"name": "Example device two", unit: '2'
"protocol": "everflourish",
"model": "selflearning-switch",
"house": "A",
"unit": "2"
}
]
}
``` ```
Please note: After any changes have been made to the configuration, Please note: After any changes have been made to the configuration,