README.md

Mirakurun

DVR Tuner Server for Japanese TV which designed for the "Air" (in development codename).

Docker

see: available Tags (Docker Hub)

Quick Install

mkdir ~/mirakurun/
cd ~/mirakurun/
wget https://raw.githubusercontent.com/Chinachu/Mirakurun/master/docker/docker-compose.yml
docker-compose pull
docker-compose run --rm -e SETUP=true mirakurun
docker-compose up -d

see: doc/Platforms.md

Features

• RESTful API (Open API) - has designed like HTTP version of Spinel
• Unix Sockets / TCP
• Advanced Tuner Process Management
• Priority Management
• Tuner Device Pooling
• Integrated MPEG-2 TS Parser, Filter
• Realtime EPG Parser
• Supports most Tuner Devices (chardev, DVB / ISDB-T, ISDB-S, DVB-S2)
• Channel Scan
• IPv6 Support
• Multiplexing Mirakuruns
• Web UI
• IPTV Server (M3U8 Playlist, XMLTV)

Figure: Variety of the MPEG-2 TS Stream API

Figure: Stream Flow

Requirements / Supported Platforms

• Node.js 14, 16, 18
• Linux w/ PM2 or Docker

see: doc/Platforms.md

Install / Update / Uninstall / CLI

see: doc/Platforms.md

Web UI

# Admin UI
http://_your_mirakurun_ip_:40772/

# Swagger UI
http://_your_mirakurun_ip_:40772/api/debug

PM2 Plus (Keymetrics)

You can use PM2 Plus to realtime monitoring if running by PM2.

• PM2 Plus (Keymetrics)

Client Implementations

• Rivarun
• BonDriver_Mirakurun
• Mirakurun Client (Built-in)
  • "Air" (in development codename)
  • Chinachu γ
  • EPGStation

Contributing

CONTRIBUTING.md

Supporting

• Tip4Commit (BTC) - to Every Committers
• Open Collective (USD) - Pool (TBD)

Discord Community

• Invitation: https://discord.gg/X7KU5W9

Contributors

This project exists thanks to all the people who contribute.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Copyright / License

© 2016- kanreisa.

• Code: Apache License, Version 2.0
• Docs: CC BY 4.0
• Logo: CC BY-SA 4.0

Commercial License / Support is provided by Pixely LLC.