From fd823e33f0d0bf0002ce71369cf4642a3467478d Mon Sep 17 00:00:00 2001 From: ashim-hq Date: Thu, 16 Apr 2026 17:38:17 +0800 Subject: [PATCH] docs: update getting started guide to include GitHub Container Registry instructions --- README.md | 3 --- apps/docs/guide/getting-started.md | 12 +++++++++++- 2 files changed, 11 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index ddba7f96..3d04a6de 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,6 @@ ```bash docker run -d -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest ``` - -> **Prefer GHCR?** `docker run -d -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest` - Open http://localhost:1349 in your browser.
diff --git a/apps/docs/guide/getting-started.md b/apps/docs/guide/getting-started.md index cfef94ea..01a8f914 100644 --- a/apps/docs/guide/getting-started.md +++ b/apps/docs/guide/getting-started.md @@ -8,6 +8,16 @@ docker run -d -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest Open [http://localhost:1349](http://localhost:1349) in your browser. +::: tip Prefer GitHub Container Registry? +Pull from GHCR instead of Docker Hub: + +```bash +docker run -d -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest +``` + +Both registries publish the same image on every release. GHCR can be faster if you are on a network where Docker Hub is rate-limited. +::: + **Default credentials:** | Field | Value | @@ -32,7 +42,7 @@ Requires the [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud ```yaml services: ashim: - image: ashimhq/ashim:latest + image: ashimhq/ashim:latest # or ghcr.io/ashim-hq/ashim:latest ports: - "1349:1349" volumes: