From f21579c7a334108733bca6c8db3dc1b454d475ce Mon Sep 17 00:00:00 2001 From: Siddharth Kumar Sah Date: Sun, 5 Apr 2026 08:03:29 +0800 Subject: [PATCH] docs: fix license (MIT -> AGPLv3), add lite refs to llms.txt and ai.md Both llms.txt and llms-full.txt incorrectly said MIT. Also added lite variant mention to the description and a warning callout on the AI engine docs page noting AI tools are unavailable in the lite image. --- apps/docs/api/ai.md | 4 ++++ apps/docs/public/llms-full.txt | 4 ++-- apps/docs/public/llms.txt | 5 +++-- 3 files changed, 9 insertions(+), 4 deletions(-) diff --git a/apps/docs/api/ai.md b/apps/docs/api/ai.md index 3a224274..e6332da4 100644 --- a/apps/docs/api/ai.md +++ b/apps/docs/api/ai.md @@ -4,6 +4,10 @@ The `@stirling-image/ai` package wraps Python ML models in TypeScript functions. All model weights are bundled in the Docker image during the build. No downloads happen at runtime. +::: warning Lite image +AI tools are not available in the `:lite` Docker image. The API returns `501 Not Available` for these endpoints when running the lite variant. Use `:latest` for AI features. See [Docker Tags](/guide/docker-tags) for details. +::: + ## Background removal Removes the background from an image and returns a transparent PNG. diff --git a/apps/docs/public/llms-full.txt b/apps/docs/public/llms-full.txt index b0fe4842..a2f2924a 100644 --- a/apps/docs/public/llms-full.txt +++ b/apps/docs/public/llms-full.txt @@ -1,10 +1,10 @@ # Stirling Image — Complete Documentation -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. Available as :latest (full, ~11 GB with AI/ML) or :lite (~1.5 GB, image processing only). - GitHub: https://github.com/stirling-image/stirling-image - Docs: https://stirling-image.github.io/stirling-image/ -- License: MIT +- License: AGPLv3 (commercial license also available) --- diff --git a/apps/docs/public/llms.txt b/apps/docs/public/llms.txt index 84e6a01d..41ffaeeb 100644 --- a/apps/docs/public/llms.txt +++ b/apps/docs/public/llms.txt @@ -1,6 +1,6 @@ # Stirling Image -> Self-hosted, open-source image processing platform with 30+ tools. Runs in a single Docker container. +> Self-hosted, open-source image processing platform with 30+ tools. Runs in a single Docker container. Available as `:latest` (full, ~11 GB with AI/ML) or `:lite` (~1.5 GB, image processing only). ## Docs @@ -9,6 +9,7 @@ - [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 +- [Docker Tags](https://stirling-image.github.io/stirling-image/guide/docker-tags): Full vs Lite image variants, version pinning - [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) @@ -27,4 +28,4 @@ ## Source - [GitHub](https://github.com/stirling-image/stirling-image) -- License: MIT +- License: AGPLv3 (commercial license also available)