2026-03-22 11:14:35 +08:00
<p align="center">
2026-03-27 13:49:55 +08:00
<img src="apps/web/public/logo-192.png" width="80" alt="Stirling Image logo">
2026-03-22 11:14:35 +08:00
</p>
2026-03-27 13:49:55 +08:00
<h1 align="center">Stirling Image - The Open-Source Image Processing Platform</h1>
Stirling Image is a powerful, open-source image processing platform. Self-host it in a single Docker container with a private API. Resize, compress, convert, remove backgrounds, upscale, run OCR, and more — without sending images to external services.
2026-03-22 11:14:35 +08:00
<p align="center">
<a href="https://github.com/siddharthksah/Stirling-Image/pkgs/container/stirling-image"><img src="https://img.shields.io/badge/Docker-ghcr.io-blue?logo=docker" alt="Docker"></a>
<a href="https://github.com/siddharthksah/Stirling-Image/actions"><img src="https://img.shields.io/github/actions/workflow/status/siddharthksah/Stirling-Image/ci.yml?label=CI" alt="CI"></a>
<a href="https://github.com/siddharthksah/Stirling-Image/blob/main/LICENSE"><img src="https://img.shields.io/github/license/siddharthksah/Stirling-Image" alt="License"></a>
<a href="https://github.com/siddharthksah/Stirling-Image/stargazers"><img src="https://img.shields.io/github/stars/siddharthksah/Stirling-Image?style=social" alt="Stars"></a>
</p>
2026-03-27 13:49:55 +08:00

2026-03-22 11:14:35 +08:00
2026-03-27 13:49:55 +08:00
## Key Capabilities
2026-03-22 11:14:35 +08:00
2026-03-27 13:49:55 +08:00
- **33+ image tools** — Resize, crop, compress, convert, watermark, OCR, and more.
- **AI-powered** — Background removal, upscaling, object erasing, face blurring — all running locally.
- **Automation & workflows** — Chain tools into reusable pipelines. Batch process up to 200 images at once.
- **Developer platform** — REST API for every tool. Swagger docs included.
- **Your data stays yours** — No telemetry, no tracking, no cloud. Single Docker container on any architecture.
2026-03-22 11:14:35 +08:00
2026-03-27 13:49:55 +08:00
For a full feature list, see the docs: **https://siddharthksah.github.io/Stirling-Image/**
2026-03-22 11:14:35 +08:00
2026-03-27 13:49:55 +08:00
## Quick Start
2026-03-22 11:14:35 +08:00
```bash
2026-03-27 13:49:55 +08:00
docker run -d -p 1349:1349 -v stirling-data:/data ghcr.io/siddharthksah/stirling-image:latest
2026-03-22 11:14:35 +08:00
```
2026-03-27 13:49:55 +08:00
Then open: http://localhost:1349. Default login: `admin` / `admin` .
2026-03-22 11:14:35 +08:00
2026-03-27 13:49:55 +08:00
For full installation options, see the [Getting Started Guide ](https://siddharthksah.github.io/Stirling-Image/guide/getting-started ).
2026-03-22 11:14:35 +08:00
2026-03-27 13:49:55 +08:00
## Resources
2026-03-22 11:14:35 +08:00
2026-03-27 13:49:55 +08:00
- [**Documentation** ](https://siddharthksah.github.io/Stirling-Image/ )
- [**API Docs** ](https://siddharthksah.github.io/Stirling-Image/api/rest )
- [**Configuration** ](https://siddharthksah.github.io/Stirling-Image/guide/configuration )
2026-03-22 11:14:35 +08:00
2026-03-27 13:49:55 +08:00
## Support
2026-03-22 11:14:35 +08:00
2026-03-27 13:49:55 +08:00
- **Bug Reports**: [GitHub Issues ](https://github.com/siddharthksah/Stirling-Image/issues )
2026-03-25 09:27:12 +08:00
<p align="center">
<a href="https://github.com/sponsors/siddharthksah"><img src="https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?logo=github-sponsors" alt="GitHub Sponsors"></a>
<a href="https://ko-fi.com/siddharthksah"><img src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Ko--fi-FF5E5B?logo=ko-fi" alt="Ko-fi"></a>
</p>
2026-03-22 11:14:35 +08:00
## Contributing
2026-03-26 01:10:13 +08:00
Contributions welcome. Open an issue first so we can talk about what you have in mind.
2026-03-22 11:14:35 +08:00
## License
[MIT ](LICENSE )