Elgato_dark/ashim
1
0
Fork 0
mirror of https://github.com/ashim-hq/ashim synced 2026-04-21 13:37:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update Docker image references to use GitHub Container Registry

Browse source
This commit is contained in:
ashim-hq 2026-04-16 17:51:14 +08:00
parent fd823e33f0
commit e516cee836
2 changed files with 7 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -29,7 +29,7 @@
## Quick Start
```bash
docker run -d -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest
docker run -d -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 ashimhq/ashim:latest
docker run -d -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.

12
apps/docs/guide/getting-started.md
View file

@ -3,19 +3,17 @@
## Quick Start
```bash
docker run -d -p 1349:1349 -v ashim-data:/data ashimhq/ashim:latest
docker run -d -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest
```
Open [http://localhost:1349](http://localhost:1349) in your browser.
::: tip Prefer GitHub Container Registry?
Pull from GHCR instead of Docker Hub:
::: tip Also on Docker Hub
```bash
docker run -d -p 1349:1349 -v ashim-data:/data ghcr.io/ashim-hq/ashim:latest
docker run -d -p 1349:1349 -v ashim-data:/data ashimhq/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.
Both registries publish the same image on every release.
:::
**Default credentials:**
@ -42,7 +40,7 @@ Requires the [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud
```yaml
services:
ashim:
image: ashimhq/ashim:latest # or ghcr.io/ashim-hq/ashim:latest
image: ghcr.io/ashim-hq/ashim:latest # or ashimhq/ashim:latest
ports:
- "1349:1349"
volumes: