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

docs: fix license (MIT -> AGPLv3), add lite refs to llms.txt and ai.md

Browse Source 
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.
This commit is contained in:
Siddharth Kumar Sah
2026-04-05 08:03:29 +08:00
parent be45d3ca80
commit f21579c7a3
3 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
apps/docs/api/ai.md
+4
View File
@@ -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.
apps/docs/public/llms-full.txt
+2 -2
View File
@@ -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)
---
apps/docs/public/llms.txt
+3 -2
View File
@@ -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)