diff --git a/README.md b/README.md index 8acb1ea8..a44f8ec6 100644 --- a/README.md +++ b/README.md @@ -29,7 +29,7 @@ ## Quick Start ```bash -docker run -d -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest +docker run -d --name ashim -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest ``` Open http://localhost:1349 in your browser. @@ -40,7 +40,7 @@ Open http://localhost:1349 in your browser. Add `--gpus all` for GPU-accelerated background removal, upscaling, and OCR: ```bash -docker run -d -p 1349:1349 --gpus all -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest +docker run -d --name ashim -p 1349:1349 --gpus all -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest ``` > Requires an NVIDIA GPU and [Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html). Falls back to CPU if no GPU is found. See [Docker Tags](https://ashim-hq.github.io/ashim/guide/docker-tags) for benchmarks and Docker Compose examples. diff --git a/apps/docs/.vitepress/theme/github-stars.css b/apps/docs/.vitepress/theme/github-stars.css index 93e7ed94..fe0fd1b1 100644 --- a/apps/docs/.vitepress/theme/github-stars.css +++ b/apps/docs/.vitepress/theme/github-stars.css @@ -1,3 +1,16 @@ +/* Quick start command banner on homepage */ +.quick-start-banner { + max-width: 640px; + margin: -16px auto 48px; + padding: 0 24px; + text-align: center; +} + +.quick-start-banner div[class*="language-"] { + margin: 0; + border-radius: 10px; +} + /* Hide the three-dots extra menu - its contents are now in the navbar directly */ .VPNavBarExtra { display: none !important; diff --git a/apps/docs/guide/docker-tags.md b/apps/docs/guide/docker-tags.md index 69bb2700..a4a14d57 100644 --- a/apps/docs/guide/docker-tags.md +++ b/apps/docs/guide/docker-tags.md @@ -5,7 +5,7 @@ ashim ships as a single Docker image that works on all platforms. ## Quick start ```bash -docker run -d -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest +docker run -d --name ashim -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest ``` The app is available at `http://localhost:1349`. @@ -15,7 +15,7 @@ The app is available at `http://localhost:1349`. 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 --gpus all -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest +docker run -d --name ashim --gpus all -p 1349:1349 -v ashim-data:/data ashimhq/ashim: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 426ccbc8..f005a855 100644 --- a/apps/docs/guide/getting-started.md +++ b/apps/docs/guide/getting-started.md @@ -3,14 +3,14 @@ ## Quick Start ```bash -docker run -d -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest +docker run -d --name ashim -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest ``` Open [http://localhost:1349](http://localhost:1349) in your browser. ::: tip Also on Docker Hub ```bash -docker run -d -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest +docker run -d --name ashim -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest ``` Both registries publish the same image on every release. @@ -29,7 +29,7 @@ You will be asked to change your password on first login. Add `--gpus all` for GPU-accelerated background removal, upscaling, OCR, face enhancement, and restoration: ```bash -docker run -d -p 1349:1349 --gpus all -v ashim-data:/data ashimhq/ashim:latest +docker run -d --name ashim -p 1349:1349 --gpus all -v ashim-data:/data ashimhq/ashim: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 137b7dc4..bad55d83 100644 --- a/apps/docs/index.md +++ b/apps/docs/index.md @@ -27,3 +27,11 @@ features: - title: Teams & Access Control details: Multi-user support with admin/user roles, team grouping, per-resource permissions, and audit logging for all sensitive actions. --- + +
+ +```bash +docker run -d --name ashim -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest +``` + +