From 2f80548b72dbdbeb65d53dab413e7d6a1f2c6509 Mon Sep 17 00:00:00 2001 From: Franck Nijhof Date: Tue, 4 Feb 2020 21:38:55 +0100 Subject: [PATCH] Re-branding of core add-ons (#1046) * Re-branding of core add-ons * Update title README * Fix ada description Co-Authored-By: Paulus Schoutsen Co-authored-by: Paulus Schoutsen --- README.md | 12 ++++++------ ada/README.md | 4 ++-- ada/config.json | 2 +- almond/README.md | 2 +- cec_scan/README.md | 2 +- check_config/README.md | 2 +- configurator/README.md | 2 +- deconz/README.md | 10 +++++----- deconz/config.json | 4 ++-- deconz/data/run.sh | 6 +++--- dhcp_server/README.md | 2 +- dnsmasq/README.md | 2 +- duckdns/README.md | 10 +++++----- git_pull/Dockerfile | 2 +- git_pull/README.md | 2 +- google_assistant/README.md | 2 +- google_assistant/data/hassio_gassistant.py | 2 +- google_assistant/data/run.sh | 2 +- homematic/README.md | 2 +- letsencrypt/README.md | 6 +++--- mariadb/README.md | 2 +- mosquitto/README.md | 4 ++-- mosquitto/data/run.sh | 4 ++-- nginx_proxy/README.md | 2 +- rpc_shutdown/README.md | 2 +- samba/README.md | 2 +- samba/config.json | 4 ++-- ssh/Dockerfile | 2 +- ssh/README.md | 10 +++++----- ssh/config.json | 2 +- ssh/data/run.sh | 2 +- tellstick/README.md | 2 +- 32 files changed, 58 insertions(+), 58 deletions(-) diff --git a/README.md b/README.md index d7c0c90..d70e619 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# Hass.io Addons: The official core repository +# Home Assistant Addons: The official repository [![Build Status](https://dev.azure.com/home-assistant/Hass.io/_apis/build/status/addons?branchName=master)](https://dev.azure.com/home-assistant/Hass.io/_build/latest?definitionId=7&branchName=master) -Add-ons for the Hass.io ecosystem, allow you to extend the functionality +Add-ons for Home Assistant, allow you to extend the functionality around your Home Assistant setup. These add-on can consist of an application that Home Assistant can integrate with (e.g., a MQTT broker or database server) or allow access to your Home Assistant configuration (e.g., via Samba or using the Configurator). Add-ons can be installed and configured via the Home Assistant frontend on -systems that have installed Hass.io. +systems that have installed Home Assistant. ## Add-ons provided by this repository @@ -55,7 +55,7 @@ systems that have installed Hass.io. - **[Hey Ada!](/ada/README.md)** - Home Assistant featured voice assistant. + Voice assistant powered by Home Assistant. - **[HomeMatic](/homematic/README.md)** @@ -83,11 +83,11 @@ systems that have installed Hass.io. - **[Samba share](/samba/README.md)** - Expose Hass.io folders with SMB/CIFS. + Expose Home Assistant folders with SMB/CIFS. - **[SSH server](/ssh/README.md)** - Allow logging in remotely to Hass.io using SSH. + Allow logging in remotely to Home Assistant using SSH. - **[TellStick](/tellstick/README.md)** diff --git a/ada/README.md b/ada/README.md index 26c446d..ca71262 100644 --- a/ada/README.md +++ b/ada/README.md @@ -1,6 +1,6 @@ -# Hass.io Core Add-on: Ada +# Home Assistant Add-on: Ada -Home Assistant featured voice assist. +Voice assistant powered by Home Assistant. ![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ![Supports i386 Architecture][i386-shield] diff --git a/ada/config.json b/ada/config.json index 15ee986..8d603b7 100644 --- a/ada/config.json +++ b/ada/config.json @@ -2,7 +2,7 @@ "name": "Hey Ada!", "version": "0.9", "slug": "ada", - "description": "Home Assistant featured voice assist", + "description": "Voice assistant powered by Home Assistant", "url": "https://github.com/home-assistant/hassio-addons/blob/master/ada", "arch": ["armhf", "armv7", "amd64"], "startup": "application", diff --git a/almond/README.md b/almond/README.md index e7c2212..e0086e9 100644 --- a/almond/README.md +++ b/almond/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: Almond +# Home Assistant Add-on: Almond Almond For Home Servers. diff --git a/cec_scan/README.md b/cec_scan/README.md index 062af4c..5ed1621 100644 --- a/cec_scan/README.md +++ b/cec_scan/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: CEC Scanner +# Home Assistant Add-on: CEC Scanner Scan & discover HDMI CEC devices and their addresses. diff --git a/check_config/README.md b/check_config/README.md index 3ad5f21..f501d02 100644 --- a/check_config/README.md +++ b/check_config/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: Check Home Assistant configuration +# Home Assistant Add-on: Check Home Assistant configuration Check your current configuration against any Home Assistant version. diff --git a/configurator/README.md b/configurator/README.md index ac7b17e..a71c172 100644 --- a/configurator/README.md +++ b/configurator/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: Configurator +# Home Assistant Add-on: Configurator Browser-based configuration file editor for Home Assistant. diff --git a/deconz/README.md b/deconz/README.md index 4349944..fbf8b13 100644 --- a/deconz/README.md +++ b/deconz/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: deCONZ +# Home Assistant Add-on: deCONZ Control a Zigbee network using ConBee or RaspBee hardware by Dresden Elektronik. @@ -31,7 +31,7 @@ dtoverlay=pi3-miniuart-bt The add-on needs to know where your ConBee/RaspBee can be found, and therefore, you'll need to configure the add-on to point to the right device. -If you're using Hass.io you may find the correct value for this on the +If you're using Home Assistant you may find the correct value for this on the `Hass.io -> System -> Host system -> Hardware` page. It is recommended to use a "by-id" path to the device if one exists, as it is not subject to change if other devices are added to the system. @@ -62,7 +62,7 @@ follow these instructions to configure the deCONZ integration: ## Migrating to this Add-on -To migrate deCONZ to Hass.io and this add-on, backup your deCONZ config via the +To migrate deCONZ to Home Assistant and this add-on, backup your deCONZ config via the Phoscon WebUI, then restore that config after installing/reinstalling. **_You must perform these steps or your Light, Group names and other data will be lost!_** @@ -89,7 +89,7 @@ macOS, you are in luck, since VNC is built-in. Open the spotlight search and enter the VNC service URL. The VNC service URL looks like [vnc://hassio.local:5900](vnc-service-url). -Adjust port and possibly hostname if you've changed it in Hass.io host system +Adjust port and possibly hostname if you've changed it in Home Assistant host system settings. ## Upgrading RaspBee and ConBee firmware @@ -162,7 +162,7 @@ Add-on configuration: The device address of your ConBee/RaspBee. -If you're using Hass.io you may find the correct value for this on the +If you're using Home Assistant you may find the correct value for this on the `Hass.io -> System -> Host system -> Hardware` page. It is recommended to use a "by-id" path to the device if one exists, as it is not subject to change if other devices are added to the system. diff --git a/deconz/config.json b/deconz/config.json index 5b5edaf..a0eda93 100644 --- a/deconz/config.json +++ b/deconz/config.json @@ -19,8 +19,8 @@ }, "ports_description": { "5900/tcp": "deCONZ graphical desktop via VNC", - "8081/tcp": "deCONZ WebSocket (Not required for Hass.io Ingress)", - "40850/tcp": "deCONZ API backend (Not required for Hass.io Ingress)" + "8081/tcp": "deCONZ WebSocket (Not required for Ingress)", + "40850/tcp": "deCONZ API backend (Not required for Ingress)" }, "kernel_modules": true, "auto_uart": true, diff --git a/deconz/data/run.sh b/deconz/data/run.sh index ef4b291..1b75a67 100755 --- a/deconz/data/run.sh +++ b/deconz/data/run.sh @@ -66,7 +66,7 @@ if bashio::var.has_value "${VNC_PORT}"; then VNC_PASSWORD=$(bashio::config 'vnc_password') echo "${VNC_PASSWORD}" | tigervncpasswd -f > /root/.vncpasswd tigervncserver \ - -name "Hass.io - deCONZ" \ + -name "Home Assistant - deCONZ" \ -geometry 1920x1080 \ -depth 16 \ -localhost no \ @@ -111,8 +111,8 @@ function stop_addon() { } trap "stop_addon" SIGTERM SIGHUP -# Start Hass.io discovery -bashio::log.info "Running Hass.io discovery task..." +# Start Home Assistant discovery +bashio::log.info "Running Home Assistant discovery task..." hassio_discovery & # Start OTA updates for deCONZ diff --git a/dhcp_server/README.md b/dhcp_server/README.md index 187aa86..7b7f38b 100644 --- a/dhcp_server/README.md +++ b/dhcp_server/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: DHCP server +# Home Assistant Add-on: DHCP server A simple DHCP server. diff --git a/dnsmasq/README.md b/dnsmasq/README.md index d12f6f6..791b918 100644 --- a/dnsmasq/README.md +++ b/dnsmasq/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: Dnsmasq +# Home Assistant Add-on: Dnsmasq A simple DNS server. diff --git a/duckdns/README.md b/duckdns/README.md index 679fcda..f5371e3 100644 --- a/duckdns/README.md +++ b/duckdns/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: DuckDNS +# Home Assistant Add-on: DuckDNS Automatically update your Duck DNS IP address with integrated HTTPS support via Let's Encrypt. @@ -53,15 +53,15 @@ Once you have read and accepted the Let's Encrypt[Subscriber Agreement](https:// #### Option `lets_encrypt.certfile` -The name of the certificate file generated by Let's Encrypt. The file is used for SSL by Hass.io add-ons and is recommended to keep the filename as-is (`fullchain.pem`) for compatibility. +The name of the certificate file generated by Let's Encrypt. The file is used for SSL by Home Assistant add-ons and is recommended to keep the filename as-is (`fullchain.pem`) for compatibility. -**Note**: _The file is stored in `/ssl/`, which is the default for Hass.io_ +**Note**: _The file is stored in `/ssl/`, which is the default for Home Assistant_ #### Option `lets_encrypt.keyfile` -The name of the private key file generated by Let's Encrypt. The private key file is used for SSL by Hass.io add-ons and is recommended to keep the filename as-is (`privkey.pem`) for compatibility. +The name of the private key file generated by Let's Encrypt. The private key file is used for SSL by Home Assistant add-ons and is recommended to keep the filename as-is (`privkey.pem`) for compatibility. -**Note**: _The file is stored in `/ssl/`, which is the default for Hass.io_ +**Note**: _The file is stored in `/ssl/`, which is the default for Home Assistant_ ### Option: `ipv4` (optional) diff --git a/git_pull/Dockerfile b/git_pull/Dockerfile index 2376d87..d9d7943 100644 --- a/git_pull/Dockerfile +++ b/git_pull/Dockerfile @@ -4,7 +4,7 @@ FROM $BUILD_FROM # Setup base RUN apk add --no-cache jq curl git openssh-client -# Hass.io CLI +# Home Assistant CLI ARG BUILD_ARCH ARG CLI_VERSION RUN curl -Lso /usr/bin/hassio \ diff --git a/git_pull/README.md b/git_pull/README.md index 3dcc6ec..b32c57f 100644 --- a/git_pull/README.md +++ b/git_pull/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: Git pull +# Home Assistant Add-on: Git pull Load and update configuration files for Home Assistant from a Git repository. diff --git a/google_assistant/README.md b/google_assistant/README.md index ecdd1ab..9f3f3e7 100644 --- a/google_assistant/README.md +++ b/google_assistant/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: Google Assistant SDK +# Home Assistant Add-on: Google Assistant SDK Load and update configuration files for Home Assistant from a Git repository. diff --git a/google_assistant/data/hassio_gassistant.py b/google_assistant/data/hassio_gassistant.py index 1b7f060..2b8e4f7 100644 --- a/google_assistant/data/hassio_gassistant.py +++ b/google_assistant/data/hassio_gassistant.py @@ -1,4 +1,4 @@ -"""Hass.IO Google Assistant.""" +"""Home Assistant Google Assistant.""" import json import sys from pathlib import Path diff --git a/google_assistant/data/run.sh b/google_assistant/data/run.sh index 2a6dff0..ecf8bc9 100755 --- a/google_assistant/data/run.sh +++ b/google_assistant/data/run.sh @@ -21,6 +21,6 @@ elif ! bashio::fs.file_exists "${CRED_JSON}"; then bashio::exit.nok "You need initialize Google Assistant with a client secret JSON!" fi -basio::log.info "Starting Hass.io GAssisant SDK..." +basio::log.info "Starting Home Assistant GAssisant SDK..." exec python3 /hassio_gassistant.py \ "${CRED_JSON}" "${PROJECT_ID}" "${MODEL_ID}" < /dev/null diff --git a/homematic/README.md b/homematic/README.md index 49b5a40..fa710cf 100644 --- a/homematic/README.md +++ b/homematic/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: HomeMatic +# Home Assistant Add-on: HomeMatic HomeMatic central based on OCCU. diff --git a/letsencrypt/README.md b/letsencrypt/README.md index ed85f90..6a4d423 100644 --- a/letsencrypt/README.md +++ b/letsencrypt/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: Letsencrypt +# Home Assistant Add-on: Letsencrypt Let's Encrypt is a certificate authority that provides free X.509 certificates for Transport Layer Security encryption via an automated process designed to eliminate the hitherto complex process of manual creation, validation, signing, installation, and renewal of certificates for secure websites. @@ -30,7 +30,7 @@ To use this add-on, you have two options on how to get your certificate: ### 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 hass.io 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: @@ -134,7 +134,7 @@ In addition add the fields according to the credentials required by your dns pro } } ``` -Please copy your credentials file "google.json" into the "share" shared folder on the hass.io 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. diff --git a/mariadb/README.md b/mariadb/README.md index 1c7dc5d..8d82036 100644 --- a/mariadb/README.md +++ b/mariadb/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: MariaDB +# Home Assistant Add-on: MariaDB MariaDB database for Home Assistant. diff --git a/mosquitto/README.md b/mosquitto/README.md index b822f3f..5c7d4c9 100644 --- a/mosquitto/README.md +++ b/mosquitto/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: Mosquitto broker +# Home Assistant Add-on: Mosquitto broker MQTT broker for Home Assistant. @@ -91,7 +91,7 @@ If set to `true` encryption will be enabled using the cert- and keyfile options. ## Home Assistant user management -This add-on is attached to the Home Assistant user system, so MQTT clients can make use of these credentials. Local users may also still be set independently within the configuration options for the add-on. For the internal Hass.io ecosystem, we register `homeassistant` and `addons`, so these may not be used as user names. +This add-on is attached to the Home Assistant user system, so MQTT clients can make use of these credentials. Local users may also still be set independently within the configuration options for the add-on. For the internal Home Assistant ecosystem, we register `homeassistant` and `addons`, so these may not be used as user names. ## Disable listening on insecure (1883) ports diff --git a/mosquitto/data/run.sh b/mosquitto/data/run.sh index 1b003da..65e6913 100755 --- a/mosquitto/data/run.sh +++ b/mosquitto/data/run.sh @@ -130,9 +130,9 @@ fi if call_hassio GET "services/mqtt" | jq --raw-output ".data.host" | grep -v "$(hostname)" > /dev/null; then bashio::log.warning "There is already an MQTT service running!" else - bashio::log.info "Initialize Hass.io Add-on services" + bashio::log.info "Initialize Home Assistant Add-on services" if ! call_hassio POST "services/mqtt" "$(constrain_host_config addons "${ADDONS_PW}")" > /dev/null; then - bashio::log.error "Can't setup Hass.io service mqtt" + bashio::log.error "Can't setup Home Assistant service mqtt" fi bashio::log.info "Initialize Home Assistant discovery" diff --git a/nginx_proxy/README.md b/nginx_proxy/README.md index ab28aa1..0b70f84 100644 --- a/nginx_proxy/README.md +++ b/nginx_proxy/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: NGINX Home Assistant SSL proxy +# Home Assistant Add-on: NGINX Home Assistant SSL proxy Sets up an SSL proxy with NGINX and redirects traffic from port 80 to 443. diff --git a/rpc_shutdown/README.md b/rpc_shutdown/README.md index f095cd5..713551c 100644 --- a/rpc_shutdown/README.md +++ b/rpc_shutdown/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: RPC Shutdown +# Home Assistant Add-on: RPC Shutdown Shutdown Windows machines remotely. diff --git a/samba/README.md b/samba/README.md index 6c55443..b79e2db 100644 --- a/samba/README.md +++ b/samba/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: Samba share +# Home Assistant Add-on: Samba share Share your configuration over the network using Windows file sharing. diff --git a/samba/config.json b/samba/config.json index 24be12c..ebbe1df 100644 --- a/samba/config.json +++ b/samba/config.json @@ -2,7 +2,7 @@ "name": "Samba share", "version": "9.0", "slug": "samba", - "description": "Expose Hass.io folders with SMB/CIFS", + "description": "Expose Home Assistant folders with SMB/CIFS", "url": "https://github.com/home-assistant/hassio-addons/tree/master/samba", "arch": ["armhf", "armv7", "aarch64", "amd64", "i386"], "startup": "services", @@ -11,7 +11,7 @@ "map": ["config:rw", "ssl:rw", "addons:rw", "share:rw", "backup:rw"], "options": { "workgroup": "WORKGROUP", - "username": "hassio", + "username": "homeassistant", "password": null, "interface": "", "allow_hosts": ["10.0.0.0/8", "172.16.0.0/12", "192.168.0.0/16"], diff --git a/ssh/Dockerfile b/ssh/Dockerfile index 76b1514..feca4e9 100644 --- a/ssh/Dockerfile +++ b/ssh/Dockerfile @@ -67,7 +67,7 @@ RUN \ ADD https://raw.githubusercontent.com/scopatz/nanorc/master/yaml.nanorc /usr/share/nano/yaml.nanorc RUN sed -i 's/^#[[:space:]]*\(include "\/usr\/share\/nano\/\*\.nanorc".*\)/\1/' /etc/nanorc -# Hass.io CLI +# Home Assistant CLI ARG BUILD_ARCH ARG CLI_VERSION RUN curl -Lso /usr/bin/hassio \ diff --git a/ssh/README.md b/ssh/README.md index 6df6133..2b2f549 100644 --- a/ssh/README.md +++ b/ssh/README.md @@ -1,13 +1,13 @@ -# Hass.io Core Add-on: SSH server +# Home Assistant Add-on: SSH server -Allow logging in remotely to Hass.io using SSH. +Allow logging in remotely to Home Assistant using SSH. ![Supports aarch64 Architecture][aarch64-shield] ![Supports amd64 Architecture][amd64-shield] ![Supports armhf Architecture][armhf-shield] ![Supports armv7 Architecture][armv7-shield] ![Supports i386 Architecture][i386-shield] ## About -Setting up an SSH server allows access to your Hass.io folders with any SSH -client. It also includes a command-line tool to access the Hass.io API. +Setting up an SSH server allows access to your Home Assistant folders with any SSH +client. It also includes a command-line tool to access the Home Assistant API. Try it out using: @@ -66,7 +66,7 @@ Set a password for login. **We do NOT recommend this variant**. ## Known issues and limitations - This add-on will not enable you to install packages or do anything as root. - This is not working with Hass.io. + This is not working with Home Assistant. ## Support diff --git a/ssh/config.json b/ssh/config.json index f6d15de..2875f5d 100644 --- a/ssh/config.json +++ b/ssh/config.json @@ -2,7 +2,7 @@ "name": "SSH server", "version": "8.2", "slug": "ssh", - "description": "Allows connections over SSH", + "description": "Allow logging in remotely to Home Assistant using SSH", "url": "https://github.com/home-assistant/hassio-addons/tree/master/ssh", "arch": ["armhf", "armv7", "aarch64", "amd64", "i386"], "startup": "services", diff --git a/ssh/data/run.sh b/ssh/data/run.sh index d5392da..2942d9b 100755 --- a/ssh/data/run.sh +++ b/ssh/data/run.sh @@ -51,7 +51,7 @@ touch /data/.bash_history chmod 600 /data/.bash_history ln -s -f /data/.bash_history /root/.bash_history -# Make Hass.io TOKEN available on the CLI +# Make Home Assistant TOKEN available on the CLI echo "export HASSIO_TOKEN=${HASSIO_TOKEN}" >> /etc/profile.d/hassio.sh # Remove old HASSIO_TOKEN from bash profile (if exists) diff --git a/tellstick/README.md b/tellstick/README.md index 415bda5..37e2990 100644 --- a/tellstick/README.md +++ b/tellstick/README.md @@ -1,4 +1,4 @@ -# Hass.io Core Add-on: TellStick +# Home Assistant Add-on: TellStick TellStick and TellStick Duo service.