@zappinginc/zm2 6.0.14

package/lib/completion.sh

@@ -0,0 +1,40 @@
+###-begin-pm2-completion-###
+### credits to npm for the completion file model
+#
+# Installation: pm2 completion >> ~/.bashrc  (or ~/.zshrc)
+#
+
+COMP_WORDBREAKS=${COMP_WORDBREAKS/=/}
+COMP_WORDBREAKS=${COMP_WORDBREAKS/@/}
+export COMP_WORDBREAKS
+
+if type complete &>/dev/null; then
+  _pm2_completion () {
+    local si="$IFS"
+    IFS=$'\n' COMPREPLY=($(COMP_CWORD="$COMP_CWORD" \
+                           COMP_LINE="$COMP_LINE" \
+                           COMP_POINT="$COMP_POINT" \
+                           pm2 completion -- "${COMP_WORDS[@]}" \
+                           2>/dev/null)) || return $?
+    IFS="$si"
+  }
+  complete -o default -F _pm2_completion pm2
+elif type compctl &>/dev/null; then
+  _pm2_completion () {
+    local cword line point words si
+    read -Ac words
+    read -cn cword
+    let cword-=1
+    read -l line
+    read -ln point
+    si="$IFS"
+    IFS=$'\n' reply=($(COMP_CWORD="$cword" \
+                       COMP_LINE="$line" \
+                       COMP_POINT="$point" \
+                       pm2 completion -- "${words[@]}" \
+                       2>/dev/null)) || return $?
+    IFS="$si"
+  }
+  compctl -K _pm2_completion + -f + pm2
+fi
+###-end-pm2-completion-###

package/lib/motd

@@ -0,0 +1,36 @@
+
+                        -------------
+
+__/\\\\\\\\\\\\\____/\\\\____________/\\\\____/\\\\\\\\\_____
+ _\/\\\/////////\\\_\/\\\\\\________/\\\\\\__/\\\///////\\\___
+  _\/\\\_______\/\\\_\/\\\//\\\____/\\\//\\\_\///______\//\\\__
+   _\/\\\\\\\\\\\\\/__\/\\\\///\\\/\\\/_\/\\\___________/\\\/___
+    _\/\\\/////////____\/\\\__\///\\\/___\/\\\________/\\\//_____
+     _\/\\\_____________\/\\\____\///_____\/\\\_____/\\\//________
+      _\/\\\_____________\/\\\_____________\/\\\___/\\\/___________
+       _\/\\\_____________\/\\\_____________\/\\\__/\\\\\\\\\\\\\\\_
+        _\///______________\///______________\///__\///////////////__
+
+
+                          Runtime Edition
+
+        ZM2 is a Production Process Manager for Node.js applications
+                     with a built-in Load Balancer.
+
+                Start and Daemonize any application:
+                $ zm2 start app.js
+
+                Load Balance 4 instances of api.js:
+                $ zm2 start api.js -i 4
+
+                Monitor in production:
+                $ zm2 monitor
+
+                Make zm2 auto-boot at server restart:
+                $ zm2 startup
+
+                To go further checkout:
+                http://pm2.io/
+
+
+                        -------------

package/lib/templates/Dockerfiles/Dockerfile-java.tpl

@@ -0,0 +1,7 @@
+FROM anapsix/alpine-java:latest
+
+RUN apk update && apk add git && rm -rf /var/cache/apk/*
+RUN npm install pm2@next -g
+RUN mkdir -p /var/app
+
+WORKDIR /var/app

package/lib/templates/Dockerfiles/Dockerfile-nodejs.tpl

@@ -0,0 +1,8 @@
+FROM keymetrics/pm2:latest
+
+RUN mkdir -p /var/app
+
+WORKDIR /var/app
+
+COPY ./package.json /var/app
+RUN npm install

package/lib/templates/Dockerfiles/Dockerfile-ruby.tpl

@@ -0,0 +1,7 @@
+FROM anapsix/alpine-ruby:latest
+
+RUN apk update && apk add git && rm -rf /var/cache/apk/*
+RUN npm install pm2@next -g
+RUN mkdir -p /var/app
+
+WORKDIR /var/app

package/lib/templates/ecosystem-es.tpl

@@ -0,0 +1,24 @@
+const config = {
+  apps : [{
+    script: 'index.js',
+    watch: '.'
+  }, {
+    script: './service-worker/',
+    watch: ['./service-worker']
+  }],
+
+  deploy : {
+    production : {
+      user : 'SSH_USERNAME',
+      host : 'SSH_HOSTMACHINE',
+      ref  : 'origin/master',
+      repo : 'GIT_REPOSITORY',
+      path : 'DESTINATION_PATH',
+      'pre-deploy-local': '',
+      'post-deploy' : 'npm install && pm2 reload ecosystem.config.js --env production',
+      'pre-setup': ''
+    }
+  }
+};
+
+export default config;

package/lib/templates/ecosystem-simple-es.tpl

@@ -0,0 +1,8 @@
+const config = {
+  apps : [{
+    name   : "app1",
+    script : "./app.js"
+  }]
+}
+
+export default config;

package/lib/templates/ecosystem-simple.tpl

@@ -0,0 +1,6 @@
+module.exports = {
+  apps : [{
+    name   : "app1",
+    script : "./app.js"
+  }]
+}

package/lib/templates/ecosystem.tpl

@@ -0,0 +1,22 @@
+module.exports = {
+  apps : [{
+    script: 'index.js',
+    watch: '.'
+  }, {
+    script: './service-worker/',
+    watch: ['./service-worker']
+  }],
+
+  deploy : {
+    production : {
+      user : 'SSH_USERNAME',
+      host : 'SSH_HOSTMACHINE',
+      ref  : 'origin/master',
+      repo : 'GIT_REPOSITORY',
+      path : 'DESTINATION_PATH',
+      'pre-deploy-local': '',
+      'post-deploy' : 'npm install && zm2 reload ecosystem.config.js --env production',
+      'pre-setup': ''
+    }
+  }
+};

package/lib/templates/init-scripts/launchd.tpl

@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+  <dict>
+	  <key>Label</key>
+	  <string>com.ZM2</string>
+	  <key>UserName</key>
+	  <string>%USER%</string>
+    <key>KeepAlive</key>
+    <true/>
+	  <key>ProgramArguments</key>
+	  <array>
+		  <string>/bin/sh</string>
+		  <string>-c</string>
+		  <string>%PM2_PATH% resurrect</string>
+	  </array>
+	  <key>RunAtLoad</key>
+	  <true/>
+	  <key>OnDemand</key>
+	  <false/>
+	  <key>LaunchOnlyOnce</key>
+	  <true/>
+	  <key>EnvironmentVariables</key>
+    <dict>
+      <key>PATH</key>
+      <string>%NODE_PATH%</string>
+      <key>PM2_HOME</key>
+      <string>%HOME_PATH%</string>
+    </dict>
+	  <key>StandardErrorPath</key>
+	  <string>/tmp/com.ZM2.err</string>
+	  <key>StandardOutPath</key>
+	  <string>/tmp/com.ZM2.out</string>
+  </dict>
+</plist>

package/lib/templates/init-scripts/openrc.tpl

@@ -0,0 +1,52 @@
+#!/sbin/openrc-run
+# Copyright 2013-2022 the ZM2 project authors. All rights reserved.
+# Init script automatically generated by zm2 startup
+
+description="Production process manager for Node.js apps with a built-in load balancer."
+
+extra_started_commands="reload"
+
+PM2="%PM2_PATH%"
+user=${PM2_USER:-%USER%}
+export PM2_HOME=$(eval echo ~${user})"/.pm2/"
+# Options for start-stop-daemon (default start function)
+command=${PM2}
+command_user=${user}
+command_args="resurrect"
+pidfile=${PM2_HOME}/zm2.pid
+
+run_pm2_as_user() {
+	einfo "${PM2} $@"
+	eval su -l ${user} -c \'${PM2} $@\'
+}
+
+depend() {
+	need net
+	need localmount
+	after bootmisc
+}
+
+start_post() {
+	if [ "${user}" == "root" ]; then
+		ewarn "ZM2: Better run this daemon as a non root user. To set this user create"
+		ewarn "ZM2: /etc/conf.d/zm2 file and define 'PM2_USER=user' there."
+		ewarn "ZM2: Note user MUST have home directory for ZM2 logs/state/etc..."
+	fi
+	einfo "ZM2: Process Manager started. To start services run:"
+	einfo "ZM2: # su -l ${user} -c '$PM2 start /path/to/app'"
+}
+
+stop() {
+	ebegin "Stopping ZM2 process manager..."
+	run_pm2_as_user dump
+	run_pm2_as_user kill
+	eend $?
+}
+
+reload() {
+	ebegin "Reloading zm2"
+	run_pm2_as_user reload all
+	eend $?
+}
+
+# vim: ts=4

package/lib/templates/init-scripts/pm2-init-amazon.sh

@@ -0,0 +1,86 @@
+#!/bin/bash
+#
+# zm2 Process manager for NodeJS
+#
+# chkconfig: 345 80 20
+#
+# description: ZM2 next gen process manager for Node.js
+# processname: zm2
+#
+### BEGIN INIT INFO
+# Provides:          zm2
+# Required-Start: $local_fs $remote_fs
+# Required-Stop: $local_fs $remote_fs
+# Should-Start: $network
+# Should-Stop: $network
+# Default-Start:        2 3 4 5
+# Default-Stop:         0 1 6
+# Short-Description: ZM2 init script
+# Description: ZM2 is the next gen process manager for Node.js
+### END INIT INFO
+
+NAME=zm2
+PM2=%PM2_PATH%
+USER=%USER%
+
+export PATH=%NODE_PATH%:$PATH
+export PM2_HOME="%HOME_PATH%"
+
+lockfile="/var/lock/subsys/zm2-init.sh"
+
+super() {
+    su - $USER -c "PATH=$PATH; PM2_HOME=$PM2_HOME $*"
+}
+
+start() {
+    echo "Starting $NAME"
+    super $PM2 resurrect
+    retval=$?
+    [ $retval -eq 0 ] && touch $lockfile
+}
+
+stop() {
+    echo "Stopping $NAME"
+    super $PM2 kill
+    rm -f $lockfile
+}
+
+restart() {
+    echo "Restarting $NAME"
+    stop
+    start
+}
+
+reload() {
+    echo "Reloading $NAME"
+    super $PM2 reload all
+}
+
+status() {
+    echo "Status for $NAME:"
+    super $PM2 list
+    RETVAL=$?
+}
+
+case "$1" in
+    start)
+        start
+        ;;
+    stop)
+        stop
+        ;;
+    status)
+        status
+        ;;
+    restart)
+        restart
+        ;;
+    reload)
+        reload
+        ;;
+    *)
+        echo "Usage: {start|stop|status|restart|reload}"
+        exit 1
+        ;;
+esac
+exit $RETVAL

package/lib/templates/init-scripts/rcd-openbsd.tpl

@@ -0,0 +1,41 @@
+#!/bin/sh
+#
+# from /usr/ports/infrastructure/templates/rc.template
+
+daemon="/usr/local/bin/zm2"
+#daemon_flags=
+#daemon_rtable=0
+#daemon_timeout="30"
+daemon_user="%USER%"
+
+. /etc/rc.d/rc.subr
+
+pexp="node: ZM2.*God Daemon.*"
+#rc_bg= # (undefined)
+#rc_reload= # (undefined)
+#rc_usercheck=YES
+
+#rc_pre() {
+#}
+
+rc_start() {
+	${rcexec} "${daemon} ${daemon_flags} resurrect"
+}
+
+#rc_check() {
+#	pgrep -T "${daemon_rtable}" -q -xf "${pexp}"
+#}
+
+rc_reload() {
+	${rcexec} "${daemon} reload all"
+	#pkill -HUP -T "${daemon_rtable}" -xf "${pexp}"
+}
+
+#rc_stop() {
+#	pkill -T "${daemon_rtable}" -xf "${pexp}"
+#}
+
+#rc_post() {
+#}
+
+rc_cmd $1

package/lib/templates/init-scripts/rcd.tpl

@@ -0,0 +1,44 @@
+#!/bin/sh
+
+# PROVIDE: zm2
+# REQUIRE: LOGIN
+# KEYWORD: shutdown
+
+. /etc/rc.subr
+
+name="%SERVICE_NAME%"
+rcvar="%SERVICE_NAME%_enable"
+
+start_cmd="zm2_start"
+stop_cmd="zm2_stop"
+reload_cmd="zm2_reload"
+status_cmd="zm2_status"
+extra_commands="reload status"
+
+zm2()
+{
+  env PATH="$PATH:%NODE_PATH%" PM2_HOME="%HOME_PATH%" su -m "%USER%" -c "%PM2_PATH% $*"
+}
+
+zm2_start()
+{
+  zm2 resurrect
+}
+
+zm2_stop()
+{
+  zm2 kill
+}
+
+zm2_reload()
+{
+  zm2 reload all
+}
+
+zm2_status()
+{
+  zm2 list
+}
+
+load_rc_config $name
+run_rc_command "$1"

package/lib/templates/init-scripts/smf.tpl

@@ -0,0 +1,43 @@
+<?xml version="1.0"?>
+<!DOCTYPE service_bundle SYSTEM "/usr/share/lib/xml/dtd/service_bundle.dtd.1">
+<service_bundle type="manifest" name="%SERVICE_NAME%">
+    <service name="application/%SERVICE_NAME%" type="service" version="1">
+        <create_default_instance enabled="false"/>
+        <single_instance/>
+        
+        <dependency name="network" grouping="require_all" restart_on="error" type="service">
+            <service_fmri value="svc:/milestone/network:default"/>
+        </dependency>
+        
+        <dependency name="filesystem" grouping="require_all" restart_on="error" type="service">
+            <service_fmri value="svc:/system/filesystem/local"/>
+        </dependency>
+        
+        <method_context>
+            <method_environment>
+                <envvar name='PATH' value="%NODE_PATH%:/usr/local/sbin:/usr/local/bin:/opt/local/sbin:/opt/local/bin:/usr/sbin:/usr/bin:/sbin"/>
+                <envvar name='PM2_HOME' value="%HOME_PATH%"/>
+            </method_environment>
+        </method_context>
+
+        <exec_method type="method" name="start" exec="%PM2_PATH% resurrect" timeout_seconds="60"/>
+        <exec_method type="method" name="refresh" exec="%PM2_PATH% reload all" timeout_seconds="60"/>
+        <exec_method type="method" name="stop" exec="%PM2_PATH% kill" timeout_seconds="60"/>
+        
+        <property_group name="startd" type="framework">
+            <propval name="duration" type="astring" value="contract"/>
+            <propval name="ignore_error" type="astring" value="core,signal"/>
+        </property_group>
+        
+        <property_group name="application" type="application"></property_group>
+        <stability value="Evolving"/>
+        
+        <template>
+            <common_name>
+                <loctext xml:lang="C">
+                    ZM2 process manager
+                </loctext>
+            </common_name>
+        </template>
+    </service>
+</service_bundle>

package/lib/templates/init-scripts/systemd-online.tpl

@@ -0,0 +1,22 @@
+[Unit]
+Description=ZM2 process manager
+Documentation=https://pm2.keymetrics.io/
+After=network-online.target
+Restart=on-failure
+
+[Service]
+Type=forking
+User=%USER%
+LimitNOFILE=infinity
+LimitNPROC=infinity
+LimitCORE=infinity
+Environment=PATH=%NODE_PATH%:/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin
+Environment=PM2_HOME=%HOME_PATH%
+PIDFile=%HOME_PATH%/zm2.pid
+
+ExecStart=%PM2_PATH% resurrect
+ExecReload=%PM2_PATH% reload all
+ExecStop=%PM2_PATH% kill
+
+[Install]
+WantedBy=network-online.target

package/lib/templates/init-scripts/systemd.tpl

@@ -0,0 +1,22 @@
+[Unit]
+Description=ZM2 process manager
+Documentation=https://pm2.keymetrics.io/
+After=network.target
+
+[Service]
+Type=forking
+User=%USER%
+LimitNOFILE=infinity
+LimitNPROC=infinity
+LimitCORE=infinity
+Environment=PATH=%NODE_PATH%:/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin
+Environment=PM2_HOME=%HOME_PATH%
+PIDFile=%HOME_PATH%/zm2.pid
+Restart=on-failure
+
+ExecStart=%PM2_PATH% resurrect
+ExecReload=%PM2_PATH% reload all
+ExecStop=%PM2_PATH% kill
+
+[Install]
+WantedBy=multi-user.target

package/lib/templates/init-scripts/upstart.tpl

@@ -0,0 +1,103 @@
+#!/bin/bash
+### BEGIN INIT INFO
+# Provides:        zm2
+# Required-Start:  $local_fs $remote_fs $network
+# Required-Stop:   $local_fs $remote_fs $network
+# Default-Start:   2 3 4 5
+# Default-Stop:    0 1 6
+# Short-Description: ZM2 Init script
+# Description: ZM2 process manager
+### END INIT INFO
+
+NAME=zm2
+PM2=%PM2_PATH%
+USER=%USER%
+DEFAULT=/etc/default/$NAME
+
+export PATH=%NODE_PATH%:$PATH
+export PM2_HOME="%HOME_PATH%"
+
+# The following variables can be overwritten in $DEFAULT
+
+# maximum number of open files
+MAX_OPEN_FILES=
+
+# overwrite settings from default file
+if [ -f "$DEFAULT" ]; then
+    . "$DEFAULT"
+fi
+
+# set maximum open files if set
+if [ -n "$MAX_OPEN_FILES" ]; then
+    ulimit -n $MAX_OPEN_FILES
+fi
+
+get_user_shell() {
+    local shell
+    shell=$(getent passwd "${1:-$(whoami)}" | cut -d: -f7 | sed -e 's/[[:space:]]*$//')
+
+    if [[ $shell == *"/sbin/nologin" ]] || [[ $shell == "/bin/false" ]] || [[ -z "$shell" ]];
+    then
+      shell="/bin/bash"
+    fi
+
+    echo "$shell"
+}
+
+super() {
+    local shell
+    shell=$(get_user_shell $USER)
+    su - "$USER" -s "$shell" -c "PATH=$PATH; PM2_HOME=$PM2_HOME $*"
+}
+
+start() {
+    echo "Starting $NAME"
+    super $PM2 resurrect
+}
+
+stop() {
+    super $PM2 kill
+}
+
+restart() {
+    echo "Restarting $NAME"
+    stop
+    start
+}
+
+reload() {
+    echo "Reloading $NAME"
+    super $PM2 reload all
+}
+
+status() {
+    echo "Status for $NAME:"
+    super $PM2 list
+    RETVAL=$?
+}
+
+case "$1" in
+    start)
+        start
+        ;;
+    stop)
+        stop
+        ;;
+    status)
+        status
+        ;;
+    restart)
+        restart
+        ;;
+    reload)
+        reload
+        ;;
+    force-reload)
+        reload
+        ;;
+    *)
+        echo "Usage: {start|stop|status|restart|reload|force-reload}"
+        exit 1
+        ;;
+esac
+exit $RETVAL

package/lib/templates/logrotate.d/pm2

@@ -0,0 +1,10 @@
+%HOME_PATH%/zm2.log %HOME_PATH%/logs/*.log {
+        rotate 12
+        weekly
+        missingok
+        notifempty
+        compress
+        delaycompress
+        copytruncate
+        create 0640 %USER% %USER%
+}

package/lib/templates/sample-apps/http-server/README.md

@@ -0,0 +1,14 @@
+
+# Basic HTTP Server and Cluster mode
+
+In this boilerplate it will start an http server in cluster mode.
+
+You can check the content of the ecosystem.config.js on how to start mutliple instances of the same HTTP application in order to get the most from your working system.
+
+## Via CLI
+
+Via CLI you can start any HTTP/TCP application in cluster mode with:
+
+```bash
+$ pm2 start api.js -i max
+```

package/lib/templates/sample-apps/http-server/api.js

@@ -0,0 +1,9 @@
+
+var http = require('http');
+
+var server = http.createServer(function(req, res) {
+  res.writeHead(200);
+  res.end('hey');
+}).listen(process.env.PORT || 8000, function() {
+  console.log('App listening on port %d', server.address().port);
+});

package/lib/templates/sample-apps/http-server/ecosystem.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  apps : [{
+    name: 'API',
+    script: 'api.js',
+    instances: 4,
+    max_memory_restart: '1G',
+    env: {
+      NODE_ENV: 'development'
+    },
+    env_production: {
+      NODE_ENV: 'production'
+    }
+  }]
+};