mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00

Files

T

Siddharth Kumar Sah 627ff8a82c chore: remove internal docs from repo, update public documentation

Remove docs/superpowers/, .claude/ config, and PRD.md from version
control (kept locally via .gitignore). Update README, CHANGELOG,
VitePress docs, and .env.example to reflect recent features: Files
page, teams, admin settings, persistent storage, and various API
improvements.

2026-03-26 01:11:40 +08:00

1.8 KiB

Raw Blame History

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 \
  siddharth123sk/stirling-image:latest

Open http://localhost:1349 in your browser. Log in with admin / admin.

Run with Docker Compose

Create a docker-compose.yml:

services:
  stirling-image:
    image: siddharth123sk/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/siddharthksah/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)
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.

1.8 KiB Raw Blame History