Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 12 additions & 1 deletion INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,10 +97,21 @@ RetroIPTVGuide v3.2.0 introduces **official Docker and TrueNAS SCALE App support

```bash
git clone https://github.com/thehack904/RetroIPTVGuide.git
cd RetroIPTVGuide
cd RetroIPTVGuide/docker
cp .env.example .env
docker compose up -d
```


## 🐳 Quick Docker Run

The fastest way to launch **RetroIPTVGuide v3.2.0**:

```bash
docker pull ghcr.io/thehack904/retroiptvguide:latest
docker run -d --name retroiptvguide -p 5000:5000 -e TZ=America/Chicago -e SECRET_KEY=$(openssl rand -hex 32) -v $(pwd)/config:/app/config -v $(pwd)/logs:/app/logs -v $(pwd)/data:/app/data ghcr.io/thehack904/retroiptvguide:latest
```

---

## Access
Expand Down
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,30 @@
# RetroIPTVGuide

![Version](https://img.shields.io/badge/version-v3.2.0-blue)
<p align="center">
<a href="https://github.com/thehack904/RetroIPTVGuide">
<img src="https://img.shields.io/badge/version-v3.2.0-blue?style=for-the-badge" alt="Version">
</a>
<a href="https://github.com/thehack904/RetroIPTVGuide/pkgs/container/retroiptvguide">
<img src="https://img.shields.io/badge/GHCR-ghcr.io/thehack904/retroiptvguide-green?style=for-the-badge&logo=docker" alt="GHCR">
</a>
<a href="https://github.com/thehack904/RetroIPTVGuide/actions/workflows/docker-publish.yml">
<img src="https://img.shields.io/github/actions/workflow/status/thehack904/RetroIPTVGuide/docker-publish.yml?style=for-the-badge&logo=github" alt="Build Status">
</a>
<a href="https://creativecommons.org/licenses/by-nc-sa/4.0/">
<img src="https://img.shields.io/badge/license-CC--BY--NC--SA%204.0-lightgrey?style=for-the-badge" alt="License">
</a>
</p>


---

## 📦 Image Information

| Registry | Image | Architectures | Updated |
|-----------|--------|----------------|----------|
| **GitHub Container Registry** | `ghcr.io/thehack904/retroiptvguide:latest` | amd64 / arm64 | Automatically via CI/CD |

---

RetroIPTVGuide is an IPTV Web Interface inspired by 90s/2000s cable TV guides.
It is designed to work with [ErsatzTV](https://ersatztv.org/) [(GitRepo)](https://github.com/ErsatzTV/ErsatzTV/tree/main) but supports any `.m3u`, `.m3u8`, and `.xml` IPTV source.
Expand All @@ -14,7 +38,6 @@ Now includes **Docker and TrueNAS SCALE deployment support** for easy installati
- [License](LICENSE)

---

## 🚀 Containerized Deployment (v3.2.0)

### 🐳 Docker
Expand Down
18 changes: 18 additions & 0 deletions docker/.env.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# ============================================
# RetroIPTVGuide Environment Configuration
# ============================================

# System Settings
TZ=America/Chicago
FLASK_ENV=production
PYTHONUNBUFFERED=1

# Security
SECRET_KEY=change_me_securely

# Files / Logs
DATABASE_FILE=retroiptv.db
LOG_FILE=retroiptv.log

# Internal Flask Port
FLASK_PORT=5000
112 changes: 112 additions & 0 deletions docker/README_DOCKER.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
# 🐳 RetroIPTVGuide Docker Deployment

This folder contains everything you need to deploy **RetroIPTVGuide** via Docker or Docker Compose.

---

## 🚀 Quick Start

### 1️⃣ Clone the repository and navigate into the Docker directory
```bash
git clone https://github.com/thehack904/RetroIPTVGuide.git
cd RetroIPTVGuide/docker
```

### 2️⃣ Create a `.env` file from the example
```bash
cp .env.example .env
```
Edit `.env` to set your timezone and secret key.

### 3️⃣ Launch the container
```bash
docker compose up -d
```

### 4️⃣ Access the web interface
```
http://<your-server-ip>:5000
```

---

## 🔄 Updating
```bash
docker compose pull && docker compose up -d
```

---

## 🧹 Uninstalling
```bash
docker compose down -v
```
This stops and removes the container, volumes, and network.

---

## 🧱 Directory Layout
```
docker/
├── docker-compose.yml
├── .env.example
├── config/ → Persistent configuration files
├── data/ → SQLite database files
└── logs/ → Application logs
```
Docker automatically creates these directories on first run if they don’t exist.

---

## 🧠 Notes
- The container image supports both **amd64** and **arm64** (e.g. Raspberry Pi).
- Default exposed port: **5000**
- Default image: `ghcr.io/thehack904/retroiptvguide:latest`
- Restart policy: `unless-stopped`
- Logs, configs, and data persist between updates.

---

## 🧩 Example Commands

View logs:
```bash
docker compose logs -f
```

Restart the container:
```bash
docker compose restart
```

Stop the container:
```bash
docker compose down
```

---

## 🧰 Customization

You can override settings directly in the `.env` file:

| Variable | Description | Example |
|-----------|--------------|----------|
| `TZ` | Timezone | `America/New_York` |
| `FLASK_ENV` | Flask environment | `production` |
| `SECRET_KEY` | Random secure key | `openssl rand -hex 32` |
| `DATABASE_FILE` | SQLite DB filename | `retroiptv.db` |
| `LOG_FILE` | Log file name | `retroiptv.log` |

---

## 🧭 Compatibility

✅ Docker Desktop (Windows/macOS)
✅ Linux (Ubuntu, Debian, Arch, etc.)
✅ TrueNAS SCALE (Compose Stack or App)
✅ Raspberry Pi (ARM builds supported)

---

© 2025 RetroIPTVGuide — Licensed under CC BY-NC-SA 4.0
Empty file added docker/config/.gitkeep
Empty file.
Empty file added docker/data/.gitkeep
Empty file.
20 changes: 20 additions & 0 deletions docker/docker-compose.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
version: "3.9"

services:
retroiptvguide:
container_name: retroiptvguide
image: ghcr.io/thehack904/retroiptvguide:latest
restart: unless-stopped
ports:
- "5000:5000"
env_file:
- .env
volumes:
- ./config:/app/config
- ./logs:/app/logs
- ./data:/app/data
healthcheck:
test: ["CMD", "curl", "-f", "http://localhost:5000"]
interval: 30s
timeout: 5s
retries: 3
Empty file added docker/logs/.gitkeep
Empty file.