Package: rq-dashboard-compatible
Introductionrq-dashboardis a general purpose, lightweight,Flask-based web front-end to monitor yourRQqueues, jobs, and workers in realtime.Maturity notesThe RQ dashboard is currently being developed and is in beta stage.Installing with DockerYou can also run the dashboard inside of docker:$ docker pull eoranged/rq-dashboard
$ docker run -p 9181:9181 eoranged/rq-dashboardand you can then run the image. You can pass additional options using
environment variables with prefixRQ_DASHBOARD_*:- RQ_DASHBOARD_REDIS_URL=redis://<redis:6379>
- RQ_DASHBOARD_USERNAME=rq
- RQ_DASHBOARD_PASSWORD=passwordSee more info on how to pass environment variables inDocker documentationInstalling from PyPI$ pip install rq-dashboardRunning the dashboardRun the dashboard standalone, like this:$ rq-dashboard
* Running on http://127.0.0.1:9181/
...$ 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.

Options:
  -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
                                  path)
  -u, --redis-url TEXT            Redis URL. Can be specified multiple times.
                                  Default: redis://127.0.0.1:6379
  --poll-interval, --interval INTEGER
                                  Refresh interval in ms
  --extra-path TEXT               Append specified directories to sys.path
  --debug / --normal              Enter DEBUG mode
  -v, --verbose                   Enable verbose logging
  --help                          Show this message and exit.Integrating the dashboard in your Flask appThe dashboard can be integrated in to your ownFlaskapp by accessing the blueprint directly in the normal way, e.g.:from flask import Flask
import rq_dashboard

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

@app.route("/")
def hello():
    return "Hello World!"

if __name__ == "__main__":
    app.run()If you start the Flask app on the default port, you can access the
dashboard athttp://localhost:5000/rq. Thecli.py:mainentry point
provides a simple working example.Running on HerokuConsider using third-party projectrq-dashboard-on-heroku,
which installs rq-dashboard from PyPI and wraps in inGunicornfor deployment to Heroku.
rq-dashboard-on-heroku is maintained indepdently.DevelopingDevelop in a virtualenv and make sure you have all the necessary build
time (and run time) dependencies with$ pip install -r requirements.txtDevelop in the normal way with$ python setup.py developStatsPyPI statsGithub stats