External/SnapOtter
1
0
Fork 0
mirror of https://github.com/snapotter-hq/SnapOtter.git synced 2026-08-03 07:46:42 +02:00
Code Issues Packages Projects Releases Wiki Activity

chore: rebrand repo from siddharthksah to stirling-image org

Browse Source 
Update all references across docs, workflows, UI components, and config
to point to the new GitHub org (stirling-image/stirling-image) and Docker
Hub account (stirlingimage/stirling-image) ahead of repo transfer.
This commit is contained in:
Siddharth Kumar Sah
2026-03-30 08:17:54 +08:00
parent 8f98b745ff
commit 50a52b43c1
14 changed files with 62 additions and 62 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/FUNDING.yml
+2 -2
View File
@@ -1,2 +1,2 @@
github: siddharthksah github: stirling-image
ko_fi: siddharthksah ko_fi: stirling-image
.github/workflows/release.yml
+1 -1
View File
@@ -83,7 +83,7 @@ jobs:
uses: docker/metadata-action@v5 uses: docker/metadata-action@v5
with: with:
images: | images: |
siddharth123sk/stirling-image stirlingimage/stirling-image
ghcr.io/${{ github.repository }} ghcr.io/${{ github.repository }}
tags: | tags: |
type=semver,pattern={{version}},value=v${{ needs.release.outputs.new_version }} type=semver,pattern={{version}},value=v${{ needs.release.outputs.new_version }}
CONTRIBUTING.md
+5 -5
View File
@@ -40,11 +40,11 @@ Example: `feat: add HEIC to PNG conversion support`
## Development setup ## 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 ```bash
git clone https://github.com/siddharthksah/Stirling-Image.git git clone https://github.com/stirling-image/stirling-image.git
cd Stirling-Image cd stirling-image
pnpm install pnpm install
pnpm dev # starts both frontend and backend 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. 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. 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 ## 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 ## Code style
README.md
+16 -16
View File
@@ -7,10 +7,10 @@
<p align="center">Stirling-PDF but for images. 30+ tools and local AI in a single Docker container.</p> <p align="center">Stirling-PDF but for images. 30+ tools and local AI in a single Docker container.</p>
<p align="center"> <p align="center">
<a href="https://hub.docker.com/r/siddharth123sk/stirling-image"><img src="https://img.shields.io/badge/Docker-Hub-blue?logo=docker" alt="Docker"></a> <a href="https://hub.docker.com/r/stirlingimage/stirling-image"><img src="https://img.shields.io/badge/Docker-Hub-blue?logo=docker" alt="Docker"></a>
<a href="https://github.com/siddharthksah/Stirling-Image/actions"><img src="https://img.shields.io/github/actions/workflow/status/siddharthksah/Stirling-Image/ci.yml?label=CI" alt="CI"></a> <a href="https://github.com/stirling-image/stirling-image/actions"><img src="https://img.shields.io/github/actions/workflow/status/stirling-image/stirling-image/ci.yml?label=CI" alt="CI"></a>
<a href="https://github.com/siddharthksah/Stirling-Image/blob/main/LICENSE"><img src="https://img.shields.io/github/license/siddharthksah/Stirling-Image" alt="License"></a> <a href="https://github.com/stirling-image/stirling-image/blob/main/LICENSE"><img src="https://img.shields.io/github/license/stirling-image/stirling-image" alt="License"></a>
<a href="https://github.com/siddharthksah/Stirling-Image/stargazers"><img src="https://img.shields.io/github/stars/siddharthksah/Stirling-Image?style=social" alt="Stars"></a> <a href="https://github.com/stirling-image/stirling-image/stargazers"><img src="https://img.shields.io/github/stars/stirling-image/stirling-image?style=social" alt="Stars"></a>
</p> </p>
![Stirling Image - Dashboard](images/dashboard.png) ![Stirling Image - Dashboard](images/dashboard.png)
@@ -28,7 +28,7 @@
## Quick Start ## Quick Start
```bash ```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. 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. 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 ## Documentation
- [Getting Started](https://siddharthksah.github.io/Stirling-Image/guide/getting-started) - [Getting Started](https://stirling-image.github.io/stirling-image/guide/getting-started)
- [Configuration](https://siddharthksah.github.io/Stirling-Image/guide/configuration) - [Configuration](https://stirling-image.github.io/stirling-image/guide/configuration)
- [REST API](https://siddharthksah.github.io/Stirling-Image/api/rest) - [REST API](https://stirling-image.github.io/stirling-image/api/rest)
- [Architecture](https://siddharthksah.github.io/Stirling-Image/guide/architecture) - [Architecture](https://stirling-image.github.io/stirling-image/guide/architecture)
- [Developer Guide](https://siddharthksah.github.io/Stirling-Image/guide/developer) - [Developer Guide](https://stirling-image.github.io/stirling-image/guide/developer)
- [Translation Guide](https://siddharthksah.github.io/Stirling-Image/guide/translations) - [Translation Guide](https://stirling-image.github.io/stirling-image/guide/translations)
## Contributing ## 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 ## 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)
<p align="center"> <p align="center">
<a href="https://github.com/sponsors/siddharthksah"><img src="https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?logo=github-sponsors" alt="GitHub Sponsors"></a> <a href="https://github.com/sponsors/stirling-image"><img src="https://img.shields.io/badge/Sponsor-GitHub-ea4aaa?logo=github-sponsors" alt="GitHub Sponsors"></a>
<a href="https://ko-fi.com/siddharthksah"><img src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Ko--fi-FF5E5B?logo=ko-fi" alt="Ko-fi"></a> <a href="https://ko-fi.com/stirling-image"><img src="https://img.shields.io/badge/Buy%20Me%20a%20Coffee-Ko--fi-FF5E5B?logo=ko-fi" alt="Ko-fi"></a>
</p> </p>
## License ## License
apps/api/src/openapi.yaml
+1 -1
View File
@@ -16,7 +16,7 @@ info:
Endpoints marked with a lock icon require authentication. Admin-only endpoints are noted in their description. Endpoints marked with a lock icon require authentication. Admin-only endpoints are noted in their description.
license: license:
name: MIT name: MIT
url: https://github.com/siddharthksah/Stirling-Image/blob/main/LICENSE url: https://github.com/stirling-image/stirling-image/blob/main/LICENSE
servers: servers:
- url: / - url: /
apps/docs/.vitepress/config.mts
+6 -6
View File
@@ -3,15 +3,15 @@ import { defineConfig } from "vitepress";
export default defineConfig({ export default defineConfig({
title: "Stirling Image", title: "Stirling Image",
description: "Documentation for Stirling Image, a self-hosted image processing suite.", description: "Documentation for Stirling Image, a self-hosted image processing suite.",
base: "/Stirling-Image/", base: "/stirling-image/",
srcDir: ".", srcDir: ".",
outDir: "./.vitepress/dist", outDir: "./.vitepress/dist",
ignoreDeadLinks: [/localhost/], ignoreDeadLinks: [/localhost/],
head: [ head: [
["meta", { name: "theme-color", content: "#3b82f6" }], ["meta", { name: "theme-color", content: "#3b82f6" }],
["link", { rel: "icon", type: "image/svg+xml", href: "/Stirling-Image/favicon.svg" }], ["link", { rel: "icon", type: "image/svg+xml", href: "/stirling-image/favicon.svg" }],
["link", { rel: "llms-txt", href: "/Stirling-Image/llms.txt" }], ["link", { rel: "llms-txt", href: "/stirling-image/llms.txt" }],
], ],
themeConfig: { 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: { search: {
provider: "local", provider: "local",
@@ -55,11 +55,11 @@ export default defineConfig({
footer: { footer: {
message: "Released under the MIT License.", message: "Released under the MIT License.",
copyright: copyright:
'AI-friendly docs available at <a href="/Stirling-Image/llms.txt">/llms.txt</a> · <a href="/Stirling-Image/llms-full.txt">/llms-full.txt</a>', 'AI-friendly docs available at <a href="/stirling-image/llms.txt">/llms.txt</a> · <a href="/stirling-image/llms-full.txt">/llms-full.txt</a>',
}, },
editLink: { 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", text: "Edit this page on GitHub",
}, },
}, },
apps/docs/guide/configuration.md
+1 -1
View File
@@ -57,7 +57,7 @@ All configuration is done through environment variables. Every variable has a se
```yaml ```yaml
services: services:
stirling-image: stirling-image:
image: siddharth123sk/stirling-image:latest image: stirlingimage/stirling-image:latest
ports: ports:
- "1349:1349" - "1349:1349"
volumes: volumes:
apps/docs/guide/deployment.md
+2 -2
View File
@@ -7,7 +7,7 @@ Stirling Image ships as a single Docker container. The frontend, API, and Python
```yaml ```yaml
services: services:
stirling-image: stirling-image:
image: siddharth123sk/stirling-image:latest image: stirlingimage/stirling-image:latest
container_name: stirling-image container_name: stirling-image
ports: ports:
- "1349:1349" - "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: 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. - **deploy-docs.yml** -- Builds this documentation site and deploys it to GitHub Pages.
Both run automatically. No manual steps needed after merging to `main`. Both run automatically. No manual steps needed after merging to `main`.
apps/docs/guide/developer.md
+2 -2
View File
@@ -14,8 +14,8 @@ Python 3.10+ is only needed if you are working on the AI/ML sidecar (background
## Setup ## Setup
```bash ```bash
git clone https://github.com/siddharthksah/Stirling-Image.git git clone https://github.com/stirling-image/stirling-image.git
cd Stirling-Image cd stirling-image
pnpm install pnpm install
pnpm dev pnpm dev
``` ```
apps/docs/guide/getting-started.md
+4 -4
View File
@@ -9,7 +9,7 @@ docker run -d \
--name stirling-image \ --name stirling-image \
-p 1349:1349 \ -p 1349:1349 \
-v stirling-data:/data \ -v stirling-data:/data \
siddharth123sk/stirling-image:latest stirlingimage/stirling-image:latest
``` ```
Open `http://localhost:1349` in your browser. Log in with `admin` / `admin`. Open `http://localhost:1349` in your browser. Log in with `admin` / `admin`.
@@ -21,7 +21,7 @@ Create a `docker-compose.yml`:
```yaml ```yaml
services: services:
stirling-image: stirling-image:
image: siddharth123sk/stirling-image:latest image: stirlingimage/stirling-image:latest
container_name: stirling-image container_name: stirling-image
ports: ports:
- "1349:1349" - "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+ Requirements: Node.js 22+, pnpm 9+, Python 3.10+
```bash ```bash
git clone https://github.com/siddharthksah/Stirling-Image.git git clone https://github.com/stirling-image/stirling-image.git
cd Stirling-Image cd stirling-image
pnpm install pnpm install
``` ```
apps/docs/public/llms-full.txt
+7 -7
View File
@@ -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. 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 - GitHub: https://github.com/stirling-image/stirling-image
- Docs: https://siddharthksah.github.io/Stirling-Image/ - Docs: https://stirling-image.github.io/stirling-image/
- License: MIT - License: MIT
--- ---
@@ -19,7 +19,7 @@ docker run -d \
--name stirling-image \ --name stirling-image \
-p 1349:1349 \ -p 1349:1349 \
-v stirling-data:/data \ -v stirling-data:/data \
siddharth123sk/stirling-image:latest stirlingimage/stirling-image:latest
``` ```
Open `http://localhost:1349` in your browser. Log in with `admin` / `admin`. Open `http://localhost:1349` in your browser. Log in with `admin` / `admin`.
@@ -31,7 +31,7 @@ Create a `docker-compose.yml`:
```yaml ```yaml
services: services:
stirling-image: stirling-image:
image: siddharth123sk/stirling-image:latest image: stirlingimage/stirling-image:latest
container_name: stirling-image container_name: stirling-image
ports: ports:
- "1349:1349" - "1349:1349"
@@ -58,8 +58,8 @@ docker compose up -d
Requirements: Node.js 22+, pnpm 9+, Python 3.10+ Requirements: Node.js 22+, pnpm 9+, Python 3.10+
```bash ```bash
git clone https://github.com/siddharthksah/Stirling-Image.git git clone https://github.com/stirling-image/stirling-image.git
cd Stirling-Image cd stirling-image
pnpm install pnpm install
pnpm dev pnpm dev
``` ```
@@ -239,7 +239,7 @@ Keys are prefixed with `si_` followed by 96 hex characters.
```yaml ```yaml
services: services:
stirling-image: stirling-image:
image: siddharth123sk/stirling-image:latest image: stirlingimage/stirling-image:latest
container_name: stirling-image container_name: stirling-image
ports: ports:
- "1349:1349" - "1349:1349"
apps/docs/public/llms.txt
+10 -10
View File
@@ -4,15 +4,15 @@
## Docs ## Docs
- [Getting Started](https://siddharthksah.github.io/Stirling-Image/guide/getting-started): Docker setup, build from source - [Getting Started](https://stirling-image.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 - [Architecture](https://stirling-image.github.io/stirling-image/guide/architecture): Monorepo structure, request flow, packages
- [Configuration](https://siddharthksah.github.io/Stirling-Image/guide/configuration): Environment variables, Docker volumes - [Configuration](https://stirling-image.github.io/stirling-image/guide/configuration): Environment variables, Docker volumes
- [Database](https://siddharthksah.github.io/Stirling-Image/guide/database): SQLite schema, tables, migrations - [Database](https://stirling-image.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 - [Deployment](https://stirling-image.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 - [REST API](https://stirling-image.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) - [Image Engine](https://stirling-image.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) - [AI Engine](https://stirling-image.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 - [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 ## API Quick Reference
@@ -26,5 +26,5 @@
## Source ## Source
- [GitHub](https://github.com/siddharthksah/Stirling-Image) - [GitHub](https://github.com/stirling-image/stirling-image)
- License: MIT - License: MIT
apps/web/src/components/help/help-dialog.tsx
+3 -3
View File
@@ -99,7 +99,7 @@ export function HelpDialog({ open, onClose }: HelpDialogProps) {
</div> </div>
<div className="flex flex-col gap-1.5"> <div className="flex flex-col gap-1.5">
<a <a
href="https://github.com/siddharthksah/Stirling-Image" href="https://github.com/stirling-image/stirling-image"
target="_blank" target="_blank"
rel="noopener noreferrer" rel="noopener noreferrer"
className="flex items-center gap-1.5 text-sm text-primary hover:underline" className="flex items-center gap-1.5 text-sm text-primary hover:underline"
@@ -108,7 +108,7 @@ export function HelpDialog({ open, onClose }: HelpDialogProps) {
<ExternalLink className="h-3 w-3" /> <ExternalLink className="h-3 w-3" />
</a> </a>
<a <a
href="https://github.com/siddharthksah/Stirling-Image/issues" href="https://github.com/stirling-image/stirling-image/issues"
target="_blank" target="_blank"
rel="noopener noreferrer" rel="noopener noreferrer"
className="flex items-center gap-1.5 text-sm text-primary hover:underline" className="flex items-center gap-1.5 text-sm text-primary hover:underline"
@@ -117,7 +117,7 @@ export function HelpDialog({ open, onClose }: HelpDialogProps) {
<ExternalLink className="h-3 w-3" /> <ExternalLink className="h-3 w-3" />
</a> </a>
<a <a
href="https://siddharthksah.github.io/Stirling-Image/" href="https://stirling-image.github.io/stirling-image/"
target="_blank" target="_blank"
rel="noopener noreferrer" rel="noopener noreferrer"
className="flex items-center gap-1.5 text-sm text-primary hover:underline" className="flex items-center gap-1.5 text-sm text-primary hover:underline"
apps/web/src/components/settings/settings-dialog.tsx
+2 -2
View File
@@ -1718,7 +1718,7 @@ function AboutSection() {
<h4 className="text-sm font-medium text-foreground">Links</h4> <h4 className="text-sm font-medium text-foreground">Links</h4>
<div className="flex flex-col gap-1.5"> <div className="flex flex-col gap-1.5">
<a <a
href="https://github.com/siddharthksah/Stirling-Image" href="https://github.com/stirling-image/stirling-image"
target="_blank" target="_blank"
rel="noopener noreferrer" rel="noopener noreferrer"
className="text-sm text-primary hover:underline" className="text-sm text-primary hover:underline"
@@ -1726,7 +1726,7 @@ function AboutSection() {
GitHub Repository GitHub Repository
</a> </a>
<a <a
href="https://siddharthksah.github.io/Stirling-Image/" href="https://stirling-image.github.io/stirling-image/"
target="_blank" target="_blank"
rel="noopener noreferrer" rel="noopener noreferrer"
className="text-sm text-primary hover:underline" className="text-sm text-primary hover:underline"