Skip to content

docs: update repo/image references after GitHub rename to dockpull #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
StrandedTurtle merged 1 commit into from
Jun 27, 2026
Merged

docs: update repo/image references after GitHub rename to dockpull #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ The full endpoint/field reference is in [`API_CONTRACT.md`](./API_CONTRACT.md).

```bash
# on your Docker host
git clone <your-fork-url> diupdater && cd diupdater
git clone <your-fork-url> dockpull && cd dockpull
cp .env.example .env

# fill in .env:
Expand All @@ -107,7 +107,7 @@ existing compose file (e.g. a `management` stack) and fill in the two secrets.
```yaml
services:
dockpull:
image: ghcr.io/strandedturtle/diupdater:edge
image: ghcr.io/strandedturtle/dockpull:edge
container_name: dockpull
restart: unless-stopped
ports:
Expand Down Expand Up @@ -142,7 +142,7 @@ semver tags (`:0.1.0`, `:0.1`). Pin to a version for stability.

> **Can't pull the image?** The GHCR package inherits the repo's visibility. To
> let other hosts pull it without auth, make the package public: GitHub → your
> avatar → **Packages** → `diupdater` → **Package settings** → **Change
> avatar → **Packages** → `dockpull` → **Package settings** → **Change
> visibility** → *Public*. Otherwise run `docker login ghcr.io` (with a PAT that
> has `read:packages`) on each host first.

Expand All @@ -157,8 +157,8 @@ build from source? Use [Step-by-step setup](#step-by-step-setup) below instead.
### 1. Get the code onto your server

```bash
git clone <your-fork-url> diupdater
cd diupdater
git clone <your-fork-url> dockpull
cd dockpull
```

### 2. Create your `.env`
Expand Down Expand Up @@ -235,7 +235,7 @@ enter `ADMIN_PASSWORD`, and the dashboard will run an initial update check.

> **Prefer a prebuilt image?** Releases publish a multi-arch image
> (`linux/amd64` + `linux/arm64`) to GHCR. Instead of `build:`, point the
> compose service at `image: ghcr.io/strandedturtle/diupdater:edge` (keep the
> compose service at `image: ghcr.io/strandedturtle/dockpull:edge` (keep the
> same environment + volumes) and `docker compose up -d` (no `--build`).

### 5. (Optional) Expose it with a Cloudflare Tunnel
Expand Down
Loading