mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
fix: use Docker Hub as primary one-liner (GHCR is private)
GHCR packages default to private and require docker login. Switch the primary quick-start command to Docker Hub (snapotter/snapotter) which is publicly accessible. GHCR remains available as an alternative.
This commit is contained in:
@@ -25,7 +25,7 @@
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest
|
||||
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest
|
||||
```
|
||||
Open http://localhost:1349 in your browser.
|
||||
|
||||
@@ -36,7 +36,7 @@ Open http://localhost:1349 in your browser.
|
||||
Add `--gpus all` for GPU-accelerated background removal, upscaling, and OCR:
|
||||
|
||||
```bash
|
||||
docker run -d --name SnapOtter -p 1349:1349 --gpus all -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest
|
||||
docker run -d --name SnapOtter -p 1349:1349 --gpus all -v SnapOtter-data:/data snapotter/snapotter: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://docs.snapotter.com/guide/docker-tags) for benchmarks and Docker Compose examples.
|
||||
|
||||
@@ -3,14 +3,14 @@
|
||||
## Quick Start
|
||||
|
||||
```bash
|
||||
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest
|
||||
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest
|
||||
```
|
||||
|
||||
Open [http://localhost:1349](http://localhost:1349) in your browser.
|
||||
|
||||
::: tip Also on Docker Hub
|
||||
::: tip Also on GHCR
|
||||
```bash
|
||||
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest
|
||||
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.
|
||||
@@ -40,7 +40,7 @@ Requires the [NVIDIA Container Toolkit](https://docs.nvidia.com/datacenter/cloud
|
||||
```yaml
|
||||
services:
|
||||
SnapOtter:
|
||||
image: ghcr.io/snapotter-hq/snapotter:latest # or snapotter/snapotter:latest
|
||||
image: snapotter/snapotter:latest # or ghcr.io/snapotter-hq/snapotter:latest
|
||||
ports:
|
||||
- "1349:1349"
|
||||
volumes:
|
||||
|
||||
+1
-1
@@ -31,7 +31,7 @@ features:
|
||||
<div class="quick-start-banner">
|
||||
|
||||
```bash
|
||||
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest
|
||||
docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest
|
||||
```
|
||||
|
||||
</div>
|
||||
|
||||
@@ -6,7 +6,7 @@ import { useState } from "react";
|
||||
import { FadeIn } from "./fade-in";
|
||||
|
||||
const command =
|
||||
"docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest";
|
||||
"docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest";
|
||||
|
||||
export function HowItWorks() {
|
||||
const [copied, setCopied] = useState(false);
|
||||
|
||||
@@ -27,7 +27,7 @@ beforeEach(() => {
|
||||
afterEach(cleanup);
|
||||
|
||||
const DOCKER_COMMAND =
|
||||
"docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data ghcr.io/snapotter-hq/snapotter:latest";
|
||||
"docker run -d --name SnapOtter -p 1349:1349 -v SnapOtter-data:/data snapotter/snapotter:latest";
|
||||
|
||||
describe("HowItWorks", () => {
|
||||
it("renders the section heading", () => {
|
||||
|
||||
Reference in New Issue
Block a user