diff --git a/ada/README.md b/ada/README.md index ca71262..b87acfa 100644 --- a/ada/README.md +++ b/ada/README.md @@ -10,7 +10,7 @@ Voice assistant powered by Home Assistant. 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. 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: -```json -{ - "stt": "cloud", - "tts": "cloud" -} +```yaml +stt: cloud +tts: cloud ``` ### Option: `stt` (required) diff --git a/almond/README.md b/almond/README.md index e0086e9..e6236e2 100644 --- a/almond/README.md +++ b/almond/README.md @@ -10,7 +10,7 @@ Almond For Home Servers. 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. 3. Click on the "INSTALL" button. diff --git a/cec_scan/README.md b/cec_scan/README.md index 5ed1621..02ed7fb 100644 --- a/cec_scan/README.md +++ b/cec_scan/README.md @@ -13,7 +13,7 @@ the CEC address of your devices. 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. 3. Click on the "INSTALL" button. diff --git a/check_config/README.md b/check_config/README.md index f501d02..f641486 100644 --- a/check_config/README.md +++ b/check_config/README.md @@ -15,7 +15,7 @@ resulting in a smooth update. 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. 3. Click on the "INSTALL" button. @@ -37,10 +37,8 @@ Home Assistant version. Add-on configuration: -```json -{ - "version": "latest" -} +```yaml +version: latest ``` ### Option: `version` (required) diff --git a/configurator/README.md b/configurator/README.md index a71c172..7f07044 100644 --- a/configurator/README.md +++ b/configurator/README.md @@ -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: -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. 3. Click on the "INSTALL" button. @@ -51,15 +51,12 @@ In general, this add-on requires no configuration from your end. Add-on configuration: -```json -{ - "dirsfirst": false, - "enforce_basepath": false, - "ignore_pattern": [ - "__pycache__" - ], - "ssh_keys": [] -} +```yaml +dirsfirst: false +enforce_basepath: false +ignore_pattern: + - __pycache__ +ssh_keys: [] ``` ### Option: `dirsfirst` (required) diff --git a/deconz/README.md b/deconz/README.md index fbf8b13..19f5771 100644 --- a/deconz/README.md +++ b/deconz/README.md @@ -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: -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. 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: -```json -{ - "device": "/dev/ttyUSB0", - "vnc_password": "", - "dbg_aps": 1 -} +```yaml +device: /dev/ttyUSB0 +vnc_password: "" +dbg_aps: 1 + ``` ## Configuration Add-on configuration: -```json -{ - "device": "/dev/ttyAMA0" -} +```yaml +device: /dev/ttyAMA0 ``` ### Option: `device` (required) diff --git a/dhcp_server/README.md b/dhcp_server/README.md index 7b7f38b..6fa884a 100644 --- a/dhcp_server/README.md +++ b/dhcp_server/README.md @@ -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: -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. 3. Click on the "INSTALL" button. @@ -31,31 +31,25 @@ describes each of the add-on configuration options. Example add-on configuration: -```json -{ - "domain": "mynetwork.local", - "dns": ["8.8.8.8", "8.8.4.4"], - "default_lease": 86400, - "max_lease": 172800, - "networks": [ - { - "subnet": "192.168.1.0", - "netmask": "255.255.255.0", - "range_start": "192.168.1.100", - "range_end": "192.168.1.200", - "broadcast": "192.168.1.255", - "gateway": "192.168.1.1", - "interface": "eth0" - } - ], - "hosts": [ - { - "name": "webcam_xy", - "mac": "aa:bb:ee:cc", - "ip": "192.168.1.40" - } - ] -} +```yaml +domain: mynetwork.local +dns: + - 8.8.8.8 + - 8.8.4.4 +default_lease: 86400 +max_lease: 172800 +networks: + - subnet: 192.168.1.0 + netmask: 255.255.255.0 + range_start: 192.168.1.100 + range_end: 192.168.1.200 + broadcast: 192.168.1.255 + gateway: 192.168.1.1 + interface: eth0 +hosts: + - name: webcam_xy + mac: aa:bb:ee:cc + ip: 192.168.1.40 ``` ### Option: `domain` (required) diff --git a/dnsmasq/README.md b/dnsmasq/README.md index 791b918..37b38b8 100644 --- a/dnsmasq/README.md +++ b/dnsmasq/README.md @@ -14,7 +14,7 @@ an internal address inside your network. 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. 3. Click on the "INSTALL" button. @@ -32,16 +32,16 @@ describes each of the add-on configuration options. Example add-on configuration: -```json -{ - "defaults": ["8.8.8.8", "8.8.4.4"], - "forwards": [ - {"domain": "mystuff.local", "server": "192.168.1.40"} - ], - "hosts": [ - {"host": "home.mydomain.io", "ip": "192.168.1.10"} - ] -} +```yaml +defaults: + - 8.8.8.8 + - 8.8.4.4 +forwards: + - domain: mystuff.local + server: 192.168.1.40 +hosts: + - host: home.mydomain.io + ip: 192.168.1.10 ``` ### Option: `defaults` (required) diff --git a/duckdns/README.md b/duckdns/README.md index f5371e3..984a542 100644 --- a/duckdns/README.md +++ b/duckdns/README.md @@ -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: -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. 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: -```json -{ - "lets_encrypt": { - "accept_terms": true, - "certfile": "fullchain.pem", - "keyfile": "privkey.pem" - }, - "token": "sdfj-2131023-dslfjsd-12321", - "domains": ["my-domain.duckdns.org"], - "seconds": 300 -} +```yaml +lets_encrypt: + accept_terms: true + certfile: fullchain.pem + keyfile: privkey.pem +token: sdfj-2131023-dslfjsd-12321 +domains: + - my-domain.duckdns.org +seconds: 300 ``` ### Option group `lets_encrypt` diff --git a/git_pull/README.md b/git_pull/README.md index b32c57f..6ea0370 100644 --- a/git_pull/README.md +++ b/git_pull/README.md @@ -13,7 +13,7 @@ repository. 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. 3. Click on the "INSTALL" button. @@ -40,36 +40,31 @@ to `true` and turning on "Start on boot." Add-on configuration: -```json -{ - "git_branch": "master", - "git_command": "pull", - "git_remote": "origin", - "git_prune": "false", - "repository": "https://example.com/my_configs.git", - "auto_restart": false, - "restart_ignore": [ - "ui-lovelace.yaml", - ".gitignore", - "exampledirectory/" - ], - "repeat": { - "active": false, - "interval": 300 - }, - "deployment_user": "", - "deployment_password": "", - "deployment_key": [ -"-----BEGIN RSA PRIVATE KEY-----", -"MIIEowIBAAKCAQEAv3hUrCvqGZKpXQ5ofxTOuH6pYSOZDsCqPqmaGBdUzBFgauQM", -"xDEcoODGHIsWd7t9meAFqUtKXndeiKjfP0MMKsttnDohL1kb9mRvHre4VUqMsT5F", -"...", -"i3RUtnIHxGi1NqknIY56Hwa3id2yk7cEzvQGAAko/t6PCbe20AfmSQczs7wDNtBD", -"HgXRyIqIXHYk2+5w+N2eunURIBqCI9uWYK/r81TMR6V84R+XhtvM", -"-----END RSA PRIVATE KEY-----" - ], - "deployment_key_protocol": "rsa" -} +```yaml +git_branch: master +git_command: pull +git_remote: origin +git_prune: 'false' +repository: https://example.com/my_configs.git +auto_restart: false +restart_ignore: + - ui-lovelace.yaml + - ".gitignore" + - exampledirectory/ +repeat: + active: false + interval: 300 +deployment_user: '' +deployment_password: '' +deployment_key: + - "-----BEGIN RSA PRIVATE KEY-----" + - MIIEowIBAAKCAQEAv3hUrCvqGZKpXQ5ofxTOuH6pYSOZDsCqPqmaGBdUzBFgauQM + - xDEcoODGHIsWd7t9meAFqUtKXndeiKjfP0MMKsttnDohL1kb9mRvHre4VUqMsT5F + - "..." + - i3RUtnIHxGi1NqknIY56Hwa3id2yk7cEzvQGAAko/t6PCbe20AfmSQczs7wDNtBD + - HgXRyIqIXHYk2+5w+N2eunURIBqCI9uWYK/r81TMR6V84R+XhtvM + - "-----END RSA PRIVATE KEY-----" +deployment_key_protocol: rsa ``` ### Option: `git_remote` (required) diff --git a/google_assistant/README.md b/google_assistant/README.md index 9f3f3e7..37a4696 100644 --- a/google_assistant/README.md +++ b/google_assistant/README.md @@ -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: -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. 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: -```json -{ - "client_secrets": "google_assistant.json", - "project_id": "project_id_from_google", - "model_id": "model_id_from_google" -} +```yaml +client_secrets: google_assistant.json +project_id: project_id_from_google +model_id: model_id_from_google ``` ### Option: `clients_secrets` (required) diff --git a/homematic/README.md b/homematic/README.md index fa710cf..30d33ca 100644 --- a/homematic/README.md +++ b/homematic/README.md @@ -23,7 +23,7 @@ to interface with your devices. 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. 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: -```json -{ - "rf_enable": true, - "rf": [ - { - "type": "CCU2", - "device": "/dev/ttyAMA0" - } - ], - "wired_enable": false, - "wired": [ - { - "serial": "xy", - "key": "abc", - "ip": "192.168.0.0" - } - ], - "hmip_enable": false, - "hmip": [ - { - "type": "HMIP_CCU2", - "device": "/dev/ttyUSB0" - } - ] -} +```yaml +rf_enable: true +rf: + - type: CCU2 + device: "/dev/ttyAMA0" +wired_enable: false +wired: + - serial: xy + key: abc + ip: 192.168.0.0 +hmip_enable: false +hmip: + - type: HMIP_CCU2 + device: "/dev/ttyUSB0" ``` ### Option: `rf_enable` (required) diff --git a/letsencrypt/README.md b/letsencrypt/README.md index 6a4d423..42ede72 100644 --- a/letsencrypt/README.md +++ b/letsencrypt/README.md @@ -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 + ## 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? diff --git a/mariadb/README.md b/mariadb/README.md index 8d82036..d12c371 100644 --- a/mariadb/README.md +++ b/mariadb/README.md @@ -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: -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. 3. Click on the "INSTALL" button. @@ -30,27 +30,18 @@ describes each of the add-on configuration options. Example add-on configuration: -```json -{ - "databases": [ - "homeassistant" - ], - "logins": [ - { - "username": "hass", - "host": "%", - "password": null - } - ], - "rights": [ - { - "username": "hass", - "host": "%", - "database": "homeassistant", - "grant": "ALL PRIVILEGES ON" - } - ] -} +```yaml +databases: + - homeassistant +logins: + - username: hass + host: "%" + password: +rights: + - username: hass + host: "%" + database: homeassistant + grant: ALL PRIVILEGES ON ``` ### Option: `databases` (required) @@ -99,7 +90,7 @@ MariaDB will be used by the `recorder` and `history` components within Home Assi Example Home Assistant configuration: -```json +```yaml recorder: db_url: mysql://hass:password@core-mariadb/homeassistant?charset=utf8 ``` diff --git a/mosquitto/README.md b/mosquitto/README.md index 5c7d4c9..cd3daa0 100644 --- a/mosquitto/README.md +++ b/mosquitto/README.md @@ -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: -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. 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: -```json -{ - "logins": [], - "anonymous": false, - "customize": { - "active": false, - "folder": "mosquitto" - }, - "certfile": "fullchain.pem", - "keyfile": "privkey.pem", - "require_certificate": false -} +```yaml +logins: [] +anonymous: false +customize: + active: false + folder: mosquitto +certfile: fullchain.pem +keyfile: privkey.pem +require_certificate: false ``` ### Option: `logins` (optional) @@ -110,11 +107,10 @@ Add the following configuration to enable **unrestricted** access to all topics. 1. Enable the customize flag - ```json - "customize": { - "active": true, - "folder": "mosquitto" - }, + ```yaml + customize: + active: true + folder: mosquitto ``` 2. Create `/share/mosquitto/acl.conf` with the contents: diff --git a/nginx_proxy/README.md b/nginx_proxy/README.md index 0b70f84..8b1bbe3 100644 --- a/nginx_proxy/README.md +++ b/nginx_proxy/README.md @@ -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: -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. 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: -```json -{ - "domain": "home.example.com", - "certfile": "fullchain.pem", - "keyfile": "privkey.pem", - "hsts": "max-age=31536000; includeSubDomains", - "customize": { - "active": false, - "default": "nginx_proxy_default*.conf", - "servers": "nginx_proxy/*.conf" - }, - "cloudflare": false -} +```yaml +domain: home.example.com +certfile: fullchain.pem +keyfile: privkey.pem +hsts: "max-age=31536000; includeSubDomains" +customize: + active: false + default: "nginx_proxy_default*.conf" + servers: "nginx_proxy/*.conf" +cloudflare: false ``` ### Option: `domain` (required) diff --git a/rpc_shutdown/README.md b/rpc_shutdown/README.md index 713551c..e457892 100644 --- a/rpc_shutdown/README.md +++ b/rpc_shutdown/README.md @@ -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: -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. 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: -```json -{ - "computers": [ - { - "alias": "test-pc-1", - "address": "192.168.0.1", - "credentials": "user%password", - "delay": 0, - "message": "Home Assistant is shutting down this PC. This cannot be canceled. Please save your work!" - }, - { - "alias": "test-pc-2", - "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!" - } - ] -} +```yaml +computers: + - alias: test-pc-1 + address: 192.168.0.1 + credentials: user%password + delay: 0 + message: Home Assistant is shutting down this PC. This cannot be canceled. Please save your work! + - alias: test-pc-2 + 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) diff --git a/samba/README.md b/samba/README.md index b79e2db..732cd0f 100644 --- a/samba/README.md +++ b/samba/README.md @@ -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: -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. 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: -```json -{ - "workgroup": "WORKGROUP", - "username": "Hassio", - "password": "null", - "interface": "", - "allow_hosts": [ - "10.0.0.0/8", - "172.16.0.0/12", - "192.168.0.0/16" - ], - "veto_files": [ - "._*", - ".DS_Store", - "Thumbs.db" - ] -} +```yaml +workgroup: WORKGROUP +username: Hassio +password: 'null' +interface: '' +allow_hosts: + - 10.0.0.0/8 + - 172.16.0.0/12 + - 192.168.0.0/16 +veto_files: + - "._*" + - ".DS_Store" + - Thumbs.db ``` ### Option: `workgroup` (required) diff --git a/ssh/README.md b/ssh/README.md index 2b2f549..b8118be 100644 --- a/ssh/README.md +++ b/ssh/README.md @@ -19,7 +19,7 @@ hassio help 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. 3. Click on the "INSTALL" button. @@ -45,13 +45,10 @@ The Home Assistant configuration directory is mounted on the path `/config`. Add-on configuration: -```json -{ - "authorized_keys": [ - "ssh-rsa AKDJD3839...== my-key" - ], - "password": "" -} +```yaml +authorized_keys: + - ssh-rsa AKDJD3839...== my-key +password: '' ``` ### Option: `authorized_keys` diff --git a/tellstick/README.md b/tellstick/README.md index 37e2990..8eab488 100644 --- a/tellstick/README.md +++ b/tellstick/README.md @@ -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: -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. 3. Click on the "INSTALL" button. @@ -64,27 +64,20 @@ the [valid parameters for Tellstick configuration file (tellstick.conf)][conf]. Example add-on configuration: -```json -{ - "devices": [ - { - "id": 1, - "name": "Example device", - "protocol": "everflourish", - "model": "selflearning-switch", - "house": "A", - "unit": "1" - }, - { - "id": 2, - "name": "Example device two", - "protocol": "everflourish", - "model": "selflearning-switch", - "house": "A", - "unit": "2" - } - ] -} +```yaml +devices: + - id: 1 + name: Example device + protocol: everflourish + model: selflearning-switch + house: A + unit: '1' + - id: 2 + name: Example device two + protocol: everflourish + model: selflearning-switch + house: A + unit: '2' ``` Please note: After any changes have been made to the configuration,