mirror of https://github.com/ashim-hq/ashim synced 2026-04-21 13:37:52 +00:00

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.1 KiB

Raw Blame History

Getting started

Run with Docker

The fastest way to get ashim running:

docker run -d \
  --name ashim \
  -p 1349:1349 \
  -v ashim-data:/data \
  ashimhq/ashim:latest

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

::: tip GPU acceleration Have an NVIDIA GPU? Add --gpus all to accelerate background removal (2.7x), upscaling (3x), and OCR (1.5x):

docker run -d --gpus all -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest

Requires NVIDIA Container Toolkit. Falls back to CPU if no GPU is found. See Docker Tags for details and benchmarks. :::

Run with Docker Compose

Create a docker-compose.yml:

services:
  ashim:
    image: ashimhq/ashim:latest
    container_name: ashim
    ports:
      - "1349:1349"
    volumes:
      - ashim-data:/data
      - ashim-workspace:/tmp/workspace
    environment:
      - AUTH_ENABLED=true
      - DEFAULT_USERNAME=admin
      - DEFAULT_PASSWORD=admin
    restart: unless-stopped

volumes:
  ashim-data:
  ashim-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/ashim-hq/ashim.git
cd ashim
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, HEIC)
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 ashim into other systems.

2.1 KiB Raw Blame History