{"id":18071323,"url":"https://github.com/kelp404/bull-admin-panel","last_synced_at":"2025-04-12T02:43:34.117Z","repository":{"id":37799185,"uuid":"248157015","full_name":"kelp404/bull-admin-panel","owner":"kelp404","description":"A real time admin panel of Bull(Redis-based queue) based on Express and WebSocket.","archived":false,"fork":false,"pushed_at":"2023-07-17T15:55:38.000Z","size":12763,"stargazers_count":14,"open_issues_count":21,"forks_count":5,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-11T15:27:43.027Z","etag":null,"topics":["bull","bull-admin-panel","express","job-queue","message-queue","nodejs","queue","redis","websocket"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kelp404.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-03-18T06:38:29.000Z","updated_at":"2023-03-29T04:02:05.000Z","dependencies_parsed_at":"2024-10-28T21:07:26.146Z","dependency_job_id":"cdb2042d-86db-43f1-b3d0-a90e40fd8813","html_url":"https://github.com/kelp404/bull-admin-panel","commit_stats":{"total_commits":450,"total_committers":3,"mean_commits":150.0,"dds":"0.34444444444444444","last_synced_commit":"de6ab3a023ea870170f73d2165f4f7cadcd81d4e"},"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelp404%2Fbull-admin-panel","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelp404%2Fbull-admin-panel/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelp404%2Fbull-admin-panel/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kelp404%2Fbull-admin-panel/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kelp404","download_url":"https://codeload.github.com/kelp404/bull-admin-panel/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248507788,"owners_count":21115674,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bull","bull-admin-panel","express","job-queue","message-queue","nodejs","queue","redis","websocket"],"created_at":"2024-10-31T09:14:52.763Z","updated_at":"2025-04-12T02:43:34.092Z","avatar_url":"https://github.com/kelp404.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# bull-admin-panel\n[![npm version](https://badge.fury.io/js/bull-admin-panel.svg)](https://www.npmjs.com/package/bull-admin-panel)\n[![Actions Status](https://github.com/kelp404/bull-admin-panel/workflows/test/badge.svg)](https://github.com/kelp404/bull-admin-panel/actions)\n\nAn admin panel of [Bull](https://github.com/OptimalBits/bull) based on WebSocket.\n\n\n## Installation\n```bash\nnpm install bull-admin-panel\n```\n\n## Screenshots\n\u003cimg src=\"_screenshots/screenshots-01.png\"/\u003e\n\n\n## Example\n[more details...](/example)\n```js\nconst express = require('express');\nconst http = require('http');\nconst Bull = require('bull');\nconst BullAdminPanel = require('bull-admin-panel');\n\nconst app = express();\nconst server = http.createServer(app);\nconst queue = new Bull('queue-name', {\n  redis: {\n    host: 'localhost',\n    port: 6379,\n    db: 1\n  }\n});\n\napp.use('/bull', new BullAdminPanel({\n  basePath: '/bull',\n  verifyClient: (info, callback) =\u003e {\n    // Do authorization for WebSocket.\n    // https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketserveroptions-callback\n    callback(true);\n  },\n  queues: [queue],\n  server: server\n}));\n\n// Launch server\nserver.listen(8000, 'localhost', () =\u003e {\n  const {address, port} = server.address();\n  console.log(`Server listening at http://${address}:${port}`);\n});\n```\n\n\n## Work with nginx\nbull-admin-panel use WebSocket. You need config upgrade request.  \n[NGINX as a WebSocket Proxy](https://www.nginx.com/blog/websocket-nginx/)\n```\nlocation / {\n    proxy_pass http://127.0.0.1:8080;\n    proxy_http_version 1.1;\n    proxy_set_header Host $host;\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection $http_connection;\n}\n```\n\n\n## Options\n### basePath\nType: `string`  \nRequired: `required`  \nThe bull admin panel base path. We pass to frontend app.\n\n### socketValidationPath\nType: `string`  \nRequired: `optional`  \nThe default value is copy from `basePath`. The websocket just accepts to connect via this path.  \nIf your site has rewrite path settings. You can use this option.\n\n### verifyClient\nType: `function(info: object, callback: function)`  \nRequired: `required`  \nFor websocket authorization.  \nMore information:\n+ [A function which can be used to validate incoming connections.](https://github.com/websockets/ws/blob/master/doc/ws.md#new-websocketserveroptions-callback)\n+ [Usage](https://github.com/websockets/ws/issues/377#issuecomment-462152231)\n\n### queues\nType: `Array\u003cBull\u003e`  \nRequired: `required`  \nBull instances.\n```js\nconst Bull = require('bull');\nconst queues = [\n  new Bull('queue-a', 'redis://localhost:6379/0'),\n  new Bull('queue-b', 'redis://localhost:6379/0')\n];\n```\n\n### server\nType: `http.Server`  \nRequired: `required`  \nThe node.js [http.Server](https://nodejs.org/api/http.html#http_class_http_server) instance.\n\n\n## Develop\nFork this repository then clone it.  \n1. Install node modules.  \n`npm install`\n\n2. Start the develop server.    \n`npm start`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelp404%2Fbull-admin-panel","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkelp404%2Fbull-admin-panel","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkelp404%2Fbull-admin-panel/lists"}