From 0bad2f38992993f0da6aed84290a2a2ef724ddaf Mon Sep 17 00:00:00 2001 From: Matheus Sampaio Queiroga Date: Thu, 20 Oct 2022 02:15:30 +0000 Subject: [PATCH] Add examples and linux systemd/sysv --- example/linux/systemd/bdsd.service | 12 +++ example/linux/sysv/bdsd | 149 +++++++++++++++++++++++++++++ src/daemon.ts | 9 +- src/index.ts | 11 ++- 4 files changed, 177 insertions(+), 4 deletions(-) create mode 100644 example/linux/systemd/bdsd.service create mode 100755 example/linux/sysv/bdsd diff --git a/example/linux/systemd/bdsd.service b/example/linux/systemd/bdsd.service new file mode 100644 index 0000000..3fd2a4f --- /dev/null +++ b/example/linux/systemd/bdsd.service @@ -0,0 +1,12 @@ +[Unit] +Description=Daemon and CLI to maneger You Minecraft Server +After=network.target + +[Install] +WantedBy=multi-user.target + +[Service] +ExecStart=/bin/bdsd daemon --socket /var/run/bdsd.sock +ExecReload=/bin/rm -fv /var/run/bdsd.sock +Restart=on-failure +Type=notify \ No newline at end of file diff --git a/example/linux/sysv/bdsd b/example/linux/sysv/bdsd new file mode 100755 index 0000000..5d1ef01 --- /dev/null +++ b/example/linux/sysv/bdsd @@ -0,0 +1,149 @@ +#!/bin/sh +### BEGIN INIT INFO +# Provides: bdsd +# Required-Start: $local_fs $remote_fs $network $syslog $named +# Required-Stop: $local_fs $remote_fs $network $syslog $named +# Default-Start: 2 3 4 5 +# Default-Stop: 0 1 6 +# X-Interactive: true +# Short-Description: BDSd Daemon +# Description: Daemon and CLI to maneger You Minecraft Server +# This script will start the bdsd daemon +### END INIT INFO + +DESC="Daemon and CLI to maneger You Minecraft Server" +NAME=bdsd +DAEMON=/bin/$NAME +PATH=/sbin:/usr/sbin:/bin:/usr/bin +DAEMON_ARGS="daemon --socket /var/run/$NAME.sock" +PIDFILE=/var/run/$NAME.pid +SCRIPTNAME=/etc/init.d/$NAME + +# Exit if the package is not installed +[ -x "$DAEMON" ] || exit 0 + +# Read configuration variable file if it is present +[ -r /etc/default/$NAME ] && . /etc/default/$NAME + +# Load the VERBOSE setting and other rcS variables +. /lib/init/vars.sh + +# Define LSB log_* functions. +# Depend on lsb-base (>= 3.2-14) to ensure that this file is present +# and status_of_proc is working. +. /lib/lsb/init-functions + +# +# Function that starts the daemon/service +# +do_start() +{ + # Return + # 0 if daemon has been started + # 1 if daemon was already running + # 2 if daemon could not be started + start-stop-daemon --start --quiet --background --make-pidfile --pidfile $PIDFILE --exec $DAEMON --test > /dev/null || return 1 + start-stop-daemon --start --quiet --background --make-pidfile --pidfile $PIDFILE --exec $DAEMON -- $DAEMON_ARGS || return 2 + # Add code here, if necessary, that waits for the process to be ready + # to handle requests from services started subsequently which depend + # on this one. As a last resort, sleep for some time. +} + +# +# Function that stops the daemon/service +# +do_stop() +{ + # Return + # 0 if daemon has been stopped + # 1 if daemon was already stopped + # 2 if daemon could not be stopped + # other if a failure occurred + start-stop-daemon --stop --quiet --retry=TERM/30/KILL/5 --pidfile $PIDFILE --name $NAME + RETVAL="$?" + [ "$RETVAL" = 2 ] && return 2 + # Wait for children to finish too if this is a daemon that forks + # and if the daemon is only ever run from this initscript. + # If the above conditions are not satisfied then add some other code + # that waits for the process to drop all resources that could be + # needed by services started subsequently. A last resort is to + # sleep for some time. + start-stop-daemon --stop --quiet --oknodo --retry=0/30/KILL/5 --exec $DAEMON + [ "$?" = 2 ] && return 2 + # Many daemons don't delete their pidfiles when they exit. + rm -f $PIDFILE + return "$RETVAL" +} + +# +# Function that sends a SIGHUP to the daemon/service +# +do_reload() { + # + # If the daemon can reload its configuration without + # restarting (for example, when it is sent a SIGHUP), + # then implement that here. + # + start-stop-daemon --stop --signal 1 --quiet --pidfile $PIDFILE --name $NAME + return 0 +} + +case "$1" in + start) + [ "$VERBOSE" != no ] && log_daemon_msg "Starting $DESC" "$NAME" + do_start + case "$?" in + 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; + 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; + esac + ;; + stop) + [ "$VERBOSE" != no ] && log_daemon_msg "Stopping $DESC" "$NAME" + do_stop + case "$?" in + 0|1) [ "$VERBOSE" != no ] && log_end_msg 0 ;; + 2) [ "$VERBOSE" != no ] && log_end_msg 1 ;; + esac + ;; + status) + status_of_proc "$DAEMON" "$NAME" && exit 0 || exit $? + ;; + #reload|force-reload) + # + # If do_reload() is not implemented then leave this commented out + # and leave 'force-reload' as an alias for 'restart'. + # + #log_daemon_msg "Reloading $DESC" "$NAME" + #do_reload + #log_end_msg $? + #;; + restart|force-reload) + # + # If the "reload" option is implemented then remove the + # 'force-reload' alias + # + log_daemon_msg "Restarting $DESC" "$NAME" + do_stop + case "$?" in + 0|1) + do_start + case "$?" in + 0) log_end_msg 0 ;; + 1) log_end_msg 1 ;; # Old process is still running + *) log_end_msg 1 ;; # Failed to start + esac + ;; + *) + # Failed to stop + log_end_msg 1 + ;; + esac + ;; + *) + #echo "Usage: $SCRIPTNAME {start|stop|restart|reload|force-reload}" >&2 + echo "Usage: $SCRIPTNAME {start|stop|status|restart|force-reload}" >&2 + exit 3 + ;; +esac + +: \ No newline at end of file diff --git a/src/daemon.ts b/src/daemon.ts index be9b19b..0403974 100644 --- a/src/daemon.ts +++ b/src/daemon.ts @@ -1,7 +1,7 @@ import os from "node:os"; import express from "express"; import expressRateLimit from "express-rate-limit"; -import fs from "node:fs"; +import fs, { Mode } from "node:fs"; import fsPromise from "node:fs/promises"; import path from "node:path"; import crypto from "node:crypto"; @@ -17,7 +17,7 @@ const requests = new Prometheus.Counter({ labelNames: ["method", "from", "path"] }); -export default function app(options: {socket: string, port?: number, auth_key: boolean}) { +export default function app(options: {socket: string, port?: number, auth_key: boolean, chmod?: Mode}) { const app = express(); app.disable("x-powered-by").disable("etag"); app.use(express.json()); @@ -56,7 +56,10 @@ export default function app(options: {socket: string, port?: number, auth_key: b // Listen socks if (fs.existsSync(options.socket)) fs.rmSync(options.socket, {force: true}); - app.listen(options.socket, function () {console.info("Socket listen on '%s'", this.address());}); + app.listen(options.socket, async function () { + if (options.chmod) await fsPromise.chmod(options.socket, options.chmod); + console.info("Socket listen on '%s'", this.address()); + }); if (options.port) { const bdsdAuth = path.join(bdsCore.platformPathManeger.bdsRoot, "bdsd_auth.json"); app.use(async (req, res, next) => { diff --git a/src/index.ts b/src/index.ts index 1a9bfa6..61c568f 100644 --- a/src/index.ts +++ b/src/index.ts @@ -29,9 +29,18 @@ const yargs = Yargs(process.argv.slice(2)).help().version(false).alias("h", "hel type: "boolean", description: "Enable auth to HTTP/HTTPs API", default: false, + }).option("chmod", { + alias: "c", + type: "string", + default: "a+rw" }).parseSync(); process.title = `Minecraft Server Deamon, socket: ${options.socket}${options.port?", Port: "+options.port:""}`; - return daemon({socket: options.socket, auth_key: options.auth_key, port: options.port}); + return daemon({ + socket: options.socket, + auth_key: options.auth_key, + port: options.port, + chmod: options.chmod + }); }).command("server", "Maneger server in daemon", yargs => { return yargs.option("socket", { alias: "S",