Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@
[![downloads](https://badgen.net/npm/dt/mb-service)](https://www.npmjs.com/package/mb-service)
[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/michaelahern/mb-service)

A service management command-line utility for [Matterbridge](https://github.com/Luligu/matterbridge/), inspired by [Homebridge's](https://github.com/homebridge/homebridge-config-ui-x/wiki/Homebridge-Service-Command) `hb-service`.
A service management command-line utility for [Matterbridge](https://matterbridge.io/), inspired by [Homebridge's](https://github.com/homebridge/homebridge-config-ui-x/wiki/Homebridge-Service-Command) `hb-service`.

This command-line utility is primarily focused on supporting the macOS platform, as that is my primary platform at home, but it does have experimental support for Linux. The author of [Matterbridge](https://github.com/Luligu/matterbridge/) now has a dedicated utility for supporting Linux, [mb-service-linux](https://github.com/Luligu/mb-service-linux), which is a more mature option for Linux users.
This command-line utility is primarily focused on supporting the macOS platform, as that is my primary platform at home, but it does have experimental support for Linux. The author of [Matterbridge](https://matterbridge.io/) now has a dedicated utility for supporting Linux, [mb-service-linux](https://github.com/Luligu/mb-service-linux), which is a more mature option for Linux users.

```shell
% npm install -g matterbridge mb-service --omit=dev
% npm install -g matterbridge mb-service

% mb-service
Usage: mb-service <command> [options]
Expand Down Expand Up @@ -44,15 +44,15 @@ Manage Matterbridge in your browser at:

## How This Project Uses `launchd` on macOS

On macOS, `mb-service` manages the Matterbridge service using the native `launchd` system. It creates a Launch Daemon configuration file at `/Library/LaunchDaemons/com.matterbridge.plist`. This file tells `launchd` how to start, stop, and manage the Matterbridge process as a background service.
On macOS, `mb-service` manages the Matterbridge service using the native `launchd` system. It creates a Launch Daemon configuration file at `/Library/LaunchDaemons/io.matterbridge.plist`. This file tells `launchd` how to start, stop, and manage the Matterbridge process as a background service.

You can inspect the service status and configuration using:

```shell
% launchctl print system/com.matterbridge
system/com.matterbridge = {
% launchctl print system/io.matterbridge
system/io.matterbridge = {
active count = 1
path = /Library/LaunchDaemons/com.matterbridge.plist
path = /Library/LaunchDaemons/io.matterbridge.plist
type = LaunchDaemon
state = running

Expand All @@ -72,7 +72,7 @@ system/com.matterbridge = {
  environment = {
    PATH => /opt/homebrew/bin:/opt/homebrew/sbin:/usr/local/bin:/usr/bin:/bin:/usr/sbin:/sbin
    HOME => /Users/me
    XPC_SERVICE_NAME => com.matterbridge
    XPC_SERVICE_NAME => io.matterbridge
  }

...
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "mb-service",
"displayName": "Matterbridge Service Command",
"version": "0.6.0",
"version": "0.7.0",
"description": "A service management command-line utility for Matterbridge, inspired by Homebridge's 'hb-service'.",
"keywords": [
"matter",
Expand Down
Loading