# Stirling Image

> Self-hosted, open-source image processing platform with 30+ tools. Runs in a single Docker container.

## Docs

- [Getting Started](https://stirling-image.github.io/stirling-image/guide/getting-started): Docker setup, build from source
- [Architecture](https://stirling-image.github.io/stirling-image/guide/architecture): Monorepo structure, request flow, packages
- [Configuration](https://stirling-image.github.io/stirling-image/guide/configuration): Environment variables, Docker volumes
- [Database](https://stirling-image.github.io/stirling-image/guide/database): SQLite schema, tables, migrations
- [Deployment](https://stirling-image.github.io/stirling-image/guide/deployment): Docker Compose, reverse proxy, CI/CD
- [REST API](https://stirling-image.github.io/stirling-image/api/rest): All API endpoints, auth, tools, pipelines, batch
- [Image Engine](https://stirling-image.github.io/stirling-image/api/image-engine): Sharp-based operations (resize, crop, rotate, convert, compress, color)
- [AI Engine](https://stirling-image.github.io/stirling-image/api/ai): Python ML models (rembg, RealESRGAN, PaddleOCR, MediaPipe, LaMa)
- [Full Documentation (LLM-friendly)](https://stirling-image.github.io/stirling-image/llms-full.txt): All docs in a single plain-text file

## API Quick Reference

- Base URL: `http://localhost:1349`
- Auth: Session token via `POST /api/auth/login` or API key (`Authorization: Bearer si_...`)
- Tools: `POST /api/v1/tools/{toolId}` (multipart: file + settings JSON)
- Batch: `POST /api/v1/tools/{toolId}/batch` (multiple files, returns ZIP)
- Pipelines: `POST /api/v1/pipeline/execute` (chain tools sequentially)
- Interactive API docs on running instance: `/api/docs`
- OpenAPI spec on running instance: `/api/v1/openapi.yaml`

## Source

- [GitHub](https://github.com/stirling-image/stirling-image)
- License: MIT