cluster manager for egg
Clone or download
Latest commit a14c273 Sep 17, 2018

README.md

egg-cluster

NPM version build status Test coverage David deps Known Vulnerabilities npm download

Cluster Manager for Egg


Install

$ npm i egg-cluster --save

Usage

const startCluster = require('egg-cluster').startCluster;
startCluster({
  baseDir: '/path/to/app',
  framework: '/path/to/framework',
});

You can specify a callback that will be invoked when application has started. However, master process will exit when catch an error.

startCluster(options, () => {
  console.log('started');
});

Options

Param Type Description
baseDir String directory of application
framework String specify framework that can be absolute path or npm package
plugins Object plugins for unittest
workers Number numbers of app workers
sticky Boolean sticky mode server
port Number port
https Object start a https server, note: key / cert should be full path to file
typescript Boolean enable loader's typescript support
require Array|String will inject into worker/agent process

Env

EGG_APP_CLOSE_TIMEOUT: app worker boot timeout value

EGG_AGENT_CLOSE_TIMEOUT: agent worker boot timeout value

License

MIT