Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ralyodio/node-startup
Startup script for Linux-based systems for running node app when rebooting using an /etc/init.d script.
https://github.com/ralyodio/node-startup
Last synced: about 23 hours ago
JSON representation
Startup script for Linux-based systems for running node app when rebooting using an /etc/init.d script.
- Host: GitHub
- URL: https://github.com/ralyodio/node-startup
- Owner: ralyodio
- License: mit
- Created: 2012-10-12T22:30:07.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2019-10-15T15:51:56.000Z (about 5 years ago)
- Last Synced: 2024-10-30T03:43:14.545Z (15 days ago)
- Language: Shell
- Homepage:
- Size: 41 KB
- Stars: 780
- Watchers: 32
- Forks: 169
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# node-startup
Startup script for Linux-based systems for running a [Node.js](http://nodejs.org/) app when rebooting, using an **/etc/init.d** script.
## Looking for a maintainer
If you use node-startup and would like to be a maintainer, send me a message.
## Installation
Clone the repo:
git clone https://github.com/chovy/node-startup.git
cd node-startup/init.d
Edit the **node-app** script with your settings from the **Configuration** section, then follow instructions in the **Running** section.
## Configuration
At the top of the **node-app** file, a few items are declared which are either passed to the Node.js app or used for general execution/management.
### Node.js Config
The items declared and passed to the Node.js application are:
- **NODE_ENV** - the type of environment - **development**, **production**, etc. - can be read by the application to do things conditionally (defaults to **"production"**)
- **PORT** - the port that the Node.js application should listen on - should be read by the application and used when starting its server (defaults to **"3000"**)
- **CONFIG_DIR** - used for [node-config](https://github.com/lorenwest/node-config) (defaults to **"$APP_DIR"**); is required, but should be kept as the default if not needed
### Execution Config
The items declared and used by the overall management of executing the application are:
- **NODE_EXEC** - location of the Node.js package executable - useful to set if the executable isn't on your PATH or isn't a service (defaults to `$(which node)`)
- **APP_DIR** - location of the Node.js application directory (defaults to **"/var/www/example.com"**)
- **NODE_APP** - filename of the Node.js application (defaults to **"app.js"**)
- **PID_DIR** - location of the PID directory (defaults to **"$APP_DIR/pid"**)
- **PID_FILE** - name of the PID file (defaults to **"$PID_DIR/app.pid"**)
- **LOG_DIR** - location of the log (Node.js application output) directory (defaults to **"$APP_DIR/log"**)
- **LOG_FILE** - name of the log file (defaults to **"$LOG_DIR/app.log"**)
- **APP_NAME** - name of the app for display and messaging purposes (defaults to **"Node app"**)
### Available Actions
The service exposes 4 actions:
- **start** - starts the Node.js application
- **stop** - stops the Node.js application
- **restart** - stops the Node.js application, then starts the Node.js application
- **status** - returns the current running status of the Node.js application (based on the PID file and running processes)
### Testing
Test that it all works:
/etc/init.d/node-app start
/etc/init.d/node-app status
/etc/init.d/node-app restart
/etc/init.d/node-app stop
Add **node-app** to the default runlevels:
# Debian
update-rc.d node-app defaults
# RHEL, --del to remove
chkconfig --add node-app
Finally, reboot to be sure the Node.js application starts automatically:
#### Force Action## Why node-startup?
When my VPS was rebooted occassionally by the hosting provider, my Node.js app was not coming back online after boot. This script can be used in **/etc/init.d**, which will allow rc.d to restart your app when the machine reboots without your knowledge.
If you are using [MongoDB](http://www.mongodb.org/), [Redis](http://redis.io/), or [Nginx](http://nginx.org/), you want to add those to your default run-level as well.
## Running
Copy the startup script **node-app** to your **/etc/init.d** directory:
sudo bash -l
cp ./init.d/node-app /etc/init.d/
In addition to the **start**, **stop**, and **restart** actions, a **--force** option can be added to the execution so that the following scenarios have the following outcomes:
- **start** - PID file exists but application is stopped -> removes PID file and starts the application
- **stop** - PID file exists but application is stopped -> removes PID file
- **restart** - either of the above scenarios occur
sudo reboot
## Supported OS
Tested with Debian 6.0, but it should work on other Linux systems that use startup scripts in **/etc/init.d** (Red Hat, CentOS, Gentoo, Ubuntu, etc.).
## LICENSE
(The MIT License)
[](https://bitdeli.com/free "Bitdeli Badge")