matterbridge 3.2.1-dev-20250807-1aeddad → 3.2.1-dev-20250811-8836577

package/docs/README-SERVICE.md

@@ -1,212 +0,0 @@
-# <img src="frontend/public/matterbridge.svg" alt="Matterbridge Logo" width="64px" height="64px">&nbsp;&nbsp;&nbsp;Matterbridge systemd configuration
-
-[![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)
-
-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
-
-This will create the required directories if they don't exist
-
-```bash
-cd ~
-mkdir -p ./Matterbridge
-mkdir -p ./.matterbridge
-sudo chown -R $USER:$USER ./Matterbridge ./.matterbridge
-```
-
-### 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 3 times (!) USER with your user name (e.g. WorkingDirectory=/home/pi/Matterbridge, User=pi and Group=pi):
-
-You may need to adapt the configuration to your setup:
-
-- execStart on some linux distribution can also be ExecStart==/usr/bin/matterbridge -service
-
-```
-[Unit]
-Description=matterbridge
-After=network-online.target
-
-[Service]
-Type=simple
-ExecStart=matterbridge -service
-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
-```
-
-If you modify matterbridge.service after, then 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
-```
-
-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
-```