Skip to content
Flask-based web front-end for monitoring RQ queues
Branch: master
Clone or download
Latest commit ee4e145 Feb 14, 2019
Type Name Latest commit message Commit time
Failed to load latest commit information.
rq_dashboard Bump version to 0.4.0 Feb 14, 2019
tests security: add 'cache-control: no-store' response header for API Dec 20, 2018
.envrc Switch from autoenv to direnv. Jul 23, 2014
Dockerfile Update dependencies and use Python 3 in Dockerfile. Mar 22, 2018
LICENSE Reorganise files into a Python package. Feb 5, 2012 Include more files in manifest so visible on Pypi Jun 3, 2015
Makefile Added a dockerfile for running the dashboard inside docker. Dec 28, 2016
README.rst Update build instructions Dec 11, 2018 Fix 404 errors in docker Oct 5, 2018 Add isort Fabric task Jun 10, 2015 Update dependencies Dec 11, 2018
requirements.txt Update dependencies Dec 11, 2018
setup.cfg Standard universal wheel Jun 3, 2015 Mark as incompatible with RQ 1.0 (see #172) Feb 14, 2019



rq-dashboard is a general purpose, lightweight, Flask-based web front-end to monitor your RQ queues, jobs, and workers in realtime.

Build Status Python Support

It looks like this

image1 image2


$ pip install rq-dashboard

Running the dashboard

Run the dashboard standalone, like this:

$ rq-dashboard
* Running on
$ rq-dashboard --help
Usage: rq-dashboard [OPTIONS]

  Run the RQ Dashboard Flask server.

  All configuration can be set on the command line or through environment
  variables of the form RQ_DASHBOARD_*. For example RQ_DASHBOARD_USERNAME.

  A subset of the configuration (the configuration parameters used by the
  underlying flask blueprint) can also be provided in a Python module
  referenced using --config, or with a .cfg file referenced by the
  RQ_DASHBOARD_SETTINGS environment variable.

  -b, --bind TEXT               IP or hostname on which to bind HTTP server
  -p, --port INTEGER            Port on which to bind HTTP server
  --url-prefix TEXT             URL prefix e.g. for use behind a reverse proxy
  --username TEXT               HTTP Basic Auth username (not used if not set)
  --password TEXT               HTTP Basic Auth password
  -c, --config TEXT             Configuration file (Python module on search
  -H, --redis-host TEXT         IP address or hostname of Redis server
  -P, --redis-port INTEGER      Port of Redis server
  --redis-password TEXT         Password for Redis server
  -D, --redis-database INTEGER  Database of Redis server
  -u, --redis-url TEXT          Redis URL connection (overrides other
                                individual settings)
  --redis-sentinels TEXT        List of redis sentinels. Each should be
                                formatted: <host>:<port>
  --redis-master-name TEXT      Name of redis master. Only needed when using
  --interval INTEGER            Refresh interval in ms
  --extra-path TEXT             Append specified directories to sys.path
  --web-background TEXT         Background of the web interface
  --delete-jobs TEXT            Delete jobs instead of cancel
  --debug / --normal            Enter DEBUG mode
  --help                        Show this message and exit.

Integrating the dashboard in your Flask app

The dashboard can be integrated in to your own Flask app by accessing the blueprint directly in the normal way, e.g.:

from flask import Flask
import rq_dashboard

app = Flask(__name__)
app.register_blueprint(rq_dashboard.blueprint, url_prefix="/rq")

def hello():
    return "Hello World!"

if __name__ == "__main__":

If you start the Flask app on the default port, you can access the dashboard at http://localhost:5000/rq. The entry point provides a simple working example.


We use piptools to keep our development dependencies up to date

$ pip install --upgrade pip
$ pip install pip-tools

Now make changes to the file, and resolve all the 2nd-level dependencies into requirements.txt like so:

$ pip-compile --annotate

Develop in a virtualenv and make sure you have all the necessary build time (and run time) dependencies with

$ pip install -r requirements.txt

Develop in the normal way with

$ python develop

Maturity notes

The RQ dashboard is currently being developed and is in beta stage.


You can also run the dashboard inside of docker, simply build the image with

$ make image

and you can then run the image, possibly modifying it with the following environment variables from their default values

  • REDIS_URL=redis://redis
  • PASSWORD=password
You can’t perform that action at this time.