Installation

Valor comprises two services: a back-end service (which consists of a REST API and a Postgres database with the PostGIS extension), and a Python client for interacting with the back-end service.

Setting up the back-end service

Using Docker Compose

The easiest way to get up and running with Valor is to use Docker Compose with the docker-compose.yml file in the repository root:

git clone https://github.com/striveworks/valor
cd valor
docker compose --env-file ./api/.env.testing up

This will set up the necessary environment variables, start both the API and database services, and run the database migration job. The endpoint localhost:8000/health should return {"status":"ok"} if all of Valor's services were started correctly.

Note: running Valor this way is not intended for production and scalable use and is only recommended for development and testing purposes.

Deploying via Docker and a hosted database

For a more production-grade deployment, we publish the images ghcr.io/striveworks/valor/valor-service (used for the REST API) and ghcr.io/striveworks/valor/migrations (used for setting up the database and migrations). These can be paired with any Postgres database with the PostGIS extension.

The following environment variables are required for running these images:

Additionally, the Valor REST API has an optional single username/password/bearer token authentication. To enable this feature, the valor-service image requires the following environment variables:

Manual deployment

If you would prefer to build your own image or if you want a debug console for the back-end, please see the deployment instructions in Contributing to Valor.

Setting up the Python client

The Python client can be installed via pip:

pip install valor-client