diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index de3c8ed7..a7719d12 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -1,2 +1,2 @@ -github: siddharthksah -ko_fi: siddharthksah +github: stirling-image +ko_fi: stirling-image diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 17325f20..fae598fb 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -83,7 +83,7 @@ jobs: uses: docker/metadata-action@v5 with: images: | - siddharth123sk/stirling-image + stirlingimage/stirling-image ghcr.io/${{ github.repository }} tags: | type=semver,pattern={{version}},value=v${{ needs.release.outputs.new_version }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 9350f7eb..a09c2bb3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -40,11 +40,11 @@ Example: `feat: add HEIC to PNG conversion support` ## Development setup -Full instructions are in the [Developer Guide](https://siddharthksah.github.io/Stirling-Image/guide/developer). The short version: +Full instructions are in the [Developer Guide](https://stirling-image.github.io/stirling-image/guide/developer). The short version: ```bash -git clone https://github.com/siddharthksah/Stirling-Image.git -cd Stirling-Image +git clone https://github.com/stirling-image/stirling-image.git +cd stirling-image pnpm install pnpm dev # starts both frontend and backend ``` @@ -70,11 +70,11 @@ Tools follow a consistent pattern. You will need to touch three places: 2. **Frontend settings component** in `apps/web/src/components/tools/` with the tool's UI controls. 3. **i18n entry** in `packages/shared/src/i18n/en.ts` with the tool's name and description. -See the [Developer Guide](https://siddharthksah.github.io/Stirling-Image/guide/developer) for a walkthrough. +See the [Developer Guide](https://stirling-image.github.io/stirling-image/guide/developer) for a walkthrough. ## Translations -We currently ship English only, but the i18n system is designed for easy extension. If you want to add a language, see the [Translation Guide](https://siddharthksah.github.io/Stirling-Image/guide/translations). +We currently ship English only, but the i18n system is designed for easy extension. If you want to add a language, see the [Translation Guide](https://stirling-image.github.io/stirling-image/guide/translations). ## Code style diff --git a/README.md b/README.md index dfff4859..14aaf8fb 100644 --- a/README.md +++ b/README.md @@ -7,10 +7,10 @@

Stirling-PDF but for images. 30+ tools and local AI in a single Docker container.

- Docker - CI - License - Stars + Docker + CI + License + Stars

![Stirling Image - Dashboard](images/dashboard.png) @@ -28,7 +28,7 @@ ## Quick Start ```bash -docker run -d -p 1349:1349 -v stirling-data:/data siddharth123sk/stirling-image:latest +docker run -d -p 1349:1349 -v stirling-data:/data stirlingimage/stirling-image:latest ``` Open http://localhost:1349 in your browser. @@ -42,28 +42,28 @@ Open http://localhost:1349 in your browser. You will be asked to change your password on first login. This is enforced for all new accounts and cannot be skipped in production. -For Docker Compose, persistent storage, and other setup options, see the [Getting Started Guide](https://siddharthksah.github.io/Stirling-Image/guide/getting-started). +For Docker Compose, persistent storage, and other setup options, see the [Getting Started Guide](https://stirling-image.github.io/stirling-image/guide/getting-started). ## Documentation -- [Getting Started](https://siddharthksah.github.io/Stirling-Image/guide/getting-started) -- [Configuration](https://siddharthksah.github.io/Stirling-Image/guide/configuration) -- [REST API](https://siddharthksah.github.io/Stirling-Image/api/rest) -- [Architecture](https://siddharthksah.github.io/Stirling-Image/guide/architecture) -- [Developer Guide](https://siddharthksah.github.io/Stirling-Image/guide/developer) -- [Translation Guide](https://siddharthksah.github.io/Stirling-Image/guide/translations) +- [Getting Started](https://stirling-image.github.io/stirling-image/guide/getting-started) +- [Configuration](https://stirling-image.github.io/stirling-image/guide/configuration) +- [REST API](https://stirling-image.github.io/stirling-image/api/rest) +- [Architecture](https://stirling-image.github.io/stirling-image/guide/architecture) +- [Developer Guide](https://stirling-image.github.io/stirling-image/guide/developer) +- [Translation Guide](https://stirling-image.github.io/stirling-image/guide/translations) ## Contributing -Contributions welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines, the [Developer Guide](https://siddharthksah.github.io/Stirling-Image/guide/developer) for setup, and the [Translation Guide](https://siddharthksah.github.io/Stirling-Image/guide/translations) for adding languages. +Contributions welcome. See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines, the [Developer Guide](https://stirling-image.github.io/stirling-image/guide/developer) for setup, and the [Translation Guide](https://stirling-image.github.io/stirling-image/guide/translations) for adding languages. ## Support -Bug reports and feature requests: [GitHub Issues](https://github.com/siddharthksah/Stirling-Image/issues) +Bug reports and feature requests: [GitHub Issues](https://github.com/stirling-image/stirling-image/issues)

- GitHub Sponsors - Ko-fi + GitHub Sponsors + Ko-fi

## License diff --git a/apps/api/src/openapi.yaml b/apps/api/src/openapi.yaml index 24e34084..4f54366a 100644 --- a/apps/api/src/openapi.yaml +++ b/apps/api/src/openapi.yaml @@ -16,7 +16,7 @@ info: Endpoints marked with a lock icon require authentication. Admin-only endpoints are noted in their description. license: name: MIT - url: https://github.com/siddharthksah/Stirling-Image/blob/main/LICENSE + url: https://github.com/stirling-image/stirling-image/blob/main/LICENSE servers: - url: / diff --git a/apps/docs/.vitepress/config.mts b/apps/docs/.vitepress/config.mts index 68e71e41..4717a461 100644 --- a/apps/docs/.vitepress/config.mts +++ b/apps/docs/.vitepress/config.mts @@ -3,15 +3,15 @@ import { defineConfig } from "vitepress"; export default defineConfig({ title: "Stirling Image", description: "Documentation for Stirling Image, a self-hosted image processing suite.", - base: "/Stirling-Image/", + base: "/stirling-image/", srcDir: ".", outDir: "./.vitepress/dist", ignoreDeadLinks: [/localhost/], head: [ ["meta", { name: "theme-color", content: "#3b82f6" }], - ["link", { rel: "icon", type: "image/svg+xml", href: "/Stirling-Image/favicon.svg" }], - ["link", { rel: "llms-txt", href: "/Stirling-Image/llms.txt" }], + ["link", { rel: "icon", type: "image/svg+xml", href: "/stirling-image/favicon.svg" }], + ["link", { rel: "llms-txt", href: "/stirling-image/llms.txt" }], ], themeConfig: { @@ -46,7 +46,7 @@ export default defineConfig({ }, ], - socialLinks: [{ icon: "github", link: "https://github.com/siddharthksah/Stirling-Image" }], + socialLinks: [{ icon: "github", link: "https://github.com/stirling-image/stirling-image" }], search: { provider: "local", @@ -55,11 +55,11 @@ export default defineConfig({ footer: { message: "Released under the MIT License.", copyright: - 'AI-friendly docs available at /llms.txt · /llms-full.txt', + 'AI-friendly docs available at /llms.txt · /llms-full.txt', }, editLink: { - pattern: "https://github.com/siddharthksah/Stirling-Image/edit/main/apps/docs/:path", + pattern: "https://github.com/stirling-image/stirling-image/edit/main/apps/docs/:path", text: "Edit this page on GitHub", }, }, diff --git a/apps/docs/guide/configuration.md b/apps/docs/guide/configuration.md index 615b4423..02cb3e30 100644 --- a/apps/docs/guide/configuration.md +++ b/apps/docs/guide/configuration.md @@ -57,7 +57,7 @@ All configuration is done through environment variables. Every variable has a se ```yaml services: stirling-image: - image: siddharth123sk/stirling-image:latest + image: stirlingimage/stirling-image:latest ports: - "1349:1349" volumes: diff --git a/apps/docs/guide/deployment.md b/apps/docs/guide/deployment.md index 8d19f4f0..1457dcdb 100644 --- a/apps/docs/guide/deployment.md +++ b/apps/docs/guide/deployment.md @@ -7,7 +7,7 @@ Stirling Image ships as a single Docker container. The frontend, API, and Python ```yaml services: stirling-image: - image: siddharth123sk/stirling-image:latest + image: stirlingimage/stirling-image:latest container_name: stirling-image ports: - "1349:1349" @@ -110,7 +110,7 @@ Set `client_max_body_size` to match your `MAX_UPLOAD_SIZE_MB` value. The GitHub repository has two workflows: -- **release.yml** -- On release, builds multi-arch Docker images (amd64 + arm64) and pushes to both Docker Hub (`siddharth123sk/stirling-image`) and GitHub Container Registry (`ghcr.io/siddharthksah/stirling-image`). +- **release.yml** -- On release, builds multi-arch Docker images (amd64 + arm64) and pushes to both Docker Hub (`stirlingimage/stirling-image`) and GitHub Container Registry (`ghcr.io/stirling-image/stirling-image`). - **deploy-docs.yml** -- Builds this documentation site and deploys it to GitHub Pages. Both run automatically. No manual steps needed after merging to `main`. diff --git a/apps/docs/guide/developer.md b/apps/docs/guide/developer.md index 8654c3d0..101e9d92 100644 --- a/apps/docs/guide/developer.md +++ b/apps/docs/guide/developer.md @@ -14,8 +14,8 @@ Python 3.10+ is only needed if you are working on the AI/ML sidecar (background ## Setup ```bash -git clone https://github.com/siddharthksah/Stirling-Image.git -cd Stirling-Image +git clone https://github.com/stirling-image/stirling-image.git +cd stirling-image pnpm install pnpm dev ``` diff --git a/apps/docs/guide/getting-started.md b/apps/docs/guide/getting-started.md index 3e7cd78b..ece177a4 100644 --- a/apps/docs/guide/getting-started.md +++ b/apps/docs/guide/getting-started.md @@ -9,7 +9,7 @@ docker run -d \ --name stirling-image \ -p 1349:1349 \ -v stirling-data:/data \ - siddharth123sk/stirling-image:latest + stirlingimage/stirling-image:latest ``` Open `http://localhost:1349` in your browser. Log in with `admin` / `admin`. @@ -21,7 +21,7 @@ Create a `docker-compose.yml`: ```yaml services: stirling-image: - image: siddharth123sk/stirling-image:latest + image: stirlingimage/stirling-image:latest container_name: stirling-image ports: - "1349:1349" @@ -50,8 +50,8 @@ See [Configuration](./configuration) for the full list of environment variables. Requirements: Node.js 22+, pnpm 9+, Python 3.10+ ```bash -git clone https://github.com/siddharthksah/Stirling-Image.git -cd Stirling-Image +git clone https://github.com/stirling-image/stirling-image.git +cd stirling-image pnpm install ``` diff --git a/apps/docs/public/llms-full.txt b/apps/docs/public/llms-full.txt index 0df4f62f..d742d8dd 100644 --- a/apps/docs/public/llms-full.txt +++ b/apps/docs/public/llms-full.txt @@ -2,8 +2,8 @@ Self-hosted, open-source image processing platform with 30+ tools. Runs in a single Docker container. Resize, compress, convert, remove backgrounds, upscale, run OCR, and more — without sending images to external services. -- GitHub: https://github.com/siddharthksah/Stirling-Image -- Docs: https://siddharthksah.github.io/Stirling-Image/ +- GitHub: https://github.com/stirling-image/stirling-image +- Docs: https://stirling-image.github.io/stirling-image/ - License: MIT --- @@ -19,7 +19,7 @@ docker run -d \ --name stirling-image \ -p 1349:1349 \ -v stirling-data:/data \ - siddharth123sk/stirling-image:latest + stirlingimage/stirling-image:latest ``` Open `http://localhost:1349` in your browser. Log in with `admin` / `admin`. @@ -31,7 +31,7 @@ Create a `docker-compose.yml`: ```yaml services: stirling-image: - image: siddharth123sk/stirling-image:latest + image: stirlingimage/stirling-image:latest container_name: stirling-image ports: - "1349:1349" @@ -58,8 +58,8 @@ docker compose up -d Requirements: Node.js 22+, pnpm 9+, Python 3.10+ ```bash -git clone https://github.com/siddharthksah/Stirling-Image.git -cd Stirling-Image +git clone https://github.com/stirling-image/stirling-image.git +cd stirling-image pnpm install pnpm dev ``` @@ -239,7 +239,7 @@ Keys are prefixed with `si_` followed by 96 hex characters. ```yaml services: stirling-image: - image: siddharth123sk/stirling-image:latest + image: stirlingimage/stirling-image:latest container_name: stirling-image ports: - "1349:1349" diff --git a/apps/docs/public/llms.txt b/apps/docs/public/llms.txt index 771c6166..84e6a01d 100644 --- a/apps/docs/public/llms.txt +++ b/apps/docs/public/llms.txt @@ -4,15 +4,15 @@ ## Docs -- [Getting Started](https://siddharthksah.github.io/Stirling-Image/guide/getting-started): Docker setup, build from source -- [Architecture](https://siddharthksah.github.io/Stirling-Image/guide/architecture): Monorepo structure, request flow, packages -- [Configuration](https://siddharthksah.github.io/Stirling-Image/guide/configuration): Environment variables, Docker volumes -- [Database](https://siddharthksah.github.io/Stirling-Image/guide/database): SQLite schema, tables, migrations -- [Deployment](https://siddharthksah.github.io/Stirling-Image/guide/deployment): Docker Compose, reverse proxy, CI/CD -- [REST API](https://siddharthksah.github.io/Stirling-Image/api/rest): All API endpoints, auth, tools, pipelines, batch -- [Image Engine](https://siddharthksah.github.io/Stirling-Image/api/image-engine): Sharp-based operations (resize, crop, rotate, convert, compress, color) -- [AI Engine](https://siddharthksah.github.io/Stirling-Image/api/ai): Python ML models (rembg, RealESRGAN, PaddleOCR, MediaPipe, LaMa) -- [Full Documentation (LLM-friendly)](https://siddharthksah.github.io/Stirling-Image/llms-full.txt): All docs in a single plain-text file +- [Getting Started](https://stirling-image.github.io/stirling-image/guide/getting-started): Docker setup, build from source +- [Architecture](https://stirling-image.github.io/stirling-image/guide/architecture): Monorepo structure, request flow, packages +- [Configuration](https://stirling-image.github.io/stirling-image/guide/configuration): Environment variables, Docker volumes +- [Database](https://stirling-image.github.io/stirling-image/guide/database): SQLite schema, tables, migrations +- [Deployment](https://stirling-image.github.io/stirling-image/guide/deployment): Docker Compose, reverse proxy, CI/CD +- [REST API](https://stirling-image.github.io/stirling-image/api/rest): All API endpoints, auth, tools, pipelines, batch +- [Image Engine](https://stirling-image.github.io/stirling-image/api/image-engine): Sharp-based operations (resize, crop, rotate, convert, compress, color) +- [AI Engine](https://stirling-image.github.io/stirling-image/api/ai): Python ML models (rembg, RealESRGAN, PaddleOCR, MediaPipe, LaMa) +- [Full Documentation (LLM-friendly)](https://stirling-image.github.io/stirling-image/llms-full.txt): All docs in a single plain-text file ## API Quick Reference @@ -26,5 +26,5 @@ ## Source -- [GitHub](https://github.com/siddharthksah/Stirling-Image) +- [GitHub](https://github.com/stirling-image/stirling-image) - License: MIT diff --git a/apps/web/src/components/help/help-dialog.tsx b/apps/web/src/components/help/help-dialog.tsx index 7a715863..a99b714f 100644 --- a/apps/web/src/components/help/help-dialog.tsx +++ b/apps/web/src/components/help/help-dialog.tsx @@ -99,7 +99,7 @@ export function HelpDialog({ open, onClose }: HelpDialogProps) {
Links