mirror of
https://github.com/Dispatcharr/Dispatcharr.git
synced 2026-01-23 02:35:14 +00:00
136 lines
5.4 KiB
Markdown
136 lines
5.4 KiB
Markdown
# 🎬 Dispatcharr — Your Ultimate IPTV & Stream Management Companion
|
||
<p align="center">
|
||
<img src="https://raw.githubusercontent.com/Dispatcharr/Dispatcharr/refs/heads/main/frontend/src/images/logo.png" height="200" alt="Dispatcharr Logo" />
|
||
</p>
|
||
|
||
---
|
||
|
||
## 📖 What is Dispatcharr?
|
||
|
||
Dispatcharr is an **open-source powerhouse** for managing IPTV streams and EPG data with elegance and control.\
|
||
Born from necessity and built with passion, it started as a personal project by **[OkinawaBoss](https://github.com/OkinawaBoss)** and evolved with contributions from legends like **[dekzter](https://github.com/dekzter)**, **[SergeantPanda](https://github.com/SergeantPanda)** and **Bucatini**.
|
||
|
||
> Think of Dispatcharr as the \*arr family’s IPTV cousin — simple, smart, and designed for streamers who want reliability and flexibility.
|
||
|
||
---
|
||
|
||
## 🧪 What’s New in Beta
|
||
|
||
Dispatcharr has officially entered **BETA**, bringing powerful new features and improvements across the board:
|
||
|
||
✨ **Proxy Streaming Engine** — Optimize bandwidth, reduce provider connections, and increase stream reliability\
|
||
📊 **Real-Time Stats Dashboard** — Live insights into stream health and client activity\
|
||
🧠 **EPG Auto-Match** — Match program data to channels automatically\
|
||
⚙️ **Streamlink + FFmpeg Support** — Flexible backend options for streaming and recording\
|
||
🧼 **UI & UX Enhancements** — Smoother, faster, more responsive interface\
|
||
🛁 **Output Compatibility** — HDHomeRun, M3U, and XMLTV EPG support for Plex, Jellyfin, and more
|
||
|
||
---
|
||
|
||
## ✨ Why You'll Love Dispatcharr
|
||
|
||
✅ **Full IPTV Control** — Import, organize, proxy, and monitor IPTV streams on your own terms\
|
||
✅ **Smart Playlist Handling** — M3U import, filtering, grouping, and failover support\
|
||
✅ **Reliable EPG Integration** — Match and manage TV guide data with ease\
|
||
✅ **Clean & Responsive Interface** — Modern design that gets out of your way\
|
||
✅ **Fully Self-Hosted** — Total control, zero reliance on third-party services
|
||
|
||
---
|
||
|
||
|
||
# Screenshots
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
# 🚀 Get Started in Minutes
|
||
|
||
### 🐳 Quick Start with Docker (Recommended)
|
||
|
||
```bash
|
||
docker pull ghcr.io/dispatcharr/dispatcharr:latest
|
||
docker run -d \
|
||
-p 9191:9191 \
|
||
--name dispatcharr \
|
||
-v dispatcharr_data:/data \
|
||
ghcr.io/dispatcharr/dispatcharr:latest
|
||
```
|
||
|
||
> Customize ports and volumes to fit your setup.
|
||
|
||
---
|
||
|
||
### 🐳 Docker Compose Options
|
||
|
||
| Use Case | File | Description |
|
||
| --------------------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
|
||
| **All-in-One Deployment** | [docker-compose-aio.yml](docker/docker-compose.aio.yml) | ⭐ Recommended! A simple, all-in-one solution — everything runs in a single container for quick setup. |
|
||
| **Modular Deployment** | [docker-compose.yml](docker/docker-compose.yml) | Separate containers for Dispatcharr, Celery, and Postgres — perfect if you want more granular control. |
|
||
| **Development Environment** | [docker-compose-dev.yml](docker/docker-compose.dev.yml) | Developer-friendly setup with pre-configured ports and settings for contributing and testing. |
|
||
|
||
---
|
||
|
||
### ⚒️ Building from Source (For the Adventurous)
|
||
|
||
> ⚠️ **Warning**: Not officially supported — but if you're here, you know what you're doing!
|
||
|
||
If you are running a Debian based operating system you can install using the `debian_install.sh` script. If you are on another operating system and come up with a script let us know! We would love to add it here!
|
||
|
||
---
|
||
|
||
## 🤝 Want to Contribute?
|
||
|
||
We welcome **PRs, issues, ideas, and suggestions**!\
|
||
Here’s how you can join the party:
|
||
|
||
- Follow our coding style and best practices.
|
||
- Be respectful, helpful, and open-minded.
|
||
- Respect the **CC BY-NC-SA license**.
|
||
|
||
> Whether it’s writing docs, squashing bugs, or building new features, your contribution matters! 🙌
|
||
|
||
---
|
||
|
||
## 📚 Roadmap & Documentation
|
||
|
||
- 📚 **Roadmap:** Coming soon!
|
||
- 📖 **Wiki:** In progress — tutorials, API references, and advanced setup guides on the way!
|
||
|
||
---
|
||
|
||
## ❤️ Shoutouts
|
||
|
||
A huge thank you to all the incredible open-source projects and libraries that power Dispatcharr. We stand on the shoulders of giants!
|
||
|
||
---
|
||
|
||
## ⚖️ License
|
||
|
||
> Dispatcharr is licensed under **CC BY-NC-SA 4.0**:
|
||
|
||
- **BY**: Give credit where credit’s due.
|
||
- **NC**: No commercial use.
|
||
- **SA**: Share alike if you remix.
|
||
|
||
For full license details, see [LICENSE](https://creativecommons.org/licenses/by-nc-sa/4.0/).
|
||
|
||
---
|
||
|
||
## ✉️ Connect With Us
|
||
|
||
Have a question? Want to suggest a feature? Just want to say hi?\
|
||
➡️ **[Open an issue](https://github.com/Dispatcharr/Dispatcharr/issues)** or reach out on [Discord]( https://discord.gg/Sp45V5BcxU).
|
||
|
||
---
|
||
|
||
### 🚀 *Happy Streaming! The Dispatcharr Team*
|