Skip to content

Commit 32f02b1

Browse files
committed
Update readme, add ARM support
1 parent 21f6ada commit 32f02b1

2 files changed

Lines changed: 34 additions & 5 deletions

File tree

.github/workflows/docker-publish.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,7 @@ jobs:
4747
uses: docker/build-push-action@v5
4848
with:
4949
context: .
50+
platforms: linux/amd64,linux/arm64
5051
push: true
5152
tags: ${{ steps.meta.outputs.tags }}
5253
labels: ${{ steps.meta.outputs.labels }}

README.md

Lines changed: 33 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,40 @@ Runs as a single Docker container with a built-in web UI. No external services,
1616

1717
## Requirements
1818

19-
- Docker + Docker Compose
19+
- Docker
2020
- A running [MeTube](https://github.com/alexta69/metube) instance
2121
- (Optional) A running [Jellyfin](https://jellyfin.org) instance
2222

2323
---
2424

25-
## Quick Start (published image)
25+
## Quick Start (docker run)
26+
27+
```bash
28+
docker run -d \
29+
--name tubechecker \
30+
-p 8083:8083 \
31+
-v tubechecker-data:/data \
32+
-e METUBE_URL=http://your-metube-host:8081 \
33+
ghcr.io/spaggel/tubechecker:latest
34+
```
35+
36+
The UI is available at `http://localhost:8083`.
37+
38+
Open **Settings** to confirm the MeTube URL, then add channels from the **Channels** view.
39+
40+
> **If MeTube is also running in Docker on the same machine**, containers can't reach each other via `localhost`. Either place both on a shared network:
41+
> ```bash
42+
> docker network create media
43+
> docker run -d --name tubechecker --network media -p 8083:8083 \
44+
> -v tubechecker-data:/data \
45+
> -e METUBE_URL=http://metube:8081 \
46+
> ghcr.io/spaggel/tubechecker:latest
47+
> ```
48+
> Or use `host.docker.internal` as the hostname (Mac/Windows only; Linux typically uses `172.17.0.1`).
49+
50+
---
51+
52+
## Quick Start (docker compose)
2653
2754
No clone required. Create a `docker-compose.yml`:
2855
@@ -35,12 +62,15 @@ services:
3562
ports:
3663
- "8083:8083"
3764
volumes:
38-
- ./data:/data
65+
- tubechecker-data:/data
3966
environment:
4067
- METUBE_URL=http://your-metube-host:8081
4168
- CHECK_INTERVAL=60
4269
# - JELLYFIN_URL=http://your-jellyfin-host:8096
4370
# - JELLYFIN_API_KEY=your_key_here
71+
72+
volumes:
73+
tubechecker-data:
4474
```
4575
4676
Then run:
@@ -51,8 +81,6 @@ docker compose up -d
5181

5282
The UI is available at `http://localhost:8083`.
5383

54-
Open **Settings** and set your MeTube URL, then add channels from the **Channels** view.
55-
5684
---
5785

5886
## Integration into an Existing Docker Compose Stack

0 commit comments

Comments
 (0)