ashim/apps/docs/guide/configuration.md
Siddharth Kumar Sah 85b1cfc10a chore: rename Stirling-Image to ashim across entire codebase
Complete rebrand from Stirling-Image to ashim following the project
move to https://github.com/ashim-hq/ashim.

Changes across 117 files:
- Package scope: @stirling-image/* → @ashim/*
- GitHub URLs: stirling-image/stirling-image → ashim-hq/ashim
- Docker Hub: stirlingimage/stirling-image → ashimhq/ashim
- GitHub Pages: stirling-image.github.io → ashim-hq.github.io
- All branding text: "Stirling Image" → "ashim"
- Docker service/volumes/user: stirling → ashim
- Database: stirling.db → ashim.db
- localStorage keys: stirling-token → ashim-token
- Environment variables: STIRLING_GPU → ASHIM_GPU
- Python cache dirs: .cache/stirling-image → .cache/ashim
- SVG filter IDs, test prefixes, and all other references
2026-04-14 20:55:42 +08:00

2.9 KiB

Configuration

All configuration is done through environment variables. Every variable has a sensible default, so ashim 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/ashim.db Path to the SQLite database file.
WORKSPACE_PATH ./tmp/workspace Directory for temporary files during processing. Cleaned up automatically.
FILES_STORAGE_PATH ./data/files Directory for persistent user files (uploaded images, saved results).

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 ashim 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:
  ashim:
    image: ashimhq/ashim:latest
    ports:
      - "1349:1349"
    volumes:
      - ashim-data:/data
      - ashim-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.