🎉 Release of add-on UniFi Controller 1.0.0

README.md

@@ -923,10 +923,10 @@ SOFTWARE.
 [traccar-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg
 [traccar-armv7-shield]: https://img.shields.io/badge/armv7-no-red.svg
 [traccar-i386-shield]: https://img.shields.io/badge/i386-no-red.svg
-[addon-unifi]: https://github.com/hassio-addons/addon-unifi/tree/v0.23.2
+[addon-unifi]: https://github.com/hassio-addons/addon-unifi/tree/v1.0.0
-[addon-doc-unifi]: https://github.com/hassio-addons/addon-unifi/blob/v0.23.2/README.md
+[addon-doc-unifi]: https://github.com/hassio-addons/addon-unifi/blob/v1.0.0/README.md
 [unifi-issue]: https://github.com/hassio-addons/addon-unifi/issues
-[unifi-version-shield]: https://img.shields.io/badge/version-v0.23.2-blue.svg
+[unifi-version-shield]: https://img.shields.io/badge/version-v1.0.0-blue.svg
 [unifi-aarch64-shield]: https://img.shields.io/badge/aarch64-yes-green.svg
 [unifi-amd64-shield]: https://img.shields.io/badge/amd64-yes-green.svg
 [unifi-armhf-shield]: https://img.shields.io/badge/armhf-no-red.svg

unifi/CHANGELOG.md

@@ -1,22 +1,33 @@
-## ⚠️ Deprecation warning
-
-This is the final release that supports 32-bits operating systems. Support for 32-bits architectures (armhf, armv7 & i386) will be dropped as of the next release.
-
-The way this add-on currently works around limitations for making it work on those architectures isn't sustainable for the future and slowly becomes problematic. If you are using one of the deprecated architectures, you can update to this release and use that for as long as you want, however, you won't be offered an upgrade to the next release.
-
-If you run a 32-bits operating system, we highly recommend moving/upgrading to a 64-bits OS.
-
 ## What’s changed
 
+⚠️  This is a major release with breaking changes!
+Please read them carefully.
+
+**Besides that, we call this version 1.0.0! Magic** 🪄 
+
+## 🚨 Breaking changes
+
+- 🔥 **Drop support for 32-bits systems (armv7, i386)** @frenck (#242)
+  As announced in the previous release, support for the 32-bits operating system has been dropped. Please migrate to a 64-bits (operating) system in order to use this add-on.
+
+- 🥶 **Use cold backups** @frenck (#243)
+  To make backups (snapshots) more reliable, the add-on will now shut down during the time Home Assistant is making the backup (and of course will start again after the backup is done).
+
+- 🔥 **Drop support for custom SSL certificates** @frenck (#244)
+  Lately, SSL gave problems for a lot of users, which is partly additionally hard because UniFi runs quite some old internals. Therefore, we've removed the SSL options from the add-on. The add-on will migrate your UniFi configuration to use a self-signed SSL certificate on upgrade. If you want to run the UniFi controller with your own SSL certificate, we recommend using a reverse proxy to achieve that.
+
+## 🚀 Enhancements
+
+- 🏎 Reduce default memory footprint @frenck (#245)
+
+## 🧰 Maintenance
+
+- 🚀 Add-on CI improvements @frenck (#241)
+
+## 📚 Documentation
+
+- ✏️ Mark add-on stable @frenck (#246)
+
 ## ⬆️ Dependency updates
 
-- ⬆️ Bump docker/login-action from 1.9.0 to 1.10.0 @dependabot (#221)
+- ⬇️  Downgrade MongoDB to 3.4 to provide an upgrade path @frenck (#247)
-- ⬆️ Bump docker/setup-buildx-action from 1.3.0 to 1.4.1 @dependabot (#223)
-- ⬆️ Bump docker/build-push-action from 2.5.0 to 2.6.1 @dependabot (#224)
-- ⬆️ Bump docker/setup-buildx-action from 1.4.1 to 1.5.0 @dependabot (#225)
-- ⬆️ Bump dessant/lock-threads from 2.0.3 to 2.1.1 @dependabot (#227)
-- ⬆️ Bump docker/setup-buildx-action from 1.5.0 to 1.5.1 @dependabot (#228)
-- ⬆️ Bump actions/stale from 3.0.19 to 4 @dependabot (#229)
-- ⬆️ Bump frenck/action-addon-linter from 2.1 to 2.2 @dependabot (#230)
-- ⬆️ Upgrades add-on base image to v6.2.1 @frenck (#233)
-- ⬆ Upgrade UniFi Controller to 6.2.26 @chrismccracken (#232)

unifi/DOCS.md

@@ -34,9 +34,6 @@ Example add-on configuration, with all available options:
 
 ```yaml
 log_level: info
-ssl: true
-certfile: fullchain.pem
-keyfile: privkey.pem
 memory_max: 2048
 memory_init: 512
 ```
@@ -61,26 +58,6 @@ 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_
-
-### Option: `keyfile`
-
-The private key file to use for SSL.
-
-**Note**: _The file MUST be stored in `/ssl/`, which is the default_
-
 ### Option: `memory_max`
 
 This option allows you to change the amount of memory the UniFi Controller
@@ -88,7 +65,7 @@ is allowed to consume. By default, this is limited to 1 GB. You might want
 to increase this, in order to reduce CPU load or reduce this, in order
 to optimize your system for lower memory usage.
 
-This option takes the number of Megabyte, for example, the default is 1024.
+This option takes the number of Megabyte, for example, the default is 256.
 
 ### Option: `memory_init`
 
@@ -96,7 +73,7 @@ This option allows you to change the amount of memory the UniFi Controller
 will initially reserve/consume when starting. By default, this is limited to
 512M.
 
-This option takes the number of Megabyte, for example, the default is 512.
+This option takes the number of Megabyte, for example, the default is 128.
 
 ## Automated backups
 
@@ -134,12 +111,6 @@ you can manually adopt a device by following these steps:
   in order for this add-on to work properly. Using the Ubiquiti Discovery
   Tool, or SSH'ing into the AP and setting the INFORM after adopting
   will resolve this. (see: _Manually adopting a device_)
-- 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.
 - The following error can show up in the log, but can be safely ignored:
 
   ```
@@ -148,8 +119,6 @@ you can manually adopt a device by following these steps:
     however, the add-on functions 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`.
@@ -158,6 +127,9 @@ you can manually adopt a device by following these steps:
   to open the required "range" of ports needed for this feature to work.
 - This add-on cannot support Ingress due to technical limitations of the
   UniFi software.
+- During making a backup of this add-on via Home Assistant, this add-on will
+  temporary shutdown and start up after the backup has finished. This prevents
+  data corruption during taking the backup.
 
 ## Changelog & Releases
 

unifi/README.md

@@ -33,7 +33,7 @@ Raspberry Pi.
 [maintenance-shield]: https://img.shields.io/maintenance/yes/2021.svg
 [patreon-shield]: https://frenck.dev/wp-content/uploads/2019/12/patreon.png
 [patreon]: https://www.patreon.com/frenck
-[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg
+[project-stage-shield]: https://img.shields.io/badge/project%20stage-production%20ready-brightgreen.svg
-[release-shield]: https://img.shields.io/badge/version-v0.23.2-blue.svg
+[release-shield]: https://img.shields.io/badge/version-v1.0.0-blue.svg
-[release]: https://github.com/hassio-addons/addon-unifi/tree/v0.23.2
+[release]: https://github.com/hassio-addons/addon-unifi/tree/v1.0.0
 [screenshot]: https://github.com/hassio-addons/addon-unifi/raw/main/images/screenshot.jpg

unifi/config.json

@@ -1,6 +1,6 @@
 {
   "name": "UniFi Controller",
-  "version": "0.23.2",
+  "version": "1.0.0",
   "slug": "unifi",
   "description": "Manage your UniFi network using a web browser",
   "url": "https://github.com/hassio-addons/addon-unifi",
@@ -8,14 +8,12 @@
   "startup": "services",
   "arch": [
     "aarch64",
-    "amd64",
+    "amd64"
-    "armv7",
-    "i386"
   ],
   "init": false,
+  "snapshot": "cold",
   "map": [
-    "backup:rw",
+    "backup:rw"
-    "ssl"
   ],
   "ports": {
     "161/udp": null,
@@ -42,16 +40,8 @@
     "10001/udp": "Used for device discovery"
   },
   "hassio_api": true,
-  "options": {
-    "ssl": true,
-    "certfile": "fullchain.pem",
-    "keyfile": "privkey.pem"
-  },
   "schema": {
     "log_level": "list(trace|debug|info|notice|warning|error|fatal)?",
-    "ssl": "bool",
-    "certfile": "str",
-    "keyfile": "str",
     "memory_max": "int?",
     "memory_init": "int?"
   },

unifi/translations/en.yaml

@@ -4,20 +4,6 @@ configuration:
     name: Log level
     description: >-
       Controls the level of log details the add-on provides.
-  ssl:
-    name: SSL
-    description: >-
-      Enables/Disables SSL (HTTPS) on the web interface.
-  certfile:
-    name: Certificate file
-    description: >-
-      The certificate file to use for SSL. Note that this file must
-      exist in the /ssl/ folder.
-  keyfile:
-    name: Private key file
-    description: >-
-      The private key file to use for SSL. Note that this file must
-      exist in the /ssl/ folder.
   memory_max:
     name: Max Memory
     description: >-