From 6a44c455a33e47642e547456ac5546ee542f3cfb Mon Sep 17 00:00:00 2001 From: SnapOtter Date: Fri, 1 May 2026 19:42:11 +0800 Subject: [PATCH] fix: remove printf banner from docker commands in docs The printf welcome banner was overflowing code blocks on docs.snapotter.com, making docker commands hard to read and copy. --- apps/docs/guide/docker-tags.md | 6 ++---- apps/docs/guide/getting-started.md | 9 +++------ apps/docs/index.md | 3 +-- 3 files changed, 6 insertions(+), 12 deletions(-) diff --git a/apps/docs/guide/docker-tags.md b/apps/docs/guide/docker-tags.md index b278716a..6bdbe966 100644 --- a/apps/docs/guide/docker-tags.md +++ b/apps/docs/guide/docker-tags.md @@ -5,8 +5,7 @@ SnapOtter ships as a single Docker image that works on all platforms. ## Quick start ```bash -docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest \ - && printf "\n 🦦 SnapOtter\n ────────────────────────────────────────\n\n ➜ Open http://localhost:1349\n ➜ Login admin / admin\n ➜ Docs https://docs.snapotter.com\n\n" +docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest ``` ## GPU acceleration @@ -14,8 +13,7 @@ docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/sn The image includes CUDA support on amd64. If you have an NVIDIA GPU with the [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html) installed, add `--gpus all`: ```bash -docker run -d --name SnapOtter --gpus all -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest \ - && printf "\n 🦦 SnapOtter\n ────────────────────────────────────────\n\n ➜ Open http://localhost:1349\n ➜ Login admin / admin\n ➜ Docs https://docs.snapotter.com\n\n" +docker run -d --name SnapOtter --gpus all -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest ``` The image auto-detects your GPU at runtime. Without `--gpus all`, it runs on CPU. Same image either way. diff --git a/apps/docs/guide/getting-started.md b/apps/docs/guide/getting-started.md index dbf0a3e9..d7e760b8 100644 --- a/apps/docs/guide/getting-started.md +++ b/apps/docs/guide/getting-started.md @@ -3,16 +3,14 @@ ## Quick Start ```bash -docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest \ - && printf "\n 🦦 SnapOtter\n ────────────────────────────────────────\n\n ➜ Open http://localhost:1349\n ➜ Login admin / admin\n ➜ Docs https://docs.snapotter.com\n\n" +docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest ``` You will be asked to change your password on first login. ::: tip Also on GHCR ```bash -docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest \ - && printf "\n 🦦 SnapOtter\n ────────────────────────────────────────\n\n ➜ Open http://localhost:1349\n ➜ Login admin / admin\n ➜ Docs https://docs.snapotter.com\n\n" +docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest ``` Both registries publish the same image on every release. @@ -22,8 +20,7 @@ Both registries publish the same image on every release. Add `--gpus all` for GPU-accelerated background removal, upscaling, OCR, face enhancement, and restoration: ```bash -docker run -d --name SnapOtter -p 1349:1349 --gpus all -v SnapOtter-data:/data snapotter/snapotter:latest \ - && printf "\n 🦦 SnapOtter\n ────────────────────────────────────────\n\n ➜ Open http://localhost:1349\n ➜ Login admin / admin\n ➜ Docs https://docs.snapotter.com\n\n" +docker run -d --name SnapOtter -p 1349:1349 --gpus all -v SnapOtter-data:/data snapotter/snapotter:latest ``` Requires the [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html). Falls back to CPU automatically. See [Docker Tags](/guide/docker-tags) for benchmarks. diff --git a/apps/docs/index.md b/apps/docs/index.md index b38e1f0a..d2baabb7 100644 --- a/apps/docs/index.md +++ b/apps/docs/index.md @@ -31,8 +31,7 @@ features:
```bash -docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest \ - && printf "\n 🦦 SnapOtter\n ────────────────────────────────────────\n\n ➜ Open http://localhost:1349\n ➜ Login admin / admin\n ➜ Docs https://docs.snapotter.com\n\n" +docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest ```