Setup

Installing

The steps required to install the Seed Identity Service are:

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

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

    This will create a directory seed-identity-store 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 Identity Store needs to exist before running this command. See IDENTITIES_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_identity_store/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.

IDENTITIES_DATABASE

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

IDENTITIES_SENTRY_DSN

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

HOOK_AUTH_TOKEN

An Authorization Token to use when making a POST request to a webhook.

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.