No description
Find a file
2025-03-21 19:59:54 -05:00
.idea Initial commit 2025-02-18 11:14:09 -06:00
.vscode Added AIO docker ability 2025-02-22 12:22:39 -06:00
apps Added client speed statistics to client metadata in redis. 2025-03-21 19:59:54 -05:00
core Singular redis-client. 2025-03-21 10:55:13 -05:00
dispatcharr live stats dashboard 2025-03-17 12:42:58 -04:00
docker Singular redis-client. 2025-03-21 10:55:13 -05:00
frontend Merge branch 'main' into EPG-Region-Update 2025-03-19 13:19:44 -05:00
scripts Singular redis-client. 2025-03-21 10:55:13 -05:00
.dockerignore Added AIO docker ability 2025-02-22 12:22:39 -06:00
.gitattributes Added AIO docker ability 2025-02-22 12:22:39 -06:00
.gitignore Cleaned up gitignore 2025-03-19 09:25:49 -05:00
fixtures.json Download Sentence Transformer model locally 2025-03-18 21:39:07 -05:00
LICENSE Create LICENSE 2025-02-18 11:22:47 -06:00
manage.py Initial commit 2025-02-18 11:14:09 -06:00
README.md Update README.md 2025-03-18 17:08:24 +01:00
requirements.txt live stats dashboard 2025-03-17 12:42:58 -04:00

🎬 Dispatcharr — Your Ultimate IPTV & Stream Management Companion

Dispatcharr Logo

Inspired by the *arr family, built for streamers, self-hosters, and IPTV enthusiasts everywhere.


📖 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 and evolved with contributions from legends like dekzter, SergeantPanda and Bucatini.

Think of Dispatcharr as the *arr familys IPTV cousin — simple, smart, and designed for streamers who want reliability and flexibility.


Why You'll Love Dispatcharr

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.


🚀 Get Started in Minutes

docker pull dispatcharr/dispatcharr:latest
docker run -d \
  -p 9191:9191 \
  --name dispatcharr \
  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 Recommended! A simple, all-in-one solution — everything runs in a single container for quick setup.
Modular Deployment docker-compose.yml Separate containers for Dispatcharr, Celery, and Postgres — perfect if you want more granular control.
Development Environment 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!

  1. Clone the repo:
git clone https://github.com/Dispatcharr/Dispatcharr.git
cd Dispatcharr
  1. (Optional) Create a virtual environment:
python -m venv venv
source venv/bin/activate
  1. Install Python dependencies:
pip install -r requirements.txt
  1. Migrate and start the backend:
python manage.py migrate
python manage.py runserver
  1. Build the frontend:
cd frontend/
npm install
npm run build
  1. Open http://localhost:9191 and start streaming!

🤝 Want to Contribute?

We welcome PRs, issues, ideas, and suggestions!
Heres 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 its 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 credits due.
  • NC: No commercial use.
  • SA: Share alike if you remix.

For full license details, see LICENSE.


✉️ Connect With Us

Have a question? Want to suggest a feature? Just want to say hi?
➡️ Open an issue or reach out on our community channels (coming soon!).


🚀 Happy Streaming! The Dispatcharr Team