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

Files

T

Siddharth Kumar Sah 6668615750 docs: add VitePress documentation site with GitHub Pages deployment

Rewrites all documentation with accurate project details (Fastify, port
1349, single-container Docker, all 33+ tools, full database schema).
Adds getting started guide and configuration reference. Updates help and
settings dialogs to link to the docs site.

2026-03-22 21:00:37 +08:00

1.9 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 20+, 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. The app opens at http://localhost:5173 by default during development.

What you can do

Once logged in, the sidebar lists every available tool. Pick one, upload an image, adjust the settings, and download the result.

A few things to try first:

Resize an image to specific dimensions or a percentage
Remove a background using the AI-powered background removal tool
Compress a photo to reduce file size before uploading it somewhere
Convert between formats (JPEG, PNG, WebP, AVIF, TIFF)
Batch process a folder of images through any tool

Every tool in the UI is also available through the REST API, so you can script your workflows or integrate Stirling Image into other systems.

1.9 KiB Raw Blame History