Skip to content

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

VariableDefaultDescription
PORT1349Port the server listens on.
RATE_LIMIT_PER_MIN100Maximum requests per minute per IP.

Authentication

VariableDefaultDescription
AUTH_ENABLEDfalseSet to true to require login. The Docker image defaults to true.
DEFAULT_USERNAMEadminUsername for the initial admin account. Only used on first run.
DEFAULT_PASSWORDadminPassword for the initial admin account. Change this after first login.

Storage

VariableDefaultDescription
STORAGE_MODElocallocal or s3. Only local storage is currently implemented.
DB_PATH./data/stirling.dbPath to the SQLite database file.
WORKSPACE_PATH./tmp/workspaceDirectory for temporary files during processing. Cleaned up automatically.
FILES_STORAGE_PATH./data/filesDirectory for persistent user files (uploaded images, saved results).

Processing limits

VariableDefaultDescription
MAX_UPLOAD_SIZE_MB100Maximum file size per upload in megabytes.
MAX_BATCH_SIZE200Maximum number of files in a single batch request.
CONCURRENT_JOBS3Number of batch jobs that run in parallel. Higher values use more memory.
MAX_MEGAPIXELS100Maximum image resolution allowed. Rejects images larger than this.

Cleanup

VariableDefaultDescription
FILE_MAX_AGE_HOURS24How long temporary files are kept before automatic deletion.
CLEANUP_INTERVAL_MINUTES30How often the cleanup job runs.

Appearance

VariableDefaultDescription
APP_NAMEStirling ImageDisplay name shown in the UI.
DEFAULT_THEMElightDefault theme for new sessions. light or dark.
DEFAULT_LOCALEenDefault interface language.

Docker example

yaml
services:
  stirling-image:
    image: stirlingimage/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 and user files. Mount this to keep users, API keys, saved pipelines, and uploaded images 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.