ESAP Deployment

This repository contains blueprints on how to quickly deploy an instance of ESAP on your own infrastructure.

This documentation is intentionally minimal. For more information about ESAP itself see the documentation wiki, and for a much wider range of possible installation routes check out the installation overview.

This repository currently provides two flavours of deployment:

• A Docker Compose file for deploying on a host with Docker.
• A Helm Chart for deployment on a Kubernetes cluster.

Components

ESAP currently consists of three major components. Their repositories can be found below.

• ESAP API Gateway: a Django Application in Python.
• ESAP GUI: a React project in Javascript.
• ESAP Worker: a background worker in Python using the Celery framework.

Docker Compose

Install on a host supporting Docker and Docker Compose. Installation instructions for docker Compose can be found here.

Configuration

The compose file uses the following environment variables:

These can be provided in an .env file (see docker-compose/.env.example)

Reverse proxy options

It is strongly recommended to run ESAP behind a reverse proxy.

This repository uses Traefik, an easy to configure dynamic reverse proxy which also handles TLS (https) termination and certificate management via Let's Encrypt.

You can use docker-compose-local.yml to quicky deploy local instances of both ESAP and Traefik. ESAP will be made available at http://localhost:8080/esap-gui/.

Alternatively, if you are hosting other web applications on the same node, you may wish to deploy a general-use Traefik instance managed independently of ESAP. See here for more information on how to configure Traefik. When you have that set up, you can then use docker-compose-existing-traefik.yml to start ESAP.

Bringing the service up

# replace by docker-compose if using compose V1
# or install compose V2 with the `docker-compose-plugin` package
docker compose up -d

For the initial run you need to migrate the databases. You can use the provided script for this, executing in the same directory as the docker-compose.yml file.

./init_db.sh

NOTE: Sometimes the configuration is not correctly loaded. All SQLite files should be larger then 0 bytes. If not, remove the file and run the init script again.

Updating the service

docker compose pull
docker compose up -d --force-recreate

Helm Chart

Work in progress

Contributing

For developer access to this repository, please send a message on the ESAP channel on Rocket Chat.