Skip to content

Latest commit

 

History

History
190 lines (131 loc) · 4.7 KB

README-SERVICE.md

File metadata and controls

190 lines (131 loc) · 4.7 KB
Raw

Matterbridge Logo   Matterbridge

npm version npm downloads Docker Version Docker Pulls Node.js CI

power by power by power by

Advanced configuration

Run matterbridge as a daemon with systemctl (Linux only)

First create the Matterbridge directories

This will create the required directories if they don't exist

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

sudo nano /etc/systemd/system/matterbridge.service

Add the following to this file, replacing twice (!) USER with your user name (e.g. WorkingDirectory=/home/pi/Matterbridge and User=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
RestartSec=10s
TimeoutStopSec=30s
User=<USER>

[Install]
WantedBy=multi-user.target

If you modify it after, then run:

sudo systemctl daemon-reload

Start Matterbridge

sudo systemctl start matterbridge

Stop Matterbridge

sudo systemctl stop matterbridge

Show Matterbridge status

sudo systemctl status matterbridge.service

Enable Matterbridge to start automatically on boot

sudo systemctl enable matterbridge.service

Disable Matterbridge from starting automatically on boot

sudo systemctl disable matterbridge.service

View the log of Matterbridge in real time (this will show the log with colors)

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

sudo journalctl --disk-usage

remove all log older then 3 days

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

sudo nano /etc/systemd/journald.conf

add

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

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:

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

sudo visudo

verify the presence of of a line

@includedir /etc/sudoers.d

exit and create a configuration file for sudoers

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:

sudo visudo -c