Skip to content

Commit

Permalink
Re-branding of core add-ons (home-assistant#1046)
Browse files Browse the repository at this point in the history
* Re-branding of core add-ons

* Update title README

* Fix ada description

Co-Authored-By: Paulus Schoutsen <[email protected]>

Co-authored-by: Paulus Schoutsen <[email protected]>
  • Loading branch information
frenck and balloob authored Feb 4, 2020
1 parent fd87353 commit 2f80548
Show file tree
Hide file tree
Showing 32 changed files with 58 additions and 58 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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)**

Expand Down Expand Up @@ -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)**

Expand Down
4 changes: 2 additions & 2 deletions ada/README.md
Original file line number Diff line number Diff line change
@@ -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]

Expand Down
2 changes: 1 addition & 1 deletion ada/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion almond/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hass.io Core Add-on: Almond
# Home Assistant Add-on: Almond

Almond For Home Servers.

Expand Down
2 changes: 1 addition & 1 deletion cec_scan/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion check_config/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion configurator/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hass.io Core Add-on: Configurator
# Home Assistant Add-on: Configurator

Browser-based configuration file editor for Home Assistant.

Expand Down
10 changes: 5 additions & 5 deletions deconz/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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!_**
Expand All @@ -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
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions deconz/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
6 changes: 3 additions & 3 deletions deconz/data/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion dhcp_server/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hass.io Core Add-on: DHCP server
# Home Assistant Add-on: DHCP server

A simple DHCP server.

Expand Down
2 changes: 1 addition & 1 deletion dnsmasq/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hass.io Core Add-on: Dnsmasq
# Home Assistant Add-on: Dnsmasq

A simple DNS server.

Expand Down
10 changes: 5 additions & 5 deletions duckdns/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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)

Expand Down
2 changes: 1 addition & 1 deletion git_pull/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
2 changes: 1 addition & 1 deletion git_pull/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion google_assistant/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion google_assistant/data/hassio_gassistant.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
"""Hass.IO Google Assistant."""
"""Home Assistant Google Assistant."""
import json
import sys
from pathlib import Path
Expand Down
2 changes: 1 addition & 1 deletion google_assistant/data/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
2 changes: 1 addition & 1 deletion homematic/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hass.io Core Add-on: HomeMatic
# Home Assistant Add-on: HomeMatic

HomeMatic central based on OCCU.

Expand Down
6 changes: 3 additions & 3 deletions letsencrypt/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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:

Expand Down Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion mariadb/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hass.io Core Add-on: MariaDB
# Home Assistant Add-on: MariaDB

MariaDB database for Home Assistant.

Expand Down
4 changes: 2 additions & 2 deletions mosquitto/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hass.io Core Add-on: Mosquitto broker
# Home Assistant Add-on: Mosquitto broker

MQTT broker for Home Assistant.

Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions mosquitto/data/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
2 changes: 1 addition & 1 deletion nginx_proxy/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
2 changes: 1 addition & 1 deletion rpc_shutdown/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hass.io Core Add-on: RPC Shutdown
# Home Assistant Add-on: RPC Shutdown

Shutdown Windows machines remotely.

Expand Down
2 changes: 1 addition & 1 deletion samba/README.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 2 additions & 2 deletions samba/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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"],
Expand Down
2 changes: 1 addition & 1 deletion ssh/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
10 changes: 5 additions & 5 deletions ssh/README.md
Original file line number Diff line number Diff line change
@@ -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:

Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion ssh/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion ssh/data/run.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion tellstick/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Hass.io Core Add-on: TellStick
# Home Assistant Add-on: TellStick

TellStick and TellStick Duo service.

Expand Down

0 comments on commit 2f80548

Please sign in to comment.