stephane.david/GridTV
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Readme update

Browse Source
This commit is contained in:
Johnnybegood90
2026-03-11 19:51:25 +01:00
parent e72105fac2
commit 2b163be684
1 changed files with 29 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+29 -6
View File
@@ -34,6 +34,8 @@ This demo runs with a sample XMLTV feed and fake channels to showcase the interf
- ▶️ **Built-in HLS player** — click any channel or live program to watch in a PiP overlay - ▶️ **Built-in HLS player** — click any channel or live program to watch in a PiP overlay
- 🔀 **HTTP→HTTPS proxy** — streams Tunarr over HTTP transparently from an HTTPS page - 🔀 **HTTP→HTTPS proxy** — streams Tunarr over HTTP transparently from an HTTPS page
- 🎨 **Theme system** — drop a CSS file in `themes/` and it appears in the menu automatically - 🎨 **Theme system** — drop a CSS file in `themes/` and it appears in the menu automatically
- 📡 **Multi-EPG sources** — configure multiple EPG/M3U sources, switch from the topbar
- 👤 **Personal EPG** — optionally let visitors use your instance with their own EPG/M3U
- ⚙️ **Guided setup** on first launch — no config files to edit manually - ⚙️ **Guided setup** on first launch — no config files to edit manually
- 🔄 **Auto-reload** EPG every 30 minutes - 🔄 **Auto-reload** EPG every 30 minutes
- 0️⃣ **Zero JS dependencies** — vanilla PHP, hls.js loaded from CDN - 0️⃣ **Zero JS dependencies** — vanilla PHP, hls.js loaded from CDN
@@ -141,9 +143,9 @@ GridTV detects the missing config and automatically redirects you to the setup p
| Field | Description | | Field | Description |
|---|---| |---|---|
| **Group name** | Displayed top-left in the topbar (e.g. *MyTV*, *FamilyTV*...) | | **Group name** | Displayed top-left in the topbar |
| **EPG URL (XMLTV)** | Your electronic program guide URL | | **EPG sources** | Add one or more XMLTV sources, each with an optional M3U URL |
| **M3U URL** *(optional)* | Your IPTV playlist — used by the built-in player to match channels to streams | | **Personal EPG** | Toggle to allow visitors to use your instance with their own EPG/M3U |
Once submitted, `config.json` is created on the server. **The setup page becomes inaccessible.** Once submitted, `config.json` is created on the server. **The setup page becomes inaccessible.**
@@ -158,11 +160,24 @@ nano /var/www/gridtv/config.json
```json ```json
{ {
"group_name": "MyGroup TV", "group_name": "MyGroup TV",
"epg_url": "http://192.168.0.3:8000/api/xmltv.xml", "epg_sources": [
"m3u_url": "http://192.168.0.3:8000/api/channels.m3u" {
"name": "Main",
"epg_url": "http://192.168.0.3:8000/api/xmltv.xml",
"m3u_url": "http://192.168.0.3:8000/api/channels.m3u"
},
{
"name": "Sports",
"epg_url": "http://192.168.0.3:8001/api/xmltv.xml",
"m3u_url": ""
}
],
"allow_personal_epg": true
} }
``` ```
> Instances running the old single-source format (`epg_url` at root) are **migrated automatically** on first load — no manual action needed.
--- ---
## 📁 Project structure ## 📁 Project structure
@@ -207,12 +222,20 @@ Drop it in `themes/` — it appears in the theme selector automatically, no code
--- ---
## 📡 Multiple EPG Sources
Configure as many EPG/M3U sources as you want in `config.json`. A dropdown appears in the topbar when more than one source is defined.
If `allow_personal_epg` is `true`, a **"✏ Personal EPG"** option appears in the dropdown, letting any visitor enter their own XMLTV/M3U URLs. Their choice is saved in `localStorage` — zero server impact.
---
## ▶️ Built-in Player ## ▶️ Built-in Player
Click on any **channel name** or **currently airing program** to open a PiP (picture-in-picture) player in the bottom-right corner. Click on any **channel name** or **currently airing program** to open a PiP (picture-in-picture) player in the bottom-right corner.
The player requires: The player requires:
- An **M3U URL** configured in setup (used to match channel names to stream URLs) - An **M3U URL** configured in the active source (used to match channel names to stream URLs)
- The **php-curl** extension installed on the server - The **php-curl** extension installed on the server
If your stream source (e.g. Tunarr) serves streams over HTTP while GridTV runs on HTTPS, `proxy.php` handles the relay transparently — no browser mixed-content errors. If your stream source (e.g. Tunarr) serves streams over HTTP while GridTV runs on HTTPS, `proxy.php` handles the relay transparently — no browser mixed-content errors.