Skip to content

Running with Docker

PII Eraser is distributed as a Docker container, ensuring consistency across development and production environments.

Prerequisites

  • Docker Engine installed.
  • Hardware: PII Eraser runs on x86 and ARM architectures.
    • CPU: Modern CPUs with AVX512 (Intel/AMD) or ARM NEON (AWS Graviton) instructions provide significantly better performance.
    • RAM: Minimum 4GB dedicated to the container. 8GB recommended for high-load production.

Quickstart

Run the container exposing port 8000.

docker run -p 8000:8000 --name pii-eraser \
  --read-only \
  --tmpfs /tmp \
  ghcr.io/your-org/pii-eraser:latest

Privacy First

PII Eraser does not phone home. There are no usage analytics, no telemetry, and no external API calls made by the container. It is safe to run in air-gapped environments.

Configuration via Volume Mount

To apply custom settings (like allow lists or custom log levels), mount a config.yaml file into the container.

  1. Create config.yaml locally.
  2. Mount it to /app/config.yaml.
docker run -p 8000:8000 \
  -v $(pwd)/config.yaml:/app/config.yaml:ro \
  ghcr.io/your-org/pii-eraser:latest

Health Checks

When orchestrating with Docker Compose or Kubernetes, use the built-in python health check script.

healthcheck:
  test: ["CMD", "python", "/app/healthcheck.py"]
  interval: 30s
  timeout: 10s
  retries: 3