Files
SnapOtter/apps/docs/guide/configuration.md
T
Siddharth Kumar Sah 0e7348a0be fix: unify project on port 1349, improve strip-metadata and UI components
Consolidate all access to localhost:1349 — Vite dev server serves on 1349
and proxies API calls to an internal dev port (13490). Production API
defaults to 1349. Also includes strip-metadata improvements, UI component
updates, and compress operation fixes.
2026-03-23 16:38:27 +08:00

2.8 KiB

Configuration

All configuration is done through environment variables. Every variable has a sensible default, so Stirling Image works out of the box without setting any of them.

Environment variables

Server

Variable Default Description
PORT 1349 Port the server listens on.
RATE_LIMIT_PER_MIN 100 Maximum requests per minute per IP.

Authentication

Variable Default Description
AUTH_ENABLED false Set to true to require login. The Docker image defaults to true.
DEFAULT_USERNAME admin Username for the initial admin account. Only used on first run.
DEFAULT_PASSWORD admin Password for the initial admin account. Change this after first login.

Storage

Variable Default Description
STORAGE_MODE local local or s3. Only local storage is currently implemented.
DB_PATH ./data/stirling.db Path to the SQLite database file.
WORKSPACE_PATH ./tmp/workspace Directory for temporary files during processing. Cleaned up automatically.

Processing limits

Variable Default Description
MAX_UPLOAD_SIZE_MB 100 Maximum file size per upload in megabytes.
MAX_BATCH_SIZE 200 Maximum number of files in a single batch request.
CONCURRENT_JOBS 3 Number of batch jobs that run in parallel. Higher values use more memory.
MAX_MEGAPIXELS 100 Maximum image resolution allowed. Rejects images larger than this.

Cleanup

Variable Default Description
FILE_MAX_AGE_HOURS 24 How long temporary files are kept before automatic deletion.
CLEANUP_INTERVAL_MINUTES 30 How often the cleanup job runs.

Appearance

Variable Default Description
APP_NAME Stirling Image Display name shown in the UI.
DEFAULT_THEME light Default theme for new sessions. light or dark.
DEFAULT_LOCALE en Default interface language.

Docker example

services:
  stirling-image:
    image: siddharth123sk/stirling-image:latest
    ports:
      - "1349:1349"
    volumes:
      - stirling-data:/data
      - stirling-workspace:/tmp/workspace
    environment:
      - AUTH_ENABLED=true
      - DEFAULT_USERNAME=admin
      - DEFAULT_PASSWORD=changeme
      - MAX_UPLOAD_SIZE_MB=200
      - CONCURRENT_JOBS=4
      - FILE_MAX_AGE_HOURS=12
    restart: unless-stopped

Volumes

The Docker container uses two volumes:

  • /data -- Persistent storage for the SQLite database. Mount this to keep users, API keys, and saved pipelines across container restarts.
  • /tmp/workspace -- Temporary storage for images being processed. This can be ephemeral, but mounting it avoids filling up the container's writable layer.