service-systemd

Purpose

Setup a node.js app as systemd service.

Sometimes you just want an "old style" daemon for simple services.
Sometimes you have to deploy in small devices (like a RaspberryPi) and you can't use Docker and all the band.

Installing

npm i -g service-systemd

Quick start

• Install service

  • pass settings in command line (see full documentation for all options)

  sudo service-systemd --add --service my-service --cwd /path/to/service --app main.js

  • pass all settings in JSON file

  sudo service-systemd --add --settings service.json

• Run the service

sudo service my-service start
sudo service my-service stop
sudo service my-service restart

• Uninstall service

sudo service-systemd --remove --service my-service

Programmatic usage

const service = require('service-systemd')

// add service

try {
  await service.add({
    name: 'my-service',
    cwd: '/path/to/app',
    app: 'main.js',
    env: {
      NODE_ENV: 'prod',
      PORT: 3002
    }
  })
  console.log('my-service installed')
} catch (error) {
  console.error('something wrong', error)
}

// remove service

try {
  await service.remove('my-service')
  console.log('my-service removed')
} catch (error) {
  console.error('something wrong', error)
}

Engines

App can run using engines: node (default), forever, pm2. With forever and pm2 you can use their options and tools.

Documentation

See documentation for further informations.

Changelog

See changelog.

TODO

v. 3.6

• test suite

v. 3.7

• show examples in --help
• get bin/node location by which node
• replace log-segment

v. 3.8

• add EnvironmentFile
• check if systemd is on board

v. 3.9

• rollback on error

v. 4.0

• replace commander with yargs and rename args

v. 4.1

• run multiple instances

Thanks to

Chris Lea for these articles

• https://nodesource.com/blog/running-your-node-js-app-with-systemd-part-1
• https://nodesource.com/blog/running-your-node-js-app-with-systemd-part-2

License

The MIT License (MIT)

Copyright (c) 2017-2019, braces lab

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.