Installation

Dispatch relies on multiple services to work, which are all orchestrated by Docker Compose.

Requirements

  • Docker 17.05.0+

  • Docker Compose 1.19.0+

  • A dedicated (sub)domain to host Dispatch on (for example, dispatch.yourcompany.com).

  • At least 2400MB memory

  • 2 CPU Cores

Installing Dispatch Server

We strongly recommend using Docker, for installing Dispatch and all its services. If you need to do something custom, you can use this repository as the basis of your setup. If you do not wish to use the Docker images we provide, you can still find Dispatch on PyPI; however, we don't recommend that method. You'll need to work your way back from the main Dispatch image. It is not too hard, but you are likely to spend a lot more time and hit some bumps.

To install Dispatch from the repository, clone the repository locally:

git clone https://github.com/Netflix/dispatch-docker.git

Before starting the installation, we strongly recommend you check out how to configure your Dispatch instance as you'd need to rebuild your images (docker-compose build) if you want to change your configuration settings. You may copy and edit the example configs provided in the repository. If none exists, the install script will use these examples as actual configurations.

Note: Dispatch will not start without at least a few required configuration variables, see the example env.

Note: Dispatch does not contain any data by default. For evaluation purposes, we do provide an example data set located here. For instructions for restoring this data see here.

To start, run the install script:

./install.sh