matterbridge 3.3.4-dev-20251021-7651f57 → 3.3.4-dev-20251022-681420c

package/CHANGELOG.md

@@ -37,8 +37,9 @@ Advantages:
 
 - [frontend]: Added debounce to MatterSettings.
 - [cli]: Bumped `cli` version to 3.0.0 with backport of Traker and Inspector from thread module.
-- [powerSource]: Added MatterbridgePowerSourceServer that initialize the enpointList of the PowerSource cluster.
+- [powerSource]: Added MatterbridgePowerSourceServer. It initializes the enpointList of the PowerSource cluster.
 - [thread]: Added BroadcastServer to Matterbridge.
+- [service]: Added configuration [guide](README-SERVICE-LOCAL.md) to run matterbridge as a daemon with systemctl (Linux only) and with local global node_modules (no sudo required).
 
 ### Changed
 

package/README-SERVICE-LOCAL.md

@@ -0,0 +1,226 @@
+# <img src="frontend/public/matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge systemd configuration with local global node_modules
+
+[![npm version](https://img.shields.io/npm/v/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
+[![npm downloads](https://img.shields.io/npm/dt/matterbridge.svg)](https://www.npmjs.com/package/matterbridge)
+[![Docker Version](https://img.shields.io/docker/v/luligu/matterbridge?label=docker%20version&sort=semver)](https://hub.docker.com/r/luligu/matterbridge)
+[![Docker Pulls](https://img.shields.io/docker/pulls/luligu/matterbridge.svg)](https://hub.docker.com/r/luligu/matterbridge)
+![Node.js CI](https://github.com/Luligu/matterbridge/actions/workflows/build.yml/badge.svg)
+![CodeQL](https://github.com/Luligu/matterbridge/actions/workflows/codeql.yml/badge.svg)
+[![codecov](https://codecov.io/gh/Luligu/matterbridge/branch/main/graph/badge.svg)](https://codecov.io/gh/Luligu/matterbridge)
+
+[![power by](https://img.shields.io/badge/powered%20by-matter--history-blue)](https://www.npmjs.com/package/matter-history)
+[![power by](https://img.shields.io/badge/powered%20by-node--ansi--logger-blue)](https://www.npmjs.com/package/node-ansi-logger)
+[![power by](https://img.shields.io/badge/powered%20by-node--persist--manager-blue)](https://www.npmjs.com/package/node-persist-manager)
+
+---
+
+# Advanced configuration
+
+## Run matterbridge as a daemon with systemctl (Linux only) with local global node_modules
+
+The easiest way to add systemctl is to use [Matterbridge service cli for linux](https://github.com/Luligu/mb-service-linux).
+
+If your setup is too complex or you prefer to do it manually follow this method. You can still use mb-service to manage systemd after.
+
+### First create the Matterbridge directories and set the correct permissions
+
+This will create the required directories if they don't exist
+
+```bash
+cd ~
+sudo systemctl stop matterbridge                                                        # ✅ Safe precaution
+mkdir -p ~/Matterbridge ~/.matterbridge ~/.mattercert ~/.npm-global                     # ✅ Creates all needed dirs
+chown -R $USER:$USER ~/Matterbridge ~/.matterbridge ~/.mattercert ~/.npm-global         # ✅ Ensures ownership
+chmod -R 755 ~/Matterbridge ~/.matterbridge ~/.mattercert ~/.npm-global                 # ✅ Secure permissions
+NPM_CONFIG_PREFIX=~/.npm-global npm install matterbridge --omit=dev --verbose --global  # ✅ Install, no sudo
+```
+
+### Then create a system-wide symlink
+
+```bash
+sudo ln -sf /home/$USER/.npm-global/bin/matterbridge /usr/local/bin/matterbridge
+which matterbridge
+matterbridge --version
+```
+
+### Then create a systemctl configuration file for Matterbridge
+
+Create a systemctl configuration file for Matterbridge
+
+```bash
+sudo nano /etc/systemd/system/matterbridge.service
+```
+
+Add the following to this file, replacing 5 times (!) USER with your user name (e.g. WorkingDirectory=/home/pi/Matterbridge, User=pi and Group=pi and Environment="NPM_CONFIG_PREFIX=/home/pi/.npm-global"):
+
+```
+[Unit]
+Description=matterbridge
+After=network.target
+Wants=network.target
+
+[Service]
+Type=simple
+Environment="NPM_CONFIG_PREFIX=/home/<USER>/.npm-global"
+ExecStart=matterbridge --service --nosudo
+WorkingDirectory=/home/<USER>/Matterbridge
+StandardOutput=inherit
+StandardError=inherit
+Restart=always
+User=<USER>
+Group=<USER>
+
+[Install]
+WantedBy=multi-user.target
+```
+
+If you use the frontend with **-ssl** -frontend 443 and get an error message: "Port 443 requires elevated privileges",
+add this:
+
+```
+[Service]
+AmbientCapabilities=CAP_NET_BIND_SERVICE
+```
+
+If you use the **matterbridge-bthome** plugin add this:
+
+```
+[Service]
+AmbientCapabilities=CAP_NET_BIND_SERVICE CAP_NET_RAW CAP_NET_ADMIN
+```
+
+Now and if you modify matterbridge.service after, run:
+
+```bash
+sudo systemctl daemon-reload
+sudo systemctl restart matterbridge.service
+```
+
+### Start Matterbridge
+
+```bash
+sudo systemctl start matterbridge
+```
+
+### Stop Matterbridge
+
+```bash
+sudo systemctl stop matterbridge
+```
+
+### Show Matterbridge status
+
+```bash
+sudo systemctl status matterbridge.service
+```
+
+### Enable Matterbridge to start automatically on boot
+
+```bash
+sudo systemctl enable matterbridge.service
+```
+
+### Disable Matterbridge from starting automatically on boot
+
+```bash
+sudo systemctl disable matterbridge.service
+```
+
+### View the log of Matterbridge in real time (this will show the log with colors)
+
+```bash
+sudo journalctl -u matterbridge.service -n 1000 -f --output cat
+```
+
+### Delete the logs older then 3 days (all of them not only the ones of Matterbridge!)
+
+Check the space used
+
+```bash
+sudo journalctl --disk-usage
+```
+
+remove all log older then 3 days
+
+```bash
+sudo journalctl --rotate
+sudo journalctl --vacuum-time=3d
+```
+
+## Prevent the journal logs to grow
+
+If you want to make the setting permanent to prevent the journal logs to grow too much, run
+
+```bash
+sudo nano /etc/systemd/journald.conf
+```
+
+add
+
+```bash
+Compress=yes            # Compress logs
+MaxRetentionSec=3days   # Keep logs for a maximum of 3 days.
+MaxFileSec=1day         # Rotate logs daily within the 3-day retention period.
+ForwardToSyslog=no      # Disable forwarding to syslog to prevent duplicate logging.
+SystemMaxUse=100M       # Limit persistent logs in /var/log/journal to 100 MB.
+RuntimeMaxUse=100M      # Limit runtime logs in /run/log/journal to 100 MB.
+```
+
+save it and run
+
+```bash
+sudo systemctl restart systemd-journald
+```
+
+## Verify that with your distro you can run sudo npm install -g matterbridge without the password
+
+Run the following command to verify if you can install Matterbridge globally without being prompted for a password:
+
+```bash
+sudo npm install -g matterbridge --omit=dev
+```
+
+If you are not prompted for a password, no further action is required.
+
+If that is not the case, open the sudoers file for editing using visudo
+
+```bash
+sudo visudo
+```
+
+verify the presence of of a line
+
+```
+@includedir /etc/sudoers.d
+```
+
+exit and create a configuration file for sudoers
+
+```bash
+sudo nano /etc/sudoers.d/matterbridge
+```
+
+add this line replacing USER with your user name (e.g. radxa ALL=(ALL) NOPASSWD: ALL)
+
+```
+<USER> ALL=(ALL) NOPASSWD: ALL
+```
+
+or if you prefers to only give access to npm without password try with (e.g. radxa ALL=(ALL) NOPASSWD: /usr/bin/npm)
+
+```
+<USER> ALL=(ALL) NOPASSWD: /usr/bin/npm
+```
+
+save the file and reload the settings with:
+
+```bash
+sudo chmod 0440 /etc/sudoers.d/matterbridge
+sudo visudo -c
+```
+
+Verify if you can install Matterbridge globally without being prompted for a password:
+
+```bash
+sudo npm install -g matterbridge --omit=dev
+```

package/dist/broadcastServer.js

@@ -34,6 +34,9 @@ export class BroadcastServer extends EventEmitter {
         this.log.debug(`*Received broadcast message: ${debugStringify(data)}`);
         this.emit('broadcast_message', data);
     }
+    broadcast(message) {
+        this.broadcastChannel.postMessage(message);
+    }
     request(message) {
         if (message.id === undefined) {
             message.id = this.getUniqueId();

package/dist/cli.js

@@ -2,7 +2,6 @@ if (process.argv.includes('--loader') || process.argv.includes('-loader'))
     console.log('\u001B[32mCli loaded.\u001B[40;0m');
 import { AnsiLogger } from 'node-ansi-logger';
 import { cliEmitter } from './cliEmitter.js';
-import { Matterbridge } from './matterbridge.js';
 import { hasParameter, hasAnyParameter } from './utils/commandLine.js';
 import { inspectError } from './utils/error.js';
 import { Tracker } from './utils/tracker.js';
@@ -67,11 +66,13 @@ async function shutdown() {
 }
 async function restart() {
     log.debug('Received restart event, loading...');
+    const { Matterbridge } = await import('./matterbridge.js');
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
 async function update() {
     log.debug('Received update event, updating...');
+    const { Matterbridge } = await import('./matterbridge.js');
     instance = await Matterbridge.loadInstance(true);
     registerHandlers();
 }
@@ -89,6 +90,7 @@ async function main() {
     if (hasParameter('inspect'))
         await startInspector();
     log.debug(`***Matterbridge.loadInstance(true) called`);
+    const { Matterbridge } = await import('./matterbridge.js');
     instance = await Matterbridge.loadInstance(true);
     log.debug(`***Matterbridge.loadInstance(true) exited`);
     if (!instance || instance.shutdown) {

package/dist/matterbridge.js

@@ -130,11 +130,11 @@ export class Matterbridge extends EventEmitter {
             this.log.debug(`**Received broadcast request ${CYAN}${msg.type}${db} from ${CYAN}${msg.src}${db}: ${debugStringify(msg)}${db}`);
             switch (msg.type) {
                 case 'get_log_level':
-                    this.server.respond({ ...msg, response: { success: true, level: this.log.logLevel } });
+                    this.server.respond({ ...msg, response: { success: true, logLevel: this.log.logLevel } });
                     break;
                 case 'set_log_level':
-                    this.log.logLevel = msg.params.level;
-                    this.server.respond({ ...msg, response: { success: true, level: this.log.logLevel } });
+                    this.log.logLevel = msg.params.logLevel;
+                    this.server.respond({ ...msg, response: { success: true, logLevel: this.log.logLevel } });
                     break;
                 default:
                     this.log.warn(`Unknown broadcast request ${CYAN}${msg.type}${wr} from ${CYAN}${msg.src}${wr}`);

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
   "name": "matterbridge",
-  "version": "3.3.4-dev-20251021-7651f57",
+  "version": "3.3.4-dev-20251022-681420c",
   "lockfileVersion": 3,
   "requires": true,
   "packages": {
     "": {
       "name": "matterbridge",
-      "version": "3.3.4-dev-20251021-7651f57",
+      "version": "3.3.4-dev-20251022-681420c",
       "license": "Apache-2.0",
       "dependencies": {
         "@matter/main": "0.15.6",
@@ -367,9 +367,9 @@
       "license": "MIT"
     },
     "node_modules/bare-events": {
-      "version": "2.8.0",
-      "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.8.0.tgz",
-      "integrity": "sha512-AOhh6Bg5QmFIXdViHbMc2tLDsBIRxdkIaIddPslJF9Z5De3APBScuqGP2uThXnIpqFrgoxMNC6km7uXNIMLHXA==",
+      "version": "2.8.1",
+      "resolved": "https://registry.npmjs.org/bare-events/-/bare-events-2.8.1.tgz",
+      "integrity": "sha512-oxSAxTS1hRfnyit2CL5QpAOS5ixfBjj6ex3yTNvXyY/kE719jQ/IjuESJBK2w5v4wwQRAHGseVJXx9QBYOtFGQ==",
       "license": "Apache-2.0",
       "peerDependencies": {
         "bare-abort-controller": "*"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "matterbridge",
-  "version": "3.3.4-dev-20251021-7651f57",
+  "version": "3.3.4-dev-20251022-681420c",
   "description": "Matterbridge plugin manager for Matter",
   "author": "https://github.com/Luligu",
   "license": "Apache-2.0",