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**](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. --- ## β¨ 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 ### π³ Quick Start with Docker (Recommended) ```bash 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](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! 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! --- ## π€ 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 our community channels (coming soon!). --- ### π *Happy Streaming! The Dispatcharr Team*