Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 56 lines (35 sloc) 2.257 kb
518361b @mekwall Additional improvements and fixes
authored
1 [![Build Status](https://travis-ci.org/mekwall/overseer.png)](https://travis-ci.org/mekwall/overseer)
2
3 # overseer
4 An experimental cluster manager for nodejs
5
6 ## Features
7
8 * Automatic (re)forking of workers based on CPU cores
9 * Graceful restart and shutdown of workers
10 * Rolling restarts so there's no downtime
11 * Unifying `console` output to master process
12 * Beautiful logging to stdout that makes sense
13 * Watch for file system changes and restart/inform workers
14
15 ## Installation
16
17 npm install -g cluster-overseer
18
19 ## Basic usage
20
21 ### CLI
22
23 overseer -f 4 app
24
25 The above will fork 4 workers running `app.js` in the current directory.
26
27 ### Programmatic
28
29 require('cluster-overseer')('app.js', {
30 watch: true
31 }).run();
32
33 The above will fork as many workers as there are CPU cores and restart/inform these on any file system changes.
34
35 ## Wishlist
36
37 * Customizable file system watcher
38 * Deeper wrapping (sandboxing?) of worker processes
39 * Ability to override the port and host used when listening
40 * Customizable logging
41 * Alternative for `forever`
42 * Script to run as deamon
43 * Plugin system
44
45 ## License
46
47 Copyright (c) 2010-2013 Marcus Ekwall
48
49 The MIT License
50
51 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:
52
53 The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
54
55 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.
Something went wrong with that request. Please try again.