UniFi Controller - Community Hass.io Add-on for Home Assistant
Clone or download

README.md

Community Hass.io Add-ons: UniFi Controller

GitHub Release Project Stage License

GitLab CI Project Maintenance GitHub Activity

Bountysource Discord Community Forum

Buy me a coffee

Support my work on Patreon

The UniFi Controller allows you to manage your UniFi network using a web browser.

The UniFi Controller Hass.io add-on

About

This add-on runs Ubiquiti Networks' UniFi Controller software, which allows you to manage your UniFi network via the web browser. The add-on provides a single-click installation and run solution for Hass.io, allowing users to get their network up, running, and updated, easily.

This add-on supports all Hass.io supported architectures, including the Raspberry Pi.

Installation

The installation of this add-on is pretty straightforward and not different in comparison to installing any other Hass.io add-on.

  1. Add our Hass.io add-ons repository to your Hass.io instance.
  2. Install the "UniFi Controller" add-on.
  3. Start the "UniFi Controller" add-on.
  4. Check the logs of the "UniFi Controller" to see if everything went well.
  5. Click the "OPEN WEB UI" button, and follow the initial wizard.
  6. After completing the wizard, log in with the credentials just created.
  7. Go to the settings (gears icon in the bottom left) -> Controller (tab).
  8. Change the Controller Hostname/IP to match the IP or hostname of the device running Hass.io.
  9. Check the box Override inform host with controller hostname/IP.
  10. Hit the "Apply Changes" button to activate the settings.
  11. Ready to go!

NOTE: Do not add this repository to Hass.io, please use: https://github.com/hassio-addons/repository.

Docker status

Supports armhf Architecture Supports aarch64 Architecture Supports amd64 Architecture Supports i386 Architecture

Docker Layers Docker Pulls

Configuration

Note: Remember to restart the add-on when the configuration is changed.

Example add-on configuration:

{
    "log_level": "info",
    "ssl": true,
    "certfile": "fullchain.pem",
    "keyfile": "privkey.pem"
}

Note: This is just an example, don't copy and paste it! Create your own!

Option: log_level

The log_level option controls the level of log output by the addon and can be changed to be more or less verbose, which might be useful when you are dealing with an unknown issue. Possible values are:

  • trace: Show every detail, like all called internal functions.
  • debug: Shows detailed debug information.
  • info: Normal (usually) interesting events.
  • warning: Exceptional occurrences that are not errors.
  • error: Runtime errors that do not require immediate action.
  • fatal: Something went terribly wrong. Add-on becomes unusable.

Please note that each level automatically includes log messages from a more severe level, e.g., debug also shows info messages. By default, the log_level is set to info, which is the recommended setting unless you are troubleshooting.

Option: ssl

Enables/Disables the use of a custom SSL (HTTPS) certificate with the in UniFi web interface. Set it true to enable it, false otherwise.

Note: When leaving this option disabled, UniFi will use a custom/self-signed SSL certificate.

Option: certfile

The certificate file to use for SSL.

Note: The file MUST be stored in /ssl/, which is the default for Hass.io

Option: keyfile

The private key file to use for SSL.

Note: The file MUST be stored in /ssl/, which is the default for Hass.io

Automated backups

The UniFi Controller ships with an automated backup feature. This feature works but has been adjusted to put the created backups in a different location.

Backups are created in /backup/unifi. You can access this folder using the normal Hass.io methods (e.g., using Samba, Terminal, SSH).

Migrating from an existing controller

If you want to migrate from an existing controller to the controller provided by this addon, Ubiquiti has an exellent tutorial on this:

https://help.ubnt.com/hc/en-us/articles/115002869188

This article explains in detail how to use the UniFi Site Export Wizard to quickly and easily export sites from one Controller (including configuration and devices) to another (e.g., this add-on).

Known issues and limitations

  • The AP seems stuck in "adopting" state: Please read the installation instructions carefully. You need to change some controller settings in order for this add-on to work properly.
  • This add-on does support ARM-based devices, nevertheless, they must at least be an ARMv7 device. (Raspberry Pi 1 and Zero is not supported).
  • When using SSL, the following warning is shown in the add-on logs: Warning: The JKS keystore uses a proprietary format.. This warning can be safely ignored. There is nothing wrong and your add-on will function normally.
  • Due limitation, renewed SSL certificates are not picked up automatically. You'd have to restart the add-on in order for UniFi to pick up the change.
  • Due to security policies in the UniFi Controller software, it is currently impossible to add the UniFI web interface to your Home Assistant frontend using a panel_iframe.
  • The broadcast feature of the EDU type APs are currently not working with this add-on. Due to a limitation in Hass.io, is it currently impossible to open the required "range" of ports needed for this feature to work.

Changelog & Releases

This repository keeps a change log using GitHub's releases functionality. The format of the log is based on Keep a Changelog.

Releases are based on Semantic Versioning, and use the format of MAJOR.MINOR.PATCH. In a nutshell, the version will be incremented based on the following:

  • MAJOR: Incompatible or major changes.
  • MINOR: Backwards-compatible new features and enhancements.
  • PATCH: Backwards-compatible bugfixes and package updates.

Support

Got questions?

You have several options to get them answered:

You could also open an issue here GitHub.

Contributing

This is an active open-source project. We are always open to people who want to use the code or contribute to it.

We have set up a separate document containing our contribution guidelines.

Thank you for being involved! 😍

Authors & contributors

The original setup of this repository is by Franck Nijhof.

For a full list of all authors and contributors, check the contributor's page.

We have got some Hass.io add-ons for you

Want some more functionality to your Hass.io Home Assistant instance?

We have created multiple add-ons for Hass.io. For a full list, check out our GitHub Repository.

License

MIT License

Copyright (c) 2018 Franck Nijhof

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.