Siddharth Kumar Sah
958b10cb45
- Remove all lite/full variant logic from frontend, API, shared constants, docs, and tests (single unified Docker image only) - Replace single QEMU multi-arch Docker build with per-architecture native builds (amd64 + arm64) and manifest merge to fix disk space exhaustion - Add disk cleanup step and per-platform build cache scopes - Switch release trigger from push to workflow_dispatch - Add GitHub issue templates and PR template
2.2 KiB
Getting started
Run with Docker
The fastest way to get Stirling Image running:
docker run -d \
--name stirling-image \
-p 1349:1349 \
-v stirling-data:/data \
stirlingimage/stirling-image:latest
Open http://localhost:1349 in your browser. Log in with admin / admin.
::: tip GPU acceleration
Have an NVIDIA GPU? Add --gpus all to accelerate background removal (2.7x), upscaling (3x), and OCR (1.5x):
docker run -d --gpus all -p 1349:1349 -v stirling-data:/data stirlingimage/stirling-image:latest
Requires NVIDIA Container Toolkit. Falls back to CPU if no GPU is found. See Docker Tags for details and benchmarks. :::
Run with Docker Compose
Create a docker-compose.yml:
services:
stirling-image:
image: stirlingimage/stirling-image:latest
container_name: stirling-image
ports:
- "1349:1349"
volumes:
- stirling-data:/data
- stirling-workspace:/tmp/workspace
environment:
- AUTH_ENABLED=true
- DEFAULT_USERNAME=admin
- DEFAULT_PASSWORD=admin
restart: unless-stopped
volumes:
stirling-data:
stirling-workspace:
docker compose up -d
See Configuration for the full list of environment variables.
Build from source
Requirements: Node.js 22+, pnpm 9+, Python 3.10+
git clone https://github.com/stirling-image/stirling-image.git
cd stirling-image
pnpm install
Start the dev server:
pnpm dev
This starts both the API server and the React frontend. Open http://localhost:1349 in your browser.
What you can do
The sidebar lists every tool. Pick one, upload an image, tweak the settings, download the result.
Some things to try first:
- Resize an image to specific dimensions or a percentage
- Remove a background with the AI tool
- Compress a photo before uploading it somewhere
- Convert between formats (JPEG, PNG, WebP, AVIF, TIFF, HEIC)
- Batch process a folder of images through any tool
- Save results to the Files page for later
Every tool is also available through the REST API, so you can script workflows or plug Stirling Image into other systems.