Skip to content

Commit f22ec74

Browse files
committed
Release 2026.1.1
1 parent 9cfdc42 commit f22ec74

14 files changed

Lines changed: 326 additions & 269 deletions

File tree

.gitattributes

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
# Auto detect text files and perform LF normalization
2-
* text=auto
1+
# Ensure all text files use LF line endings
2+
* text=auto eol=lf

.github/FUNDING.yml

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
1-
# These are supported funding model platforms
1+
# .github/FUNDING.yml
22

3-
github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
4-
patreon: # Replace with a single Patreon username
5-
open_collective: # Replace with a single Open Collective username
6-
ko_fi: # Replace with a single Ko-fi username
7-
tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
8-
community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
9-
liberapay: # Replace with a single Liberapay username
10-
issuehunt: # Replace with a single IssueHunt username
11-
lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
12-
polar: # Replace with a single Polar username
13-
buy_me_a_coffee: 'luligugithub'
14-
custom: # ['https://www.buymeacoffee.com/luligugithub']
3+
# This file is used to specify funding options for the GitHub project.
4+
5+
custom: ['https://www.buymeacoffee.com/luligugithub']

CHANGELOG.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,28 @@
22

33
All notable changes to this project will be documented in this file.
44

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.
66

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+
<a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
118

129
# Changelog
1310

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
16+
17+
![Configuration](https://github.com/user-attachments/assets/5038dba2-438d-4984-bfb7-f76329fe3324)
18+
19+
- 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)
20+
21+
![Welcome message](https://github.com/user-attachments/assets/e4e6c245-125c-4c52-a14d-e720e677f787)
22+
23+
- the add-on always updates matterbridge with the latest stable or the latest dev on restart or rebuild
24+
25+
- the plugins are reinstalled with the latest dev or the latest stable, depending on what was running before the restart or rebuild
26+
1427
## 2.0.19 - 2026-01-25
1528

1629
- Updated matterbridge to [3.5.1](https://matterbridge.io/CHANGELOG.html#351-2026-01-24).

Dockerfile

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
# Base image
2-
FROM node:22-bookworm-slim
2+
FROM node:22-slim
33

44
# Set working directory
55
WORKDIR /app
66

77
# Cache bust: change this value to force a fresh install
8-
ARG CACHEBUST=20260125
8+
ARG CACHEBUST=20260129
99

1010
# Clean the cache to force the latest version of matterbridge and all the plugins
1111
RUN echo "Cache bust: $CACHEBUST" && npm cache clean -f
1212

13-
# Globally install Matterbridge
14-
RUN npm install -g matterbridge --omit=dev
15-
1613
# Copy the run script to the container
1714
COPY run.sh /app/run.sh
1815
RUN chmod +x /app/run.sh

LICENSE

Lines changed: 186 additions & 186 deletions
Large diffs are not rendered by default.

README.md

Lines changed: 41 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,52 @@
1-
# ![Matterbridge Logo](https://raw.githubusercontent.com/Luligu/matterbridge-home-assistant-addon/main/logo.png) &nbsp;&nbsp;&nbsp;Matterbridge Home Assistant Add-on
1+
# <img src="https://matterbridge.io/assets/matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px"> &nbsp;&nbsp;&nbsp;Matterbridge Home Assistant Add-on
22

33
[![npm version](https://img.shields.io/npm/v/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
44
[![npm downloads](https://img.shields.io/npm/dt/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
5-
[![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge?label=docker%20version&sort=semver)](https://hub.docker.com/r/luligu/matterbridge)
6-
[![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge.svg)](https://hub.docker.com/r/luligu/matterbridge)
5+
[![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge/latest?label=docker%20version)](https://hub.docker.com/r/luligu/matterbridge)
6+
[![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge?label=docker%20pulls)](https://hub.docker.com/r/luligu/matterbridge)
77
![Node.js CI](https://github.com/Luligu/matterbridge/actions/workflows/build.yml/badge.svg)
88
![CodeQL](https://github.com/Luligu/matterbridge/actions/workflows/codeql.yml/badge.svg)
99
[![codecov](https://codecov.io/gh/Luligu/matterbridge/branch/main/graph/badge.svg)](https://codecov.io/gh/Luligu/matterbridge)
1010

11-
[![power by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
12-
[![power by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
13-
[![power by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
11+
[![powered by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
12+
[![powered by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
13+
[![powered by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
1414

1515
---
1616

1717
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.
1818

19-
<a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
19+
<a href="https://www.buymeacoffee.com/luligugithub"><img src="https://matterbridge.io/assets/bmc-button.svg" alt="Buy me a coffee" width="120"></a>
2020

2121
# Matterbridge Home Assistant Add-on
2222

2323
This repository contains the Matterbridge Official Home Assistant Add-on.
2424

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.
2626

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).
2828

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.
3030

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).
3232

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.
36+
37+
# Changelogs
38+
39+
[Add-on Changelog](https://github.com/Luligu/matterbridge-home-assistant-addon/blob/main/CHANGELOG.md)
40+
41+
[Matterbridge Changelog](https://matterbridge.io/CHANGELOG.html)
3442

3543
# YouTube
3644

37-
There is this nice video on https://www.youtube.com/watch?v=06zzl7o_IqQ.
45+
Here’s a nice video: https://www.youtube.com/watch?v=06zzl7o_IqQ.
3846

3947
# Matterbridge Home Assistant plugin
4048

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)
4250

4351
## How to install the add-on
4452

@@ -48,7 +56,7 @@ Click here
4856

4957
or from your **Home Assistant** web page, go to **Settings**, select **Add-ons** and click on the **ADD-ON STORE** button.
5058

51-
In the upper right 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
5260

5361
```
5462
https://github.com/Luligu/matterbridge-home-assistant-addon
@@ -66,21 +74,27 @@ The Watchdog is not used because Matterbridge always restarts with docker.
6674

6775
Click on **Build** or **Rebuild**.
6876

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.
7078

7179
Starting Matterbridge the first time after a rebuild takes time too because it will reload all plugins that were already registered.
7280

7381
To open the Matterbridge frontend click on **Open web UI**.
7482

7583
You may be asked to install the Home Assistant Matter Server: confirm the default installation.
7684

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.
88+
89+
![Configuration page](https://github.com/user-attachments/assets/5038dba2-438d-4984-bfb7-f76329fe3324)
7890

7991
## Supervisor behavior
8092

81-
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.
8294

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.
8498

8599
After updating the add-on or rebuilding it, in the log you will see messages like this:
86100

@@ -91,30 +105,20 @@ After updating the add-on or rebuilding it, in the log you will see messages lik
91105
[18:16:18.973] [Matterbridge] Plugin matterbridge-example-dynamic-platform reinstalled.
92106
```
93107

94-
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.
95109

96110
If you were using a plugin installed from a tarball, you need to reinstall it manually.
97111

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.
109113

110-
## How to configure the mdns
114+
## How to configure the Matter mDNS
111115

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.
113117

114-
![image](https://github.com/user-attachments/assets/bdaa91ea-4c87-4aeb-9cec-dd99be0ec8dc)
118+
![Matterbridge settings](https://github.com/user-attachments/assets/50f89b9c-f450-4702-95cf-ee5359e2af31)
115119

116-
You can get the correct interface name from the Network page in the settings of Home Assistant.
120+
You can get the correct interface name from the **Network Adapter** panel. From the Home Assistant frontend navigate to Settings -> System -> Network.
117121

118-
In this case the correct name is end0.
122+
In this case the correct name is end0 but your system can have a different interface.
119123

120-
![image](https://github.com/user-attachments/assets/1c09c1a4-41b5-41ed-924e-1f1086140b50)
124+
![Network configuration](https://github.com/user-attachments/assets/3217ed7c-f5ae-49d9-8155-10966fd05609)

config.json

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,30 @@
11
{
22
"name": "Matterbridge Home Assistant Add-on",
3-
"version": "2.0.19",
3+
"version": "2026.1.1",
44
"slug": "matterbridge",
5-
"hostname": "matterbridge",
65
"description": "Official Matterbridge Home Assistant Add-on",
76
"url": "https://github.com/Luligu/matterbridge-home-assistant-addon",
87
"changelog": "https://github.com/Luligu/matterbridge-home-assistant-addon/blob/main/CHANGELOG.md",
9-
"startup": "application",
10-
"boot": "auto",
8+
"arch": [
9+
"amd64",
10+
"aarch64"
11+
],
12+
"panel_title": "Matterbridge",
13+
"panel_icon": "mdi:bridge",
1114
"ingress": true,
1215
"ingress_port": 8283,
13-
"panel_icon": "mdi:bridge",
14-
"panel_title": "Matterbridge",
1516
"map": [
1617
"addons:rw",
1718
"share:rw"
1819
],
19-
"arch": [
20-
"amd64",
21-
"aarch64"
22-
],
2320
"host_network": true,
24-
"restart": "always"
21+
"restart": "always",
22+
"schema": {
23+
"frontend_bind": "str",
24+
"branch": "list(main|dev)"
25+
},
26+
"options": {
27+
"frontend_bind": "0.0.0.0",
28+
"branch": "main"
29+
}
2530
}

repository.json

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,5 @@
22
"name": "Matterbridge Home Assistant Add-on",
33
"url": "https://github.com/Luligu/matterbridge-home-assistant-addon",
44
"maintainer": "https://github.com/Luligu",
5-
"description": "Official Home Assistant Add-on for Matterbridge",
6-
"arch": [
7-
"amd64",
8-
"aarch64",
9-
"armv7"
10-
]
11-
}
5+
"description": "Official Matterbridge Home Assistant Add-on"
6+
}

run.sh

Lines changed: 48 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,21 +3,66 @@
33
# Define the base directory for Matterbridge
44
HOME_DIR=/addons/matterbridge
55

6+
# Read addon options from /data/options.json (written by Supervisor)
7+
# If a key is missing, fall back to defaults.
8+
FRONTEND_BIND="$(node -p "try{require('/data/options.json').frontend_bind ?? '0.0.0.0'}catch(e){'0.0.0.0'}")"
9+
BRANCH="$(node -p "try{require('/data/options.json').branch ?? 'main'}catch(e){'main'}")"
10+
611
# Define the subdirectories for Matterbridge
712
MATTERBRIDGE_PLUGINS=$HOME_DIR/Matterbridge # For matterbridge plugins
813
MATTERBRIDGE_STORAGE=$HOME_DIR/.matterbridge # For matterbridge storage
914
MATTERBRIDGE_CERT=$HOME_DIR/.mattercert # For matterbridge certification
1015

16+
# Welcome message
17+
echo " "
18+
echo " "
19+
echo "Welcome to the Matterbridge Home Assistant Add-on"
20+
echo " "
21+
DISTRO=$(awk -F= '/^PRETTY_NAME=/{gsub(/"/, "", $2); print $2}' /etc/os-release)
22+
CODENAME=$(awk -F= '/^VERSION_CODENAME=/{print $2}' /etc/os-release)
23+
echo "🖥️ Distro: $DISTRO ($CODENAME)"
24+
echo "🧱 Architecture: $(uname -m)"
25+
echo "🧩 Kernel Version: $(uname -r)"
26+
echo "🟢 Node.js version: $(node -v)"
27+
echo "🟣 Npm version: $(npm -v)"
28+
echo "👤 Hostname: $(hostname)"
29+
echo "👤 User: $(whoami)"
30+
echo "📅 Date: $(date)"
31+
echo " "
32+
1133
# Create directories if they don't exist
34+
echo "Creating matterbridge directories..."
1235
mkdir -p $HOME_DIR
1336
mkdir -p $MATTERBRIDGE_PLUGINS
1437
mkdir -p $MATTERBRIDGE_STORAGE
1538
mkdir -p $MATTERBRIDGE_CERT
1639

40+
# Install Matterbridge based on selected branch
41+
case "$BRANCH" in
42+
dev)
43+
echo "Branch = dev → installing matterbridge@dev from npm..."
44+
echo "This can take up to 3 minute on a Home Assistant Green..."
45+
npm install matterbridge@dev --no-fund --no-audit --global --omit=dev
46+
;;
47+
main|*)
48+
echo "Branch = main → installing matterbridge@latest from npm..."
49+
echo "This can take up to 3 minute on a Home Assistant Green..."
50+
npm install matterbridge --no-fund --no-audit --global --omit=dev
51+
;;
52+
esac
53+
54+
# Base args
55+
ARGS="--docker --homedir $HOME_DIR"
56+
57+
# Add frontend bind
58+
if [ -n "$FRONTEND_BIND" ]; then
59+
ARGS="$ARGS --bind $FRONTEND_BIND"
60+
fi
61+
1762
# Start Matterbridge in a loop to handle restarts internally in the same container
1863
while true; do
19-
echo "Starting Matterbridge..."
20-
matterbridge -docker -ingress -homedir $HOME_DIR
64+
echo "Starting Matterbridge with args: $ARGS"
65+
matterbridge $ARGS
2166
echo "Matterbridge process exited. Restarting in 2 seconds..."
2267
sleep 2
23-
done
68+
done

screenshots/configuration.png

54 KB
Loading

0 commit comments

Comments
 (0)