Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Close #217 Configure basePath doc #218

Merged
merged 2 commits into from
Jan 24, 2021
Merged

Close #217 Configure basePath doc #218

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c108233
Close #217 Configure basePath doc
softbrix Jan 20, 2021
2556a78
Changed basePath value to 'my-base-path'
softbrix Jan 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,28 @@ app.use('/admin/queues', router)

That's it! Now you can access the `/admin/queues` route and you will be able to monitor everything that is happening in your queues 😁

### Hosting router on a sub path

If you host your express service on a different path than root (/) ie. https://<server_name>/<sub_path>/, then you can add the following code to provide the configuration to the bull-board router. In this example the sub path will be `my-base-path`.

```js
const { router } = require('bull-board');

// ... express server configuration

let basePath = 'my-base-path';

app.use(
'/queues',
(req, res, next) => {
req.proxyUrl = basePath + '/queues';
next();
},
router);
```

You will then find the bull-board UI at the following address `https://<server_name>/my-base-path/queues`.

## Contributing

First of all, thank you for being interested in helping out, your time is always appreciated in every way. 💯
Expand Down