Setup

Installing

The steps required to install the Seed Scheduler Service are:

1. Get the code from the Github Project with git:

   $ git clone https://github.com/praekelt/seed-scheduler.git
   

   This will create a directory seed-scheduler in your current directory.

1. Install the Python requirements with pip:

   $ pip install -r requirements.txt
   

   This will download and install all the Python packages required to run the project.

2. Setup the database:

   $ python manage migrate
   

   This will create all the database tables required.

   Note

   The PostgreSQL database for the Seed Scheduler needs to exist before running this command. See SCHEDULER_DATABASE for details.

3. Run the development server:

   $ python manage.py runserver
   

   Note

   This will run a development HTTP server. This is only suitable for testing and development, for production usage please see Running in Production

Configuration Options

The main configuration file is seed_scheduler/settings.py.

The following environmental variables can be used to override some default settings:

SECRET_KEY

This overrides the Django SECRET_KEY setting.

DEBUG

This overrides the Django DEBUG setting.

USE_SSL

Whether to use SSL when build absolute URLs. Defaults to False.

SCHEDULER_DATABASE

The database parameters to use as a URL in the format specified by the DJ-Database-URL format.

SCHEDULER_SENTRY_DSN

The DSN to the Sentry instance you would like to log errors to.

HOOK_AUTH_TOKEN

The token to use when posting to webhooks.

BROKER_URL

The Broker URL to use with Celery.

METRICS_URL

The URL to the Go Metrics API instance to push metrics to.

METRICS_AUTH_TOKEN

The auth token to use to connect to the Go Metrics API above.