congregate
Version:
Node.js cluster on top of Flatiron CLI & Native cluster. Built with love!
82 lines (55 loc) • 2.42 kB
Markdown
_
| |
___ ___ _ __ __ _ _ __ ___ __ _ __ _| |_ ___
/ __/ _ \| '_ \ / _` | '__/ _ \/ _` |/ _` | __/ _ \
| (_| (_) | | | | (_| | | | __/ (_| | (_| | || __/
\___\___/|_| |_|\__, |_| \___|\__, |\__,_|\__\___|
__/ | __/ |
|___/ |___/
Node.js cluster on top of Flatiron CLI & Native cluster. Built with love!
## Getting Started.
To install, run the following command:
```javascript
npm install congregate -g
```
Once done, you can simply spin your shards by the following method:
```
congregate spin --app /var/www/myapp/index.js --shards 8
```
OR
```
CONG_APP_PATH=/var/www/myapp.js congregate spin --shards 8
```
```
--shards = You can put any number of instances you want. If undefined, then it will count your CPU cores and start same count processes.
--app = You need to pass absolute url to your application. Else, set your environment variable of CONG_APP_PATH
```
## TODO
Tons of more useful commands including:
- congregate restart
- congregate shards
- congregate shutdown
## List
The list command helps you figure out how many relevant shard processes are running over the desired instance. There are 2 ways to find them.
```
1 - Find By Title.
2 - Find By Port
```
If you know the desired port, all you have to do is to refer your `port` to congregate.
```
$ congregate list --port <port>
```
where `<port>` would be replaced with the port serving the application i.e `80`.
However, if you want to find by `process title`, you have to be aware that `congregate` spins with `congregate-*` where `*` is the PID.
```
$ congregate list --name congregate-
```
This will retrieve all processes which are running under the title of `congregate`.
## Shutdown
To shutdown your `congregate` shards running over a particular `port`, invoke the `shutdown` command with `--port` of parameter as argument.
```
$ congregate shutdown --port <port>
```
Here, `<port>` would be the port where your application is already running and you're willing to terminate.
## Author
Congregate has been initialized by [Hamza Waqas](http://twitter.com/HamzaWaqas) inspired from `Jonathan Warner`'s trick!