mirror of
https://github.com/Dispatcharr/Dispatcharr.git
synced 2026-01-23 02:35:14 +00:00
Update README.md
This commit is contained in:
OkinawaBoss
GitHub
parent
383bcfcccd
commit
9e312f31f3
1 changed files with 75 additions and 71 deletions
146
README.md
146
README.md
|
|
@ -1,34 +1,59 @@
|
|||
# 🎬 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>
|
||||
|
||||
<p align="center"><strong>Inspired by the *arr family, built for streamers, self-hosters, and IPTV enthusiasts everywhere.</strong></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**.
|
||||
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.
|
||||
> Think of Dispatcharr as the \*arr family’s IPTV cousin — simple, smart, and designed for streamers who want reliability and flexibility.
|
||||
|
||||
---
|
||||
|
||||
## ✨ Why You'll Love Dispatcharr
|
||||
## 🧪 What’s New in Beta
|
||||
|
||||
✅ **Stream Collection & Management** — Import, organize, and serve IPTV streams with zero hassle.
|
||||
✅ **EPG Integration** — Manage Electronic Program Guides like a pro.
|
||||
✅ **Smart Failover** — Auto-switch to backup sources if a stream drops (because downtime is not an option!).
|
||||
✅ **M3U Import & Restreaming** — Make playlists work *your* way.
|
||||
✅ **Clean, Responsive UI** — Modern, intuitive, and built to get out of your way.
|
||||
✅ **Self-hosted freedom** — Total control in your hands.
|
||||
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
|
||||
|
||||
---
|
||||
|
||||
# 🚀 Get Started in Minutes
|
||||
## ✨ 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)
|
||||
|
||||
|
|
@ -39,96 +64,75 @@ docker run -d \
|
|||
--name dispatcharr \
|
||||
dispatcharr/dispatcharr:latest
|
||||
```
|
||||
> Customize ports and volumes to fit your setup.
|
||||
|
||||
> Customize ports and volumes to fit your setup.
|
||||
|
||||
---
|
||||
|
||||
### 🐳 Docker Compose Options
|
||||
### 🐳 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. |
|
||||
| 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)
|
||||
### ⚒️ Building from Source (For the Adventurous)
|
||||
|
||||
> ⚠️ **Warning**: Not officially supported — but if you're here, you know what you're doing!
|
||||
> ⚠️ **Warning**: Not officially supported — but if you're here, you know what you're doing!
|
||||
|
||||
1. Clone the repo:
|
||||
```bash
|
||||
git clone https://github.com/Dispatcharr/Dispatcharr.git
|
||||
cd Dispatcharr
|
||||
```
|
||||
2. (Optional) Create a virtual environment:
|
||||
```bash
|
||||
python -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
3. Install Python dependencies:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
4. Migrate and start the backend:
|
||||
```bash
|
||||
python manage.py migrate
|
||||
python manage.py runserver
|
||||
```
|
||||
5. Build the frontend:
|
||||
```bash
|
||||
cd frontend/
|
||||
npm install
|
||||
npm run build
|
||||
```
|
||||
6. Open [http://localhost:9191](http://localhost:9191) and start streaming!
|
||||
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?
|
||||
## 🤝 Want to Contribute?
|
||||
|
||||
We welcome **PRs, issues, ideas, and suggestions**!
|
||||
Here’s how you can join the party:
|
||||
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**.
|
||||
- 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! 🙌
|
||||
> Whether it’s writing docs, squashing bugs, or building new features, your contribution matters! 🙌
|
||||
|
||||
---
|
||||
|
||||
## 📚 Roadmap & Documentation
|
||||
## 📚 Roadmap & Documentation
|
||||
|
||||
- 🗺️ **Roadmap:** Coming soon!
|
||||
- 📖 **Wiki:** In progress — tutorials, API references, and advanced setup guides on the way!
|
||||
- 📚 **Roadmap:** Coming soon!
|
||||
- 📖 **Wiki:** In progress — tutorials, API references, and advanced setup guides on the way!
|
||||
|
||||
---
|
||||
|
||||
## ❤️ Shoutouts
|
||||
## ❤️ Shoutouts
|
||||
|
||||
A huge thank you to all the incredible open-source projects and libraries that power Dispatcharr. We stand on the shoulders of giants!
|
||||
A huge thank you to all the incredible open-source projects and libraries that power Dispatcharr. We stand on the shoulders of giants!
|
||||
|
||||
---
|
||||
|
||||
## ⚖️ License
|
||||
## ⚖️ License
|
||||
|
||||
> Dispatcharr is licensed under **CC BY-NC-SA 4.0**:
|
||||
> 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.
|
||||
- **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/).
|
||||
For full license details, see [LICENSE](https://creativecommons.org/licenses/by-nc-sa/4.0/).
|
||||
|
||||
---
|
||||
|
||||
## ✉️ Connect With Us
|
||||
## ✉️ 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 our community channels (coming soon!).
|
||||
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*
|
||||
### 🚀 *Happy Streaming! The Dispatcharr Team*
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue