https://github.com/eggjs/cluster
cluster manager for egg
https://github.com/eggjs/cluster
cluster egg process-manager
Last synced: about 1 year ago
JSON representation
cluster manager for egg
- Host: GitHub
- URL: https://github.com/eggjs/cluster
- Owner: eggjs
- License: mit
- Created: 2016-06-18T07:02:25.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-19T13:45:16.000Z (over 1 year ago)
- Last Synced: 2024-12-19T14:44:52.840Z (over 1 year ago)
- Topics: cluster, egg, process-manager
- Language: JavaScript
- Homepage:
- Size: 408 KB
- Stars: 221
- Watchers: 29
- Forks: 57
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-egg - egg-cluster - 集群管理。   (仓库 / [内置插件](https://eggjs.org/zh-cn/basics/plugin.html#%E6%8F%92%E4%BB%B6%E5%88%97%E8%A1%A8))
README
# egg-cluster
[![NPM version][npm-image]][npm-url]
[](https://github.com/eggjs/cluster/actions/workflows/nodejs.yml)
[![Test coverage][codecov-image]][codecov-url]
[![Known Vulnerabilities][snyk-image]][snyk-url]
[![npm download][download-image]][download-url]
[](https://nodejs.org/en/download/)
[npm-image]: https://img.shields.io/npm/v/@eggjs/cluster.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@eggjs/cluster
[codecov-image]: https://codecov.io/github/eggjs/cluster/coverage.svg?branch=master
[codecov-url]: https://codecov.io/github/eggjs/cluster?branch=master
[snyk-image]: https://snyk.io/test/npm/@eggjs/cluster/badge.svg?style=flat-square
[snyk-url]: https://snyk.io/test/npm/@eggjs/cluster
[download-image]: https://img.shields.io/npm/dm/@eggjs/cluster.svg?style=flat-square
[download-url]: https://npmjs.org/package/@eggjs/cluster
Cluster Manager for EggJS
## Install
```bash
npm i @eggjs/cluster
```
## Usage
CommonJS
```js
const { startCluster } = require('@eggjs/cluster');
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.
```js
startCluster(options).then(() => {
console.log('started');
});
```
ESM and TypeScript
```ts
import { startCluster } from '@eggjs/cluster';
startCluster({
baseDir: '/path/to/app',
framework: '/path/to/framework',
});
```
## 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 |
| debugPort | `Number` | the debug port only listen on http protocol |
| https | `Object` | start a https server, note: `key` / `cert` / `ca` should be full path to file |
| require | `Array\|String` | will inject into worker/agent process |
| pidFile | `String` | will save master pid to this file |
| startMode | `String` | default is 'process', use 'worker_threads' to start the app & agent worker by worker_threads |
| ports | `Array` | startup port of each app worker, such as: [7001, 7002, 7003], only effects when the startMode is 'worker_threads' |
| env | `String` | custom env, default is process.env.EGG_SERVER_ENV |
## Env
`EGG_APP_CLOSE_TIMEOUT`: app worker boot timeout value
`EGG_AGENT_CLOSE_TIMEOUT`: agent worker boot timeout value
## License
[MIT](LICENSE)
## Contributors
[](https://github.com/eggjs/cluster/graphs/contributors)
Made with [contributors-img](https://contrib.rocks).