Skip to content

Getting started ​

Taskforce.sh is a dashboard for your Bull, BullMQ and BullMQ Pro queues. Once your Redis instance is connected you can see all the queues in it, inspect and retry jobs, check your workers and get alerts when something goes wrong. In this page we will go through the steps needed to get your first queues into Taskforce.sh.

Create your account ​

Head over to taskforce.sh and click on "Start Free Trial" to create your account. All new accounts get a 15-day free trial, and you do not need a credit card to start it.

The number of days left in your trial is shown in the left side panel. When the trial ends you will need to choose a plan in the Subscriptions tab of your account in order to keep adding connections.

Connect your Redis instance ​

Taskforce.sh works with your existing Redis instances, there is nothing to install in your application and your queues and workers keep working as they do today. A connection in Taskforce.sh points to one Redis database, and all the queues in that database will be available from the connection.

There are two ways to create a connection, depending on where your Redis instance is running:

  • A direct Redis connection is the fastest way if your Redis instance can be reached from the internet, as is the case with most hosted Redis services. You just fill in the host, port and password in the dashboard.
  • The Taskforce connector is a small command line tool that you run next to your Redis instance. It opens a secure connection from your side to Taskforce.sh, so your Redis instance does not need to be reachable from the internet. Use it for Redis instances inside a private network, or for a Redis running on your own computer.

If you are unsure, start with the connector against your local Redis instance. It only takes a couple of minutes and is a good way to try the dashboard with your own queues.

INFO

Every connection counts towards the connections quota of your plan. The left side panel shows how many connections you are using and how many your plan includes.

Find your queues ​

When the connection is created it appears in the left side panel with a green status icon. Taskforce.sh scans the Redis database looking for queues, and any queue it finds is listed below the connection. Click on a queue to open it.

If a queue you expected is missing, it may not have been created yet, or it may be using a prefix other than the default bull; see Specifying queue names manually to configure a non-default prefix. For other missing-queue issues, see Troubleshooting.

From the queue view you can browse the jobs by state, see the workers that are connected, look at the metrics and much more. The Queues page is a good place to continue.

Next steps ​

Once your queues are in place, these are the things most users set up next:

  • Enable the monitors on your connections so that you get an alert when jobs fail, workers go missing or the backlog grows too large. Monitors are disabled by default.
  • Choose where alerts should be sent, for example by email, Slack or PagerDuty, in Enable notifications.
  • Invite your colleagues to an organization and share your connections with a team, so everyone can work on the same queues.

Built by the creators of BullMQ.