v0.4.0 (#9)

michaelahern · web-flow · commit 92ee158f0a81 · 2025-06-19T22:07:23.000-04:00
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -14,6 +14,7 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 24.x
+      - run: sudo chmod 440 /etc/sudoers.d/runner
       - run: sudo npm install -g matterbridge
       - run: npm ci
       - run: npm run build
@@ -29,6 +30,11 @@ jobs:
       - run: sleep 10
       - run: curl http://localhost:8283/
       - run: sudo mb-service uninstall
+      - run: matterbridge -factoryreset
+      - run: sudo mb-service install --frontend 8383
+      - run: sleep 10
+      - run: curl http://localhost:8383/
+      - run: sudo mb-service uninstall
   test-macos:
     runs-on: macos-latest
     steps:
@@ -57,3 +63,8 @@ jobs:
       - run: sleep 10
       - run: curl http://localhost:8283/
       - run: sudo mb-service uninstall
+      - run: matterbridge -factoryreset
+      - run: sudo mb-service install --frontend 8383
+      - run: sleep 10
+      - run: curl http://localhost:8383/
+      - run: sudo mb-service uninstall
diff --git a/README.md b/README.md
@@ -7,8 +7,6 @@
 
 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`.               
 
-_This is currently experimental and only supports Linux & macOS with a default configuration at the moment!_
-
 ```
 % npm install -g matterbridge mb-service
 
@@ -24,10 +22,14 @@ Commands:
   pid           Get the process id of the Matterbridge service
   tail          Tail the Matterbridge log file
 
-Options:
+Global Options:
   -h, --help
   -v, --version
 
+Install Options:
+  --frontend <port>
+  --ssl
+
 % sudo mb-service install
 Matterbridge Service Installed!
 Starting Matterbridge Service...
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "mb-service",
   "displayName": "Matterbridge Service Command",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A service management command-line utility for Matterbridge, inspired by Homebridge's 'hb-service'.",
   "keywords": [
     "matter",
diff --git a/src/linux.ts b/src/linux.ts
@@ -1,24 +1,17 @@
-import { execFileSync, execSync } from 'node:child_process';
-import { chownSync, existsSync, mkdirSync, readFileSync, unlinkSync, writeFileSync } from 'node:fs';
-import { UserInfo, userInfo } from 'node:os';
-import { resolve } from 'node:path';
+import { execFileSync } from 'node:child_process';
+import { chmodSync, existsSync, unlinkSync, writeFileSync } from 'node:fs';
+import { UserInfo } from 'node:os';
+
 import { PlatformCommands } from './platform.js';
 
 export class LinuxPlatform extends PlatformCommands {
     #systemdService = '/etc/systemd/system/matterbridge.service';
 
-    install(): void {
+    install(args: string[]): void {
         this.checkRoot();
-        const matterbridgePath = this.checkMatterbridgeInstalled();
-        const userInfo = this.#getUserInfo();
-
-        // Create Matterbridge Plugin and Storage directories
-        const matterbridgePluginPath = resolve(userInfo.homedir, 'Matterbridge');
-        this.#mkdirPath(matterbridgePluginPath, userInfo);
-
-        const matterbridgeStoragePath = resolve(userInfo.homedir, '.matterbridge');
-        this.#mkdirPath(matterbridgeStoragePath, userInfo);
-
+        const matterbridgeBinPath = this.checkMatterbridgeInstalled();
+        const matterbridgeStoragePath = this.mkdirMatterbridgePaths();
+        const userInfo = this.getUserInfo();
         this.#configSudoers(userInfo);
 
         const systemdServiceFileContents = [
@@ -28,7 +21,7 @@ export class LinuxPlatform extends PlatformCommands {
             '',
             '[Service]',
             'Type=simple',
-            `ExecStart=${matterbridgePath} -service`,
+            `ExecStart=${matterbridgeBinPath} ${args.join(' ')}`,
             `WorkingDirectory=${matterbridgeStoragePath}`,
             'StandardOutput=inherit',
             'StandardError=inherit',
@@ -48,7 +41,7 @@ export class LinuxPlatform extends PlatformCommands {
         execFileSync('systemctl', ['enable', 'matterbridge']);
 
         this.start();
-        this.postinstall();
+        this.postinstall(args);
     }
 
     uninstall(): void {
@@ -99,44 +92,15 @@ export class LinuxPlatform extends PlatformCommands {
     }
 
     #checkServiceInstalled(): void {
-        this.checkServiceInstalled(this.#systemdService);
-    }
-
-    #getUserInfo(): UserInfo<string> {
-        if (process.env.SUDO_USER && process.env.SUDO_UID && process.env.SUDO_GID) {
-            return {
-                username: process.env.SUDO_USER,
-                uid: Number.parseInt(process.env.SUDO_UID),
-                gid: Number.parseInt(process.env.SUDO_GID),
-                shell: null,
-                homedir: execSync(`eval echo ~"${process.env.SUDO_USER}"`).toString().trim()
-            };
-        }
-
-        return userInfo();
-    }
-
-    #mkdirPath(path: string, userInfo: UserInfo<string>): void {
-        mkdirSync(path, { recursive: true });
-        chownSync(path, userInfo.uid, userInfo.gid);
+        super.checkServiceInstalled(this.#systemdService);
     }
 
     #configSudoers(userInfo: UserInfo<string>) {
-        try {
-            const npmPath = execSync('which npm').toString().trim();
-            const sudoersEntry = `${userInfo.username}    ALL=(ALL) NOPASSWD:SETENV: ${npmPath}, /usr/bin/npm, /usr/local/bin/npm`;
-
-            const sudoers = readFileSync('/etc/sudoers', 'utf-8');
-            if (sudoers.includes(sudoersEntry)) {
-                return;
-            }
-
-            execSync(`echo '${sudoersEntry}' | sudo EDITOR='tee -a' visudo`);
-        }
-        catch (error: unknown) {
-            if (error instanceof Error) {
-                console.error('Failed to update /etc/sudoers:', error.message);
-            }
-        }
+        const npmPath = execFileSync('which', ['npm']).toString().trim();
+        const sudoersPath = '/etc/sudoers.d/matterbridge';
+        const sudoersEntry = `${userInfo.username} ALL=(ALL) NOPASSWD: ${npmPath}\n`;
+        writeFileSync(sudoersPath, sudoersEntry);
+        chmodSync(sudoersPath, 0o440);
+        execFileSync('visudo', ['-c']);
     }
 }
diff --git a/src/mac.ts b/src/mac.ts
@@ -1,6 +1,5 @@
-import { execFileSync, execSync } from 'node:child_process';
-import { chownSync, existsSync, mkdirSync, unlinkSync, writeFileSync } from 'node:fs';
-import { UserInfo, userInfo } from 'node:os';
+import { execFileSync } from 'node:child_process';
+import { existsSync, unlinkSync, writeFileSync } from 'node:fs';
 import { resolve } from 'node:path';
 import process from 'node:process';
 
@@ -9,29 +8,24 @@ import { PlatformCommands } from './platform.js';
 export class MacPlatform extends PlatformCommands {
     #plist = '/Library/LaunchDaemons/com.matterbridge.plist';
 
-    install(): void {
+    install(args: string[]): void {
         this.checkRoot();
-        const matterbridgePath = this.checkMatterbridgeInstalled();
-        const userInfo = this.#getUserInfo();
-
-        // Create Matterbridge Plugin and Storage directories
-        const matterbridgePluginPath = resolve(userInfo.homedir, 'Matterbridge');
-        this.#mkdirPath(matterbridgePluginPath, userInfo);
-
-        const matterbridgeStoragePath = resolve(userInfo.homedir, '.matterbridge');
-        this.#mkdirPath(matterbridgeStoragePath, userInfo);
+        const matterbridgeBinPath = this.checkMatterbridgeInstalled();
+        const matterbridgeStoragePath = this.mkdirMatterbridgePaths();
+        const userInfo = this.getUserInfo();
 
         // Check NPM global modules path permissions and change if necessary
-        const npmGlobalModulesPath = execSync('eval echo "$(npm prefix -g --silent)/lib/node_modules"').toString().trim();
+        const npmGlobalPrefix = execFileSync('npm', ['prefix', '-g', '--silent']).toString().trim();
+        const npmGlobalModulesPath = resolve(npmGlobalPrefix, 'lib', 'node_modules');
         try {
-            execSync(`eval test -w "${npmGlobalModulesPath}"`, {
+            execFileSync('test', ['-w', npmGlobalModulesPath], {
                 uid: userInfo.uid,
                 gid: userInfo.gid
             });
         }
         catch {
             try {
-                execSync(`chown -R ${userInfo.uid}:${userInfo.gid} "${npmGlobalModulesPath}"`);
+                execFileSync('chown', ['-R', `${userInfo.uid}:${userInfo.gid}`, npmGlobalModulesPath]);
             }
             catch {
                 console.error('User not able to write to the NPM Global Modules Path!');
@@ -50,8 +44,8 @@ export class MacPlatform extends PlatformCommands {
             `    <string>com.matterbridge</string>`,
             '    <key>ProgramArguments</key>',
             '    <array>',
-            `         <string>${matterbridgePath}</string>`,
-            `         <string>-service</string>`,
+            `         <string>${matterbridgeBinPath}</string>`,
+            ...args.map(arg => `         <string>${arg}</string>`),
             '    </array>',
             '    <key>KeepAlive</key>',
             '    <true/>',
@@ -77,7 +71,7 @@ export class MacPlatform extends PlatformCommands {
         writeFileSync(this.#plist, plistFileContents);
         console.info('Matterbridge Service Installed!');
         this.start();
-        this.postinstall();
+        this.postinstall(args);
     }
 
     uninstall(): void {
@@ -129,30 +123,11 @@ export class MacPlatform extends PlatformCommands {
     }
 
     tail(): void {
-        const matterbridgeStoragePath = resolve(this.#getUserInfo().homedir, '.matterbridge');
+        const matterbridgeStoragePath = resolve(this.getUserInfo().homedir, '.matterbridge');
         execFileSync('tail', ['-f', '-n', '32', `${matterbridgeStoragePath}/matterbridge.log`], { stdio: 'inherit' });
     }
 
     #checkServiceInstalled(): void {
         super.checkServiceInstalled(this.#plist);
     }
-
-    #getUserInfo(): UserInfo<string> {
-        if (process.env.SUDO_USER && process.env.SUDO_UID && process.env.SUDO_GID) {
-            return {
-                username: process.env.SUDO_USER,
-                uid: Number.parseInt(process.env.SUDO_UID),
-                gid: Number.parseInt(process.env.SUDO_GID),
-                shell: null,
-                homedir: execSync(`eval echo ~"${process.env.SUDO_USER}"`).toString().trim()
-            };
-        }
-
-        return userInfo();
-    }
-
-    #mkdirPath(path: string, userInfo: UserInfo<string>): void {
-        mkdirSync(path, { recursive: true });
-        chownSync(path, userInfo.uid, userInfo.gid);
-    }
 }
diff --git a/src/mb-service.ts b/src/mb-service.ts
@@ -12,7 +12,10 @@ async function main() {
         args: process.argv.slice(2),
         options: {
             help: { type: 'boolean', short: 'h' },
-            version: { type: 'boolean', short: 'v' } },
+            version: { type: 'boolean', short: 'v' },
+            frontend: { type: 'string' },
+            ssl: { type: 'boolean' }
+        },
         strict: false,
         allowPositionals: true
     });
@@ -42,10 +45,27 @@ async function main() {
             process.exit(2);
     }
 
+    const installArgs: string[] = ['-service'];
+
+    if (args.values.frontend) {
+        if (typeof args.values.frontend === 'string' && /^\d+$/.test(args.values.frontend)) {
+            installArgs.push('-frontend', args.values.frontend);
+        }
+        else {
+            console.error(`Specify a valid number in --frontend <port>`);
+            help();
+            process.exit(1);
+        }
+    }
+
+    if (args.values.ssl) {
+        installArgs.push('-ssl');
+    }
+
     const command = args.positionals[0];
     switch (command) {
         case 'install':
-            platformCommands.install();
+            platformCommands.install(installArgs);
             break;
         case 'uninstall':
             platformCommands.uninstall();
@@ -95,10 +115,14 @@ function help() {
     console.log('  pid           Get the process id of the Matterbridge service');
     console.log('  tail          Tail the Matterbridge log file');
     console.log('');
-    console.log('Options:');
+    console.log('Global Options:');
     console.log('  -h, --help');
     console.log('  -v, --version');
     console.log('');
+    console.log('Install Options:');
+    console.log('  --frontend <port>');
+    console.log('  --ssl');
+    console.log('');
 }
 
 main().catch(err => console.error(err));
diff --git a/src/platform.ts b/src/platform.ts

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "mb-service",`
`3`	`3`	`"displayName": "Matterbridge Service Command",`
`4`		`- "version": "0.3.0",`
	`4`	`+ "version": "0.4.0",`
`5`	`5`	`"description": "A service management command-line utility for Matterbridge, inspired by Homebridge's 'hb-service'.",`
`6`	`6`	`"keywords": [`
`7`	`7`	`"matter",`