-
Notifications
You must be signed in to change notification settings - Fork 104
Installation (Home Assistant Addon)
The ring-mqtt addon repository is a native Home Assistant addon. This project has nothing to do with HACS and attempts to add this repository to HACS will fail. The Home Assistant add-on store is only available when running Home Assistant Supervised installed via either Home Assistant OS or manually. If you are running Home Assistant Core via Docker or manual install into a Python virtual environment, there is no support for the addon store, however, you can still run the ring-mqtt project directly to get the same capabilities.
This add-on requires a working MQTT broker. Configuring Home Assistant MQTT support is outside of the scope of this document but the standard Home Assistant Mosquitto integration along with the Mosquitto MQTT add-on is the recommended configuration.
- Navigate to the add-on store in the Home Assistant UI (Supervisor in the left menu, then Add-on Store on the top tab)
- Select the three vertical dots in the upper right-hand corner and select repositories
- In the Manage add-on repositories screen enter the URL for this projects Github page (https://github.com/tsightler/ring-mqtt-ha-addon) and click add
- After adding the repository scroll to the bottom of the list of addons or use search to find the addon
- Select the addon and click the Install
Prior to running the container for the first time you should review the configuration options by selecting the Configuration tab of the addon in the Home Assistant user interface. See Global Configuration Options for details on the available settings.
Two factor authentication (2FA) is mandatory with and requires authentication to acquire a refresh token via the built-in web UI. The web UI will prompt for the Ring account information and 2FA code and use this to acquire the initial token and authenticate to the Ring API after which new tokens will be requested as needed and automatically saved in the state file for future restarts. To access this Web UI simply click the Open Web UI button on the addons Info page and follow the steps to perform the initial authentication.
Once ring-mqtt is running review the Device Level Options to customize individual behavior of cameras, smart lighting and various other features.
By default, the RTSP server included with this addon is exposed only for use within the Home Assistant environment. If desired, it is possible to allow external clients to connect to the RTSP server by exposing the RTSP port. To access this setting select the Configuration tab in the addon and scroll down to the Network settings and select the port to expose the server on (default is 8554).
The branch configuration option is designed to allow simple, temporary testing of the development branch of ring-mqtt directly from GitHub, without requiring the installation of a new image or addon version. This is primarily useful when troubleshooting an issue or when development has new device support that has not yet made its way to the main release channel. To use the development branch simply set the "branch" configuration option to "dev" and to return to the local code just revert the option value back to "addon".