Installation and Running¶

Docker¶

The simplest way to run the project is via our published Docker image:

docker run \
  -it --rm \
  -p 8000:8000 \
  -e UPSTREAM_URL=https://my-stac-api \
  -e OIDC_DISCOVERY_URL=https://my-auth-server/.well-known/openid-configuration \
  ghcr.io/developmentseed/stac-auth-proxy:latest

Python¶

Installation¶

The application can be installed as a standard Python module:

pip install stac-auth-proxy

Running¶

The installed Python module can be invoked directly:

python -m stac_auth_proxy

Alternatively, the application's factory can be passed to Uvicorn:

uvicorn --factory stac_auth_proxy:create_app

Docker Compose¶

For development and experimentation, the codebase (ie within the repository, not within the Docker or Python distributions) ships with a docker-compose.yaml file, allowing the proxy to be run locally alongside various supporting services: the database, the STAC API, and a Mock OIDC provider.

pgSTAC Backend¶

Run the application stack with a pgSTAC backend using stac-fastapi-pgstac:

docker compose up

OpenSearch Backend¶

Run the application stack with an OpenSearch backend using stac-fastapi-elasticsearch-opensearch:

docker compose --profile os up