Installation¶

pkggate can be run via Docker (recommended), Docker Compose, or directly from source.

Docker (recommended)¶

Pull the published image from GitHub Container Registry:

docker pull ghcr.io/daneb255/pkggate:latest

Run with default settings (listens on port 8080):

docker run -p 8080:8080 ghcr.io/daneb255/pkggate:latest

Mount a custom policy file:

docker run -p 8080:8080 \
  -v $(pwd)/config/policy.yaml:/app/config/policy.yaml \
  ghcr.io/daneb255/pkggate:latest

The included docker-compose.yml builds locally if no image is present:

docker compose up

To use the pre-built image instead of building from source, set the image tag in your compose override:

# docker-compose.override.yml
services:
  pkggate:
    image: ghcr.io/daneb255/pkggate:latest

Requirements: Python 3.12+

git clone https://github.com/daneb255/pkggate.git
cd pkggate
pip install -e ".[dev]"

Start the proxy:

python -m pkggate

Or via the Makefile:

make run

Once running, confirm the proxy is healthy:

curl http://localhost:8080/healthz

Expected response: {"status":"ok"}