pixl-boot 1.0.2 → 2.0.1

package/README.md

@@ -1,6 +1,6 @@
 # Overview
 
-`pixl-boot` will automatically register a startup service for your module on Linux and OS X, so your daemon will be started on a server reboot.  It is configured entirely out of your [package.json](https://docs.npmjs.com/files/package.json) file, and will handle all the details of registering an [init.d service](https://bash.cyberciti.biz/guide//etc/init.d) on Linux, or a [LaunchAgent/LaunchDaemon](https://developer.apple.com/library/content/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html) on OS X.
+`pixl-boot` will automatically register a startup service for your module on Linux and macOS, so your daemon will be started on a server reboot.  It is configured entirely out of your [package.json](https://docs.npmjs.com/files/package.json) file, and will handle all the details of registering a [systemd service](https://en.wikipedia.org/wiki/Systemd) on Linux, or a [LaunchAgent/LaunchDaemon](https://developer.apple.com/library/content/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html) on macOS.
 
 This is only designed for packages that are installed as the root user.
 
@@ -10,7 +10,7 @@ First, add the `pixl-boot` package in the `dependencies` section of your `packag
 
 ```js
 "dependencies": {
-	"pixl-boot": "^1.0.0"
+	"pixl-boot": "^2.0.0"
 }
 ```
 
@@ -22,18 +22,7 @@ Once you have your control script ready, link to it in the `bin` property in you
 "bin": "bin/control.sh",
 ```
 
-Finally, you need to have npm run `pixl-boot` on install and uninstall of your package, so that it has a chance to register and unregister your startup service.  Do this by adding `postinstall` and `preuninstall` properties in the `scripts` section of your `package.json` file:
-
-```js
-"scripts": {
-	"postinstall": "pixl-boot install",
-	"preuninstall": "pixl-boot uninstall"
-}
-```
-
-That's it!
-
-Alternatively, if you would rather the startup service not be installed automatically, and instead require additional user commands, change the `scripts` property names to something custom, like `boot` and `unboot`:
+Finally, you need to have npm run `pixl-boot` on install and uninstall of your package, so that it has a chance to register and unregister your startup service.  Do this by adding `boot` and `unboot` properties in the `scripts` section of your `package.json` file:
 
 ```js
 "scripts": {
@@ -42,9 +31,9 @@ Alternatively, if you would rather the startup service not be installed automati
 }
 ```
 
-Then your users would need to be instructed to type:
+Then your users need to be instructed to type:
 
-```
+```sh
 npm run boot
 npm run unboot
 ```
@@ -61,8 +50,8 @@ Add `--name` if you want to customize the startup service name.  This defaults t
 
 ```js
 "scripts": {
-	"postinstall": "pixl-boot install --name mycustomservice",
-	"preuninstall": "pixl-boot uninstall --name mycustomservice"
+	"boot": "pixl-boot install --name mycustomservice",
+	"unboot": "pixl-boot uninstall --name mycustomservice"
 }
 ```
 
@@ -72,8 +61,8 @@ Add `--company` if you want to customize the "company" (organization) name that
 
 ```js
 "scripts": {
-	"postinstall": "pixl-boot install --company MyCompany",
-	"preuninstall": "pixl-boot uninstall --company MyCompany"
+	"boot": "pixl-boot install --company MyCompany",
+	"unboot": "pixl-boot uninstall --company MyCompany"
 }
 ```
 
@@ -83,67 +72,37 @@ Add `--script` to specify a custom location of your shell control script, relati
 
 ```js
 "scripts": {
-	"postinstall": "pixl-boot install --script bin/my-control-script.sh"
-}
-```
-
-### linux_runlevels
-
-Add `--linux_runlevels` if you want to customize the [Linux init.d Runlevels](https://en.wikipedia.org/wiki/Runlevel#Linux) for when your service should actually start up.  This defaults to `3,4,5` denoting that your service should start at Runlevels 3, 4 and 5.  Obviously, this only has effect when installing on Linux operating systems.  You only need to add this to the `pixl-boot install` command.  Example:
-
-```js
-"scripts": {
-	"postinstall": "pixl-boot install --linux_runlevels 3,4,5"
-}
-```
-
-### redhat_start_priority
-
-Add `--redhat_start_priority` if you want to customize the [Linux init.d start priority](http://www.tldp.org/HOWTO/HighQuality-Apps-HOWTO/boot.html), which is a number from `01` to `99`.  This controls when your service should start up, in relation to all the other services on the machine.  This is only used by RedHat (CentOS / Fedora) flavors of Linux, and defaults to `99` (i.e. only start after everything else has).  You only need to add this to the `pixl-boot install` command.  Example:
-
-```js
-"scripts": {
-	"postinstall": "pixl-boot install --redhat_start_priority 99"
-}
-```
-
-### redhat_stop_priority
-
-Add `--redhat_stop_priority` if you want to customize the [Linux init.d stop priority](http://www.tldp.org/HOWTO/HighQuality-Apps-HOWTO/boot.html), which is a number from `01` to `99`.  This controls when your service should shut down, in relation to all the other services on the machine.  This is only used by RedHat (CentOS / Fedora) flavors of Linux, and defaults to `01` (i.e. stop first, before anything else).  You only need to add this to the `pixl-boot install` command.  Example:
-
-```js
-"scripts": {
-	"postinstall": "pixl-boot install --redhat_stop_priority 01"
+	"boot": "pixl-boot install --script bin/my-control-script.sh"
 }
 ```
 
-### debian_requires
+### linux_type
 
-Add `--debian_requires` if you want to customize the list of [Debian services](https://wiki.debian.org/LSBInitScripts) that should be started *before* your service.  For example, it is common to list things like `network` if your daemon requires network access.  This defaults to `local_fs remote_fs network syslog named`.  You only need to add this to the `pixl-boot install` command.  Example:
+Add `--linux_type` if you want to customize the Linux systemd service type.  It should be one of `simple`, `forking`, `oneshot`, `dbus`, `notify`, or `idle`.  It defaults to `forking`.  Example:
 
 ```js
 "scripts": {
-	"postinstall": "pixl-boot install --debian_requires local_fs remote_fs network syslog named"
+	"boot": "pixl-boot install --linux_type forking"
 }
 ```
 
-### debian_stoplevels
+### linux_after
 
-Add `--debian_stoplevels` if you want to customize the [Linux init.d Runlevels](https://en.wikipedia.org/wiki/Runlevel#Linux) for when your service should shut down.  This property is only used on Debian (Ubuntu) systems, and defaults to `0,1,6` denoting that your service should stop at Runlevels 0, 1 and 6.  You only need to add this to the `pixl-boot install` command.  Example:
+Add `--linux_after` if you want to specify a service that we must start *after*.  This defaults to `network.target`, denoting that the server should have basic networking started before trying to start our service.  Example:
 
 ```js
 "scripts": {
-	"postinstall": "pixl-boot install --debian_stoplevels 0,1,6"
+	"boot": "pixl-boot install --linux_after network.target"
 }
 ```
 
-### darwin_type
+### linux_wanted_by
 
-Add `--darwin_type` to customize the type of startup service you want on Darwin (OS X) systems.  Darwin supports two different types of startup services, [LaunchAgents and LaunchDaemons](https://developer.apple.com/library/content/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/CreatingLaunchdJobs.html).  In short, a `LaunchAgent` only starts up when a user log in, while a `LaunchDaemon` starts up earlier, before any user logs in.  The default type is `LaunchAgent`, but beware of changing this to `LaunchDaemon`, because this may start your service before things like network are available.  You only need to add this to the `pixl-boot install` command.  Example:
+Add `--linux_wanted_by` if you want to customize the `WantedBy` property in the systemd service file.  This defaults to `multi-user.target`.  Example:
 
 ```js
 "scripts": {
-	"postinstall": "pixl-boot install --darwin_type LaunchAgent"
+	"boot": "pixl-boot install --linux_wanted_by multi-user.target"
 }
 ```
 
@@ -178,17 +137,14 @@ require('fs').writeFileSync( "logs/pid.txt", process.pid );
 In addition to the command-line interface for `pixl-boot` there is also a JavaScript API you can use in your Node.js code, to install and/or uninstall startup services.  To use this, first call `require('pixl-boot)` to load the module, and the returned object exposes `install()` and `uninstall()` functions.  Both functions accept an options object, and a callback.  The options object accepts all the named command-line arguments, sans the hyphens.  Example use:
 
 ```js
-var boot = require('pixl-boot');
-var opts = {
+const boot = require('pixl-boot');
+let opts = {
 	name: "MyService",
 	company: "Node",
 	script: "bin/control.sh",
-	linux_runlevels: "3,4,5",
-	redhat_start_priority: "99",
-	redhat_stop_priority: "01",
-	debian_requires: "local_fs remote_fs network syslog named",
-	debian_stoplevels: "0,1,6",
-	darwin_type: "agent"
+	linux_type: "forking",
+	linux_after: "network.target",
+	linux_wanted_by: "multi-user.target"
 };
 
 // install startup service
@@ -204,9 +160,9 @@ boot.uninstall(opts, function(err) {
 
 # Licenses
 
-The MIT License
+**The MIT License**
 
-Copyright (c) 2016 Joseph Huckaby.
+Copyright (c) 2016 - 2024 Joseph Huckaby.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/boot.js

@@ -1,7 +1,8 @@
 // PixlBoot API
 // Install service to run on server startup
 // Works on Linux (RedHat / Ubuntu) and OS X
-// Copyright (c) 2016 Joseph Huckaby and PixlCore.com
+// Copyright (c) 2016 - 2019 Joseph Huckaby and PixlCore.com
+// MIT License
 
 var fs = require('fs');
 var cp = require('child_process');
@@ -13,12 +14,17 @@ module.exports = {
 		company: "Node",
 		script: "bin/control.sh",
 		
+		// systemd stuff (modern)
+		linux_type: "forking",
+		linux_after: "network.target",
+		linux_wanted_by: "multi-user.target",
+		
+		// init.d stuff (legacy)
 		linux_runlevels: "3,4,5",
 		redhat_start_priority: "99",
 		redhat_stop_priority: "01",
 		debian_requires: "local_fs remote_fs network syslog named",
-		debian_stoplevels: "0,1,6",
-		darwin_type: "agent"
+		debian_stoplevels: "0,1,6"
 	},
 	
 	install: function(args, callback) {
@@ -45,36 +51,87 @@ module.exports = {
 	},
 	
 	install_linux: function(args, callback) {
-		// install linux init.d service
+		// install linux systemd or init.d service
 		// first determine if we're on RedHat (CentOS / Fedora) or Debian (Ubuntu)
 		var self = this;
 		
 		args.service_name = args.name.toLowerCase().replace(/\W+/g, '');
-		args.service_file = "/etc/init.d/" + args.service_name;
 		
-		cp.exec("which chkconfig", function(err, stdout, stderr) {
+		cp.exec("which systemctl", function(err, stdout, stderr) {
 			if (err) {
-				// not redhat, but are we on debian?
-				cp.exec("which update-rc.d", function(err, stdout, stderr) {
+				// oops, try one of the legacy methods
+				cp.exec("which chkconfig", function(err, stdout, stderr) {
 					if (err) {
-						// not a supported linux platform
-						callback( new Error("Unsupported platform: No chkconfig nor update-rc.d found.") );
+						// not redhat, but are we on debian?
+						cp.exec("which update-rc.d", function(err, stdout, stderr) {
+							if (err) {
+								// not a supported linux platform
+								callback( new Error("Unsupported platform: No systemctl, chkconfig nor update-rc.d found.") );
+							}
+							else {
+								// we're on legacy debian
+								self.install_linux_debian(args, callback);
+							}
+						});
 					}
 					else {
-						// we're on debian
-						self.install_linux_debian(args, callback);
+						// we're on legacy redhat
+						self.install_linux_redhat(args, callback);
 					}
 				});
+				return;
 			}
 			else {
-				// we're on redhat
-				self.install_linux_redhat(args, callback);
+				// proceed with modern linux systemd
+				self.install_linux_systemd(args, callback);
 			}
 		});
 	},
 	
+	install_linux_systemd: function(args, callback) {
+		// install service on linux with systemd (systemctl)
+		args.service_file = "/etc/systemd/system/" + args.service_name + ".service";
+		var service_type = args.linux_type;
+		var unit_after = args.linux_after;
+		var wanted_by = args.linux_wanted_by;
+		
+		var service_contents = [
+			"[Unit]",
+			"Description=" + args.company + " " + args.name,
+			"After=" + unit_after,
+			"",
+			"[Service]",
+			"Type=" + service_type,
+			"ExecStart=" + args.script + " start",
+			"ExecStop=" + args.script + " stop",
+			"",
+			"[Install]",
+			"WantedBy=" + wanted_by
+		].join("\n") + "\n";
+		
+		// write init.d config file
+		fs.writeFile( args.service_file, service_contents, { mode: 0o644 }, function(err) {
+			if (err) return callback( new Error("Failed to write file: " + args.service_file + ": " + err.message) );
+			
+			// reload systemd
+			cp.exec("systemctl daemon-reload", function(err, stdout, stderr) {
+				if (err) callback( new Error("Failed to activate service: " + args.service_name + ": " + err.message) );
+				
+				// activate service
+				cp.exec("systemctl enable " + args.service_name + ".service", function(err, stdout, stderr) {
+					if (err) callback( new Error("Failed to activate service: " + args.service_name + ": " + err.message) );
+					
+					// success
+					callback();
+				}); // cp.exec
+			}); // cp.exec
+		}); // fs.writeFile
+	},
+	
 	install_linux_redhat: function(args, callback) {
 		// install service on redhat (chkconfig)
+		// (this is legacy, only used if systemd/systemctl is not on system)
+		args.service_file = "/etc/init.d/" + args.service_name;
 		var runlevels = args.linux_runlevels.toString().replace(/\D+/g, '');
 		var rh_start_priority = this.zeroPad(args.redhat_start_priority, 2);
 		var rh_stop_priority = this.zeroPad(args.redhat_stop_priority, 2);
@@ -106,6 +163,8 @@ module.exports = {
 	
 	install_linux_debian: function(args, callback) {
 		// install service on debian (update-rc.d)
+		// (this is legacy, only used if systemd/systemctl is not on system)
+		args.service_file = "/etc/init.d/" + args.service_name;
 		var runlevels = args.linux_runlevels.toString().replace(/\D+/g, '').split('').join(" ");
 		var deb_stoplevels = args.debian_stoplevels.toString().replace(/\D+/g, '').split('').join(" ");
 		var deb_requires = args.debian_requires.split(/\W+/).map( function(req) { return '$' + req; } ).join(" ");
@@ -115,7 +174,7 @@ module.exports = {
 			"",
 			"### BEGIN INIT INFO",
 			"# Provides:          " + args.service_name,
-			"# Required-Start:    " + args.debian_requires,
+			"# Required-Start:    " + deb_requires,
 			"# Required-Stop:     " + deb_requires,
 			"# Default-Start:     " + runlevels,
 			"# Default-Stop:      " + deb_stoplevels,
@@ -132,10 +191,12 @@ module.exports = {
 			
 			// activate service
 			cp.exec("update-rc.d " + args.service_name + " defaults", function(err, stdout, stderr) {
-				if (err) callback( new Error("Failed to activate service: " + args.service_name + ": " + err.message) );
-				
-				// success
-				callback();
+				if (err) {
+					callback( new Error("Failed to activate service: " + args.service_name + ": " + err.message) );
+				} else {
+					// success
+					callback();
+				}
 			}); // cp.exec
 		}); // fs.writeFile
 	},
@@ -144,7 +205,15 @@ module.exports = {
 		// install service as Darwin (OS X) agent or daemon
 		args.service_name = args.name.toLowerCase().replace(/\W+/g, '');
 		args.company_name = args.company.toLowerCase().replace(/\W+/g, '');
-		args.plist_file = "/Library/" + (args.darwin_type.match(/agent/i) ? 'LaunchAgents' : 'LaunchDaemons') + "/com." + args.company_name + "." + args.service_name + ".plist";
+		
+		if (process.getuid() == 0) {
+			// we're root, so install a LaunchDaemon
+			args.plist_file = "/Library/LaunchDaemons/com." + args.company_name + "." + args.service_name + ".plist";
+		}
+		else {
+			// we're a standard user, so install a user-level LaunchAgent
+			args.plist_file = process.env.HOME + "/Library/LaunchAgents/com." + args.company_name + "." + args.service_name + ".plist";
+		}
 		
 		var plist_contents = [
 			'<?xml version="1.0" encoding="UTF-8"?>',
@@ -169,14 +238,7 @@ module.exports = {
 		// write plist config file
 		fs.writeFile( args.plist_file, plist_contents, { mode: '644' }, function(err) {
 			if (err) return callback( new Error("Failed to write file: " + args.plist_file + ": " + err.message) );
-			
-			// must be root/wheel
-			cp.exec( "chown root:wheel " + args.plist_file, function(err) {
-				if (err) return callback( new Error("Failed to chmod plist file: " + args.plist_file + ": " + err.message) );
-				
-				// success
-				callback();
-			});
+			callback();
 		});
 	},
 	
@@ -192,19 +254,41 @@ module.exports = {
 		
 		args.service_name = args.name.toLowerCase().replace(/\W+/g, '');
 		args.company_name = args.company.toLowerCase().replace(/\W+/g, '');
-		args.service_file = "/etc/init.d/" + args.service_name;
 		
 		if (process.platform == 'linux') {
-			// chkconfig may or may not work, so ignore error
-			cp.exec( "chkconfig " + args.service_name + " off", function() {
-				cp.exec( "rm -f /etc/rc*.d/*" + args.service_name, function() {
+			// try every which way to remove service
+			args.service_file = "/etc/systemd/system/" + args.service_name + ".service";
+			
+			fs.access( args.service_file, function(err) {
+				if (err) {
+					// nope, try legacy methods
+					args.service_file = "/etc/init.d/" + args.service_name;
+					
+					// chkconfig may or may not work, so ignore error
+					cp.exec( "chkconfig " + args.service_name + " off", function() {
+						cp.exec( "rm -f /etc/rc*.d/*" + args.service_name, function() {
+							fs.unlink( args.service_file, callback );
+						} );
+					} );
+					return;
+				}
+				
+				// looks like we have a systemd service
+				cp.exec( "systemctl disable " + args.service_name + ".service", function() {
 					fs.unlink( args.service_file, callback );
 				} );
-			} );
+			}); // fs.access
 		}
 		else {
 			// non-linux (darwin)
-			args.plist_file = "/Library/" + (args.darwin_type.match(/agent/i) ? 'LaunchAgents' : 'LaunchDaemons') + "/com." + args.company_name + "." + args.service_name + ".plist";
+			if (process.getuid() == 0) {
+				// we're root, so uninstall the LaunchDaemon
+				args.plist_file = "/Library/LaunchDaemons/com." + args.company_name + "." + args.service_name + ".plist";
+			}
+			else {
+				// we're a standard user, so uninstall the user-level LaunchAgent
+				args.plist_file = process.env.HOME + "/Library/LaunchAgents/com." + args.company_name + "." + args.service_name + ".plist";
+			}
 			
 			fs.unlink( args.plist_file, callback );
 		}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "pixl-boot",
-  "version": "1.0.2",
+  "version": "2.0.1",
   "description": "Register your service to launch on server startup (Linux / OS X).",
   "author": "Joseph Huckaby <jhuckaby@gmail.com>",
   "homepage": "https://github.com/jhuckaby/pixl-boot",
@@ -22,7 +22,9 @@
     "linux",
     "darwin",
     "init.d",
-    "launchd"
+    "launchd",
+    "systemd",
+    "systemctl"
   ],
   "dependencies": {
     "pixl-cli": "^1.0.0"

package/.npmignore

@@ -1,5 +0,0 @@
-.gitignore
-node_modules/
-conf/config.json
-test/test.log
-logs/