You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33-5Lines changed: 33 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,13 +16,40 @@ Runs as a single Docker container with a built-in web UI. No external services,
16
16
17
17
## Requirements
18
18
19
-
- Docker + Docker Compose
19
+
- Docker
20
20
- A running [MeTube](https://github.com/alexta69/metube) instance
21
21
- (Optional) A running [Jellyfin](https://jellyfin.org) instance
22
22
23
23
---
24
24
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)
26
53
27
54
No clone required. Create a `docker-compose.yml`:
28
55
@@ -35,12 +62,15 @@ services:
35
62
ports:
36
63
- "8083:8083"
37
64
volumes:
38
-
- ./data:/data
65
+
- tubechecker-data:/data
39
66
environment:
40
67
- METUBE_URL=http://your-metube-host:8081
41
68
- CHECK_INTERVAL=60
42
69
# - JELLYFIN_URL=http://your-jellyfin-host:8096
43
70
# - JELLYFIN_API_KEY=your_key_here
71
+
72
+
volumes:
73
+
tubechecker-data:
44
74
```
45
75
46
76
Then run:
@@ -51,8 +81,6 @@ docker compose up -d
51
81
52
82
The UI is available at `http://localhost:8083`.
53
83
54
-
Open **Settings** and set your MeTube URL, then add channels from the **Channels** view.
55
-
56
84
---
57
85
58
86
## Integration into an Existing Docker Compose Stack
0 commit comments