egg-arena

egg-arena

Egg Arena plugin.

Arena is an interactive UI dashboard for Bee Queue and Bull.

Install

$ npm i egg-arena --save

Usage

// {app_root}/config/plugin.js
exports.arena = {
  enable: true,
  package: 'egg-arena',
};

Configuration

// {app_root}/config/config.default.js
exports.arena = {
  // Required. To specify custom path to mount server on.
  router: '/arena',

  // Required. To configure queues.
  queues: [
    {
      name: 'my_queue', // Required. Name of the bull queue.
      hostId: 'Queue Server 1', // Required. Hostname or queue prefix.
      redis: {
        port: /* redis port */,
        host: /* redis host */,
        password: /* redis password */,
      },
    },
  ],

  // Optional. Execute middleware before routing.
  onPreArena: function* (ctx) {},
};

exports.middleware = [ 'arena' ];

Please see arena's queue configuration for more detail.

Questions & Suggestions

Please open an issue here.

License

MIT