bull-admin-panel
Advanced tools
An admin panel of Bull based on WebSocket.
npm install bull-admin-panel
const express = require('express');
const http = require('http');
const Bull = require('bull');
const BullAdminPanel = require('bull-admin-panel');
const app = express();
const server = http.createServer(app);
const queue = new Bull('queue-name', {
redis: {
host: 'localhost',
port: 6379,
db: 1
}
});
app.use('/bull', new BullAdminPanel({
basePath: '/bull',
verifyClient: (info, callback) => {
// Do authorization for WebSocket.
// https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketserveroptions-callback
callback(true);
},
queues: [queue],
server: server
}));
// Launch server
server.listen(8000, 'localhost', () => {
const {address, port} = server.address();
console.log(`Server listening at http://${address}:${port}`);
});
bull-admin-panel use WebSocket. You need config upgrade request.
NGINX as a WebSocket Proxy
location / {
proxy_pass http://127.0.0.1:8080;
proxy_http_version 1.1;
proxy_set_header Host $host;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $http_connection;
}
Type: string
Required: required
The bull admin panel base path. We pass to frontend app.
Type: string
Required: optional
The default value is copy from basePath. The websocket just accepts to connect via this path.
If your site has rewrite path settings. You can use this option.
Type: function(info: object, callback: function)
Required: required
For websocket authorization.
More information:
Type: Array<Bull>
Required: required
Bull instances.
const Bull = require('bull');
const queues = [
new Bull('queue-a', 'redis://localhost:6379/0'),
new Bull('queue-b', 'redis://localhost:6379/0')
];
Type: http.Server
Required: required
The node.js http.Server instance.
Fork this repository then clone it.
Install node modules.
npm install
Start the develop server.
npm start
We have very precise rules over how our git commit messages can be formatted. This leads to more readable messages that are easy to follow when looking through the project history. But also, we use the git commit messages to generate the AngularJS change log.
The commit message formatting can be added using a typical git workflow or through the use of a CLI
wizard (Commitizen). To use the wizard, run yarn run commit
in your terminal after staging your changes in git.
Each commit message consists of a header, a body and a footer. The header has a special format that includes a type, a scope and a subject:
<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
The header is mandatory and the scope of the header is optional.
Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools.
If the commit reverts a previous commit, it should begin with revert: , followed by the header
of the reverted commit.
In the body it should say: This reverts commit <hash>., where the hash is the SHA of the commit
being reverted.
Must be one of the following:
The scope could be anything specifying place of the commit change. For example /,
/jobs, etc...
You can use * when the change affects more than a single scope.
The subject contains succinct description of the change:
Just as in the subject, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior.
The footer should contain any information about Breaking Changes and is also the place to [reference GitHub issues that this commit closes][closing-issues].
Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines.
The rest of the commit message is then used for this.
A detailed explanation can be found in this [document][commit-message-format].
FAQs
An admin panel of Bull based on WebSocket.
The npm package bull-admin-panel receives a total of 68 weekly downloads. As such, bull-admin-panel popularity was classified as not popular.
We found that bull-admin-panel demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.