You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CHANGELOG.md
+18-5Lines changed: 18 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,15 +2,28 @@
2
2
3
3
All notable changes to this project will be documented in this file.
4
4
5
-
If you like this project and find it useful, please consider giving it a star on GitHub at https://github.com/Luligu/matterbridge-home-assistant-addon and sponsoring it at https://buymeacoffee.com/luligugithub.
5
+
If you like this project and find it useful, please consider giving it a star on [GitHub](https://github.com/Luligu/matterbridge-home-assistant-addon) and sponsoring it.
6
6
7
-
If you have problems updating the add-on after installing the new Supervisor, I suggest you uninstall the add-on, remove the add-on and install it fresh. No data will be lost.
8
-
Remeber to enable **Start on boot**, **Auto update** and **Show in sidebar**.
9
-
10
-
In the future, the add-on will be updated with each important new release of Matterbridge. This is to avoid that a full restart (like for a blackout) or a supervisor update downgrades the Matterbridge version with the latest built image of the add-on.
7
+
<ahref="https://www.buymeacoffee.com/luligugithub"><imgsrc="https://matterbridge.io/assets/bmc-button.svg"alt="Buy me a coffee"width="120"></a>
11
8
12
9
# Changelog
13
10
11
+
## 2026.1.1 - 2026-01-29
12
+
13
+
The add-on has been entirely redesigned:
14
+
15
+
- added a configuration page where you can set the binding address for the matterbridge frontend and choose whether to install the latest dev or the latest stable release of matterbridge
- added a welcome message with information about the image (from the Home Assistant frontend navigate to Settings -> System -> Logs and select Matterbridge Home Assistant Add-on)
If you like this project and find it useful, please consider giving it a star on [GitHub](https://github.com/Luligu/matterbridge-home-assistant-addon) and sponsoring it.
18
18
19
-
<ahref="https://www.buymeacoffee.com/luligugithub"><imgsrc="https://matterbridge.io/bmc-button.svg"alt="Buy me a coffee"width="120"></a>
19
+
<ahref="https://www.buymeacoffee.com/luligugithub"><imgsrc="https://matterbridge.io/assets/bmc-button.svg"alt="Buy me a coffee"width="120"></a>
20
20
21
21
# Matterbridge Home Assistant Add-on
22
22
23
23
This repository contains the Matterbridge Official Home Assistant Add-on.
24
24
25
-
It allows you to run Matterbridge as a Home Assistant Add-on.
25
+
It allows you to run [Matterbridge](https://matterbridge.io) as a Home Assistant Add-on.
26
26
27
-
All Matterbridge features are correctly working in the official add-on (e.g. you can update Matterbridge itself or the plugins without issues).
27
+
All Matterbridge features work correctly in the official add-on (e.g. you can update Matterbridge itself or the plugins without issues).
28
28
29
-
The Matterbridge storage and the Matterbridge plugins storage persist when you update the Add-on, rebuild or restart it.
29
+
The Matterbridge storage and the Matterbridge plugins storage persist when you update, rebuild or restart the Add-on.
30
30
31
-
When you build/rebuild the add-on, Matterbridge will reload all plugins that were registered (it takes time so be patient).
31
+
When you build/rebuild the add-on, Matterbridge will reload all plugins that were previously registered (it takes time so be patient).
32
32
33
-
The Add-on can run on arm64, amd64 archs (armv7 is [deprecated](https://www.home-assistant.io/blog/2025/05/22/deprecating-core-and-supervised-installation-methods-and-32-bit-systems) by Home Assistant). The image is built on Debian 12 (bookworm-slim) with Node.js 22.
33
+
The Add-on can run on arm64, amd64 archs (armv7 arch is [deprecated](https://www.home-assistant.io/blog/2025/05/22/deprecating-core-and-supervised-installation-methods-and-32-bit-systems) by Home Assistant).
34
+
35
+
The image is built on Debian 12 (bookworm-slim) with Node.js 22.
There is this nice video onhttps://www.youtube.com/watch?v=06zzl7o_IqQ.
45
+
Here’s a nice video:https://www.youtube.com/watch?v=06zzl7o_IqQ.
38
46
39
47
# Matterbridge Home Assistant plugin
40
48
41
-
The ideal companion of the add-on is the [Official Matterbridge Home Assistant plugin](https://github.com/Luligu/matterbridge-hass/blob/main/README.md)
49
+
The ideal companion to the add-on is the [Official Matterbridge Home Assistant plugin](https://github.com/Luligu/matterbridge-hass/blob/main/README.md)
42
50
43
51
## How to install the add-on
44
52
@@ -48,7 +56,7 @@ Click here
48
56
49
57
or from your **Home Assistant** web page, go to **Settings**, select **Add-ons** and click on the **ADD-ON STORE** button.
50
58
51
-
In the upperright corner click on the **three dots menu**, select **Repositories** and paste this link
59
+
In the upper-right corner, click on the **three dots menu**, select **Repositories** and paste this link
@@ -66,21 +74,27 @@ The Watchdog is not used because Matterbridge always restarts with docker.
66
74
67
75
Click on **Build** or **Rebuild**.
68
76
69
-
The building process on a Home Assistant Green takes around 2-3 minute.
77
+
The building process on a Home Assistant Green takes around 2-3 minutes.
70
78
71
79
Starting Matterbridge the first time after a rebuild takes time too because it will reload all plugins that were already registered.
72
80
73
81
To open the Matterbridge frontend click on **Open web UI**.
74
82
75
83
You may be asked to install the Home Assistant Matter Server: confirm the default installation.
76
84
77
-
This add-on has no configuration.
85
+
The add-on works perfectly with the beta of Matter Server (we use the same matter library).
86
+
87
+
This add-on has a configuration page where you can set the binding address for the matterbridge frontend and select to install the latest dev or the latest stable release of matterbridge.
When the supervisor gets updated, or the host machine (like a Home Assistant Green) makes a full reboot, the supervisor recreates the matterbridge container with the last built image. This can lead to having a very old version of matterbridge and plugins.
93
+
To avoid having any old version of matterbridge and plugins, always update the add-on and rebuild the container when you are prompted to.
82
94
83
-
To avoid this, update the add-on and rebuild the container when you are prompted to.
95
+
A restart or reboot of Home Assistant will update the Matterbridge version.
96
+
97
+
A restart or rebuild of the add-on will update the Matterbridge version.
84
98
85
99
After updating the add-on or rebuilding it, in the log you will see messages like this:
86
100
@@ -91,30 +105,20 @@ After updating the add-on or rebuilding it, in the log you will see messages lik
This is normal in this context and means that Matterbridge detected that in the new image the plugins are not present and will install them from npm using the latest version.
108
+
This is normal in this context and means that Matterbridge detected that the plugins are not present in the newly created container and will install them from npm using the latest stable version or the latest dev version.
95
109
96
110
If you were using a plugin installed from a tarball, you need to reinstall it manually.
97
111
98
-
If you were using a dev version of plugin, it will be reinstalled with the latest dev version.
99
-
100
-
## Home Assistant restart and reboot
101
-
102
-
A simple restart of Home Assistant doesn't change the Matterbridge version.
103
-
104
-
A restart (more correctly a recreate) of the Add-on will recreate the image with the Matterbridge version it was originally built with. So it can be an **old version**.
105
-
106
-
A full reboot (or a power outage) has the effect that the original add-on image is loaded with the Matterbridge version it was originally built with. So it can be an **old version**.
107
-
108
-
In this cases rebuild the add-on to get the latest versions of Matterbridge and plugins.
112
+
If you were using a dev version of a plugin, it will be reinstalled with the latest dev version.
109
113
110
-
## How to configure the mdns
114
+
## How to configure the Matter mDNS
111
115
112
-
Since Home Assistant exposes a lot of interfaces to the containers, is mandatory to set the matter mdns interface in the Matterbridge Settings page.
116
+
Since Home Assistant exposes a lot of interfaces to the containers, it is mandatory to set the **matter mdns interface** in the Matterbridge Settings page.
0 commit comments