Setup Job-Runner


By default the settings in job_runner.settings.env.development are used. These settings should work out-of-the box for local development (using Sqlite as a database back-end). Use the --settings argument of to use different settings.

If you want to override the default settings, you could create a module (eg: job_runner_config) with your setting overrides:

from job_runner.settings.base import *


See Project settings and for available settings.

  1. Make sure you have all requirements installed (the exact package names can vary per distribution, these are for Ubuntu).:

    • python-dev
    • virtualenvwrapper
    • build-essential
  2. Create a Virtualenv (, to make sure all requirements are installed in an isolated environment. This is not required, but it will keep your system clean :)

    $ mkvirtualenv job-runner
  3. Install the Job-Runner (which will fetch all Python requirements as well):

    $ pip install job-runner

    Alternatively, you could clone the job-runner repository and install the package in development mode. Any changes you make will be reflected immediately without having to do an install again:

    $ python develop
    $ pip install -r test-requirements.txt
  4. Initialize the database and run the migations:

    $ syncdb
    $ migrate
    $ collectstatic
  5. Run runserver. This will start a development server with the default development settings. The development server will serve the admin interface, the dashboard and the RESTful API.

  6. Run broadcast_queue. This will start the queue broadcaster. The queue broadcaster will broadcast the runs that are scheduled for execution to the subscribed workers.

  7. Run health_check. This will monitor the health of the workers and alert (don’t forget to setup e-mail adresses) when there are problems.

Previous topic

Welcome to Job-Runner’s documentation!

Next topic

Getting started

This Page