Docker Deployment
Official Docker images built on the Rust core with Debian 13 (Trixie). Each image supports three execution modes: API server (default), CLI tool, and MCP server.
Quick Start
Section titled “Quick Start”Pull and Run
Section titled “Pull and Run”# Start API server (default mode)docker run -p 8000:8000 ghcr.io/kreuzberg-dev/kreuzberg-full:latest
# Test the APIcurl -F "files=@document.pdf" http://localhost:8000/extract# Extract a single filedocker run -v $(pwd):/data ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ extract /data/document.pdf
# Batch process multiple filesdocker run -v $(pwd):/data ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ batch /data/*.pdf --output-format json
# Detect MIME typedocker run -v $(pwd):/data ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ detect /data/unknown-file.bin# Start MCP serverdocker run ghcr.io/kreuzberg-dev/kreuzberg-full:latest mcpPull Image
Section titled “Pull Image”docker pull ghcr.io/kreuzberg-dev/kreuzberg-core:latestdocker pull ghcr.io/kreuzberg-dev/kreuzberg-full:latestImage Variants
Section titled “Image Variants”| Core | Full | |
|---|---|---|
| Image | ghcr.io/kreuzberg-dev/kreuzberg-core:latest |
ghcr.io/kreuzberg-dev/kreuzberg-full:latest |
| Size | ~1.0–1.3 GB | ~1.5–2.1 GB |
| Tesseract OCR | 12 languages | 12 languages |
| Modern Office | DOCX, PPTX, XLSX | DOCX, PPTX, XLSX |
| Legacy Office | DOC, PPT, XLS (native OLE/CFB) | DOC, PPT, XLS (native OLE/CFB) |
| Startup | ~1s | ~1s |
Core is optimized for production deployments where image size matters. Both images support all major formats — choose based on deployment constraints.
All images include: Tesseract OCR (eng, spa, fra, deu, ita, por, chi-sim, chi-tra, jpn, ara, rus, hin), pdfium, images, HTML, email, and archives.
Execution Modes
Section titled “Execution Modes”API Server (Default)
Section titled “API Server (Default)”docker run -p 8000:8000 ghcr.io/kreuzberg-dev/kreuzberg-full:latest
# Custom port and CORSdocker run -p 9000:9000 \ -e KREUZBERG_CORS_ORIGINS="https://myapp.com" \ ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ serve --host 0.0.0.0 --port 9000
# With config filedocker run -p 8000:8000 \ -v $(pwd)/kreuzberg.toml:/config/kreuzberg.toml \ ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ serve --config /config/kreuzberg.tomlSee API Server Guide for endpoint documentation.
CLI Mode
Section titled “CLI Mode”# Extract a filedocker run -v $(pwd):/data ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ extract /data/document.pdf
# Extract with OCRdocker run -v $(pwd):/data ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ extract /data/scanned.pdf --ocr true
# Batch processingdocker run -v $(pwd):/data ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ batch /data/*.pdf --format json
# MIME detectiondocker run -v $(pwd):/data ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ detect /data/unknown-file.binMCP Server
Section titled “MCP Server”docker run ghcr.io/kreuzberg-dev/kreuzberg-full:latest mcp
# With configdocker run \ -v $(pwd)/kreuzberg.toml:/config/kreuzberg.toml \ ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ mcp --config /config/kreuzberg.tomlSee API Server Guide - MCP Section for integration details.
Environment Variables
Section titled “Environment Variables”| Variable | Default | Description |
|---|---|---|
KREUZBERG_MAX_UPLOAD_SIZE_MB |
100 |
Max upload size in MB |
KREUZBERG_CORS_ORIGINS |
* |
Comma-separated allowed origins |
RUST_LOG |
info |
Log level: error, warn, info, debug, trace |
KREUZBERG_CACHE_DIR |
/app/.kreuzberg |
Cache directory (set explicitly in Docker; outside containers defaults to platform global cache) |
HF_HOME |
/app/.kreuzberg/huggingface |
HuggingFace model cache |
Host and port are set via CLI args: serve --host 0.0.0.0 --port 8000.
Volume Mounts
Section titled “Volume Mounts”# Cache persistence (embedding models, OCR cache)docker run -p 8000:8000 \ -v kreuzberg-cache:/app/.kreuzberg \ ghcr.io/kreuzberg-dev/kreuzberg-full:latest
# Config filedocker run -p 8000:8000 \ -v $(pwd)/kreuzberg.toml:/config/kreuzberg.toml \ ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ serve --config /config/kreuzberg.toml
# Documents (read-only)docker run -v $(pwd)/documents:/data:ro \ ghcr.io/kreuzberg-dev/kreuzberg-full:latest \ extract /data/document.pdfDocker Compose
Section titled “Docker Compose”services: kreuzberg-api: image: ghcr.io/kreuzberg-dev/kreuzberg-full:latest ports: - "8000:8000" environment: - KREUZBERG_CORS_ORIGINS=https://myapp.com - KREUZBERG_MAX_UPLOAD_SIZE_MB=500 - RUST_LOG=info volumes: - ./config:/config - cache-data:/app/.kreuzberg command: serve --host 0.0.0.0 --port 8000 --config /config/kreuzberg.toml restart: unless-stopped healthcheck: test: ["CMD", "kreuzberg", "--version"] interval: 30s timeout: 10s retries: 3 start_period: 5s
volumes: cache-data:Security
Section titled “Security”Images run as non-root user kreuzberg (UID 1000). For hardened deployments:
docker run --security-opt no-new-privileges \ --read-only \ --tmpfs /tmp \ -p 8000:8000 \ ghcr.io/kreuzberg-dev/kreuzberg-full:latestEnsure mounted volumes have correct permissions:
chown -R 1000:1000 /path/to/mounted/directoryResource Allocation
Section titled “Resource Allocation”| Workload | Memory | CPU | Notes |
|---|---|---|---|
| Light | 512 MB | 0.5 cores | Small documents, low concurrency |
| Medium | 1 GB | 1 core | Typical documents, moderate concurrency |
| Heavy | 2 GB+ | 2+ cores | Large documents, OCR, high concurrency |
docker run -p 8000:8000 --memory=1g --cpus=1 \ ghcr.io/kreuzberg-dev/kreuzberg-full:latestBuilding Custom Images
Section titled “Building Custom Images”docker build -f docker/Dockerfile.core -t kreuzberg:core .docker build -f docker/Dockerfile.full -t kreuzberg:full .FROM ghcr.io/kreuzberg-dev/kreuzberg-full:latest
USER rootRUN apt-get update && \ apt-get install -y --no-install-recommends your-package-here && \ apt-get clean && rm -rf /var/lib/apt/lists/*
USER kreuzbergCOPY kreuzberg.toml /app/kreuzberg.tomlCMD ["serve", "--config", "/app/kreuzberg.toml"]Other Image Variants
Section titled “Other Image Variants”The published Core and Full images cover most use cases. For specialized needs, the docker/ directory has additional Dockerfiles:
| Dockerfile | What it builds |
|---|---|
Dockerfile.cli |
Minimal image with just the kreuzberg binary — good for CI pipelines and batch jobs |
Dockerfile.musl-build |
Fully static Linux binaries via MUSL — runs on any distro, no dynamic libs |
Dockerfile.musl-ffi |
Static C FFI library for language bindings (Go, Ruby, R, PHP, Elixir) |
Dockerfile.musl-rustler |
MUSL-based Rustler NIF for Elixir |
CLI Image
Section titled “CLI Image”A stripped-down image with only the CLI binary. No server, no API — just extraction:
docker build -f docker/Dockerfile.cli -t kreuzberg-cli .
docker run -v $(pwd):/data kreuzberg-cli extract /data/document.pdfdocker run -v $(pwd):/data kreuzberg-cli batch /data/*.pdf --format jsondocker run -v $(pwd):/data kreuzberg-cli detect /data/unknown-file.binMUSL Static Builds
Section titled “MUSL Static Builds”These produce binaries with zero dynamic library dependencies. A single file that runs on any Linux — Alpine, scratch containers, bare EC2 instances, whatever.
docker build -f docker/Dockerfile.musl-build -t kreuzberg-musl-build .docker build -f docker/Dockerfile.musl-ffi -t kreuzberg-musl-ffi .The FFI variant builds a shared library used by the Go, Ruby, R, PHP, and Elixir bindings for portable cross-platform distribution.
Troubleshooting
Section titled “Troubleshooting”Next Steps
Section titled “Next Steps”- Kubernetes Deployment — production K8s with OCR config and health checks
- API Server Guide — endpoint documentation
- Configuration — all configuration options