diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 88937415..457f37a9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -3,8 +3,20 @@ name: CI on: push: branches: [main] + paths-ignore: + - "README.md" + - "CONTRIBUTING.md" + - "images/**" + - "apps/docs/**" + - "docs/**" pull_request: branches: [main] + paths-ignore: + - "README.md" + - "CONTRIBUTING.md" + - "images/**" + - "apps/docs/**" + - "docs/**" concurrency: group: ${{ github.workflow }}-${{ github.ref }} diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml index aefd4bff..f8792f8a 100644 --- a/.github/workflows/deploy-docs.yml +++ b/.github/workflows/deploy-docs.yml @@ -3,7 +3,8 @@ name: Deploy Docs to GitHub Pages on: push: branches: [main] - # Allows you to run this workflow manually from the Actions tab + paths: + - "apps/docs/**" workflow_dispatch: # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages diff --git a/README.md b/README.md index 090bd29a..9c5d7e47 100644 --- a/README.md +++ b/README.md @@ -4,11 +4,11 @@

ashim

-

ashim but for images. 30+ tools and local AI in a single Docker container.

+

A Self Hosted Image Manipulator

Docker Hub - GHCR + GHCR CI License Stars @@ -18,10 +18,10 @@ ## Key Features -- **30+ image tools** - Resize, crop, compress, convert, watermark, color adjust, and more -- **Local AI** - Remove backgrounds, upscale images, erase objects, blur faces, extract text (OCR). All running on your hardware with pre-downloaded models, no internet required +- **45+ image tools** - Resize, crop, compress, convert, watermark, color adjust, vectorize, create GIFs, find duplicates, generate passport photos, and more +- **Local AI** - Remove backgrounds, upscale images, restore and colorize old photos, erase objects, blur faces, enhance faces, extract text (OCR). All on your hardware - no internet required - **Pipelines** - Chain tools into reusable workflows. Batch process up to 200 images at once -- **REST API** - Every tool available via API. Interactive docs included at `/api/docs` +- **REST API** - Every tool available via API with API key auth. Interactive docs at `/api/docs` - **Single container** - One `docker run`, no Redis, no Postgres, no external services - **Multi-arch** - Runs on AMD64 and ARM64 (Intel, Apple Silicon, Raspberry Pi) - **Your data stays yours** - No telemetry, no tracking, no external calls. Images never leave your machine @@ -55,7 +55,7 @@ docker run -d -p 1349:1349 --gpus all -v ashim-data:/data ashimhq/ashim:latest | Username | `admin` | | Password | `admin` | -You will be asked to change your password on first login. This is enforced for all new accounts and cannot be skipped in production. +You will be asked to change your password on first login. For Docker Compose, persistent storage, and other setup options, see the [Getting Started Guide](https://ashim-hq.github.io/ashim/guide/getting-started). For GPU acceleration and tag details, see [Docker Tags](https://ashim-hq.github.io/ashim/guide/docker-tags). @@ -79,4 +79,4 @@ Found a bug or have a feature idea? Open a [GitHub Issue](https://github.com/ash This project is dual-licensed under the [AGPLv3](LICENSE) and a commercial license. - **AGPLv3 (free):** You may use, modify, and distribute this software under the AGPLv3. If you run a modified version as a network service, you must make your source code available under the AGPLv3. This applies to personal use, open-source projects, and any use that complies with AGPLv3 terms. -- **Commercial license (paid):** If you want to use ashim in proprietary software or SaaS without the AGPLv3 source-disclosure requirement, a commercial license is available. Contact me for pricing and terms. +- **Commercial license (paid):** For use in proprietary software or SaaS products where AGPLv3 source-disclosure is not suitable, a commercial license is available. [Contact us](mailto:ashim.hq@gmail.com) for pricing and terms. diff --git a/images/bg_removal.png b/images/bg_removal.png deleted file mode 100644 index d51743ce..00000000 Binary files a/images/bg_removal.png and /dev/null differ diff --git a/images/dashboard.png b/images/dashboard.png index ba89633e..b1ae054a 100644 Binary files a/images/dashboard.png and b/images/dashboard.png differ diff --git a/images/dashboard_no_detail.png b/images/dashboard_no_detail.png index ad30befb..40e1099b 100644 Binary files a/images/dashboard_no_detail.png and b/images/dashboard_no_detail.png differ diff --git a/images/docs.png b/images/docs.png deleted file mode 100644 index 644a279d..00000000 Binary files a/images/docs.png and /dev/null differ