Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/chinachu/mirakurun

A Modern DVR Tuner Server for Japanese TV.
https://github.com/chinachu/mirakurun

chinachu client dtv dvb dvr epg isdb javascript linux middleware mirakurun openapi server typescript

Last synced: about 15 hours ago
JSON representation

A Modern DVR Tuner Server for Japanese TV.

Host: GitHub
URL: https://github.com/chinachu/mirakurun
Owner: Chinachu
License: apache-2.0
Created: 2015-04-04T19:58:21.000Z (almost 10 years ago)
Default Branch: master
Last Pushed: 2024-02-11T18:49:55.000Z (12 months ago)
Last Synced: 2024-04-14T03:04:24.409Z (10 months ago)
Topics: chinachu, client, dtv, dvb, dvr, epg, isdb, javascript, linux, middleware, mirakurun, openapi, server, typescript
Language: TypeScript
Homepage: https://chinachu.moe
Size: 1.71 MB
Stars: 589
Watchers: 68
Forks: 98
Open Issues: 6
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        [![Mirakurun](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/e50683f1c4e7d1a13e9ef468f8cc945b0dbc853c/logo-mirakurun.svg)](https://github.com/Chinachu/Mirakurun)

# Mirakurun

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

[![npm version][npm-img]][npm-url]

[![npm downloads][downloads-image]][downloads-url]

[![Linux Build][azure-pipelines-img]][azure-pipelines-url]

[![tip for next commit](https://tip4commit.com/projects/43158.svg)](https://tip4commit.com/github/Chinachu/Mirakurun)

[![Backers on Open Collective](https://opencollective.com/Mirakurun/backers/badge.svg)](#backers)

[![Sponsors on Open Collective](https://opencollective.com/Mirakurun/sponsors/badge.svg)](#sponsors)

## Docker

[![dockeri.co](https://dockeri.co/image/chinachu/mirakurun)][docker-url]

see: available [Tags](https://hub.docker.com/r/chinachu/mirakurun/tags) (Docker Hub)

### Quick Install

```sh

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](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](doc/Mirakuruns.md)

* Web UI

* IPTV Server (M3U8 Playlist, XMLTV)

#### Figure: Variety of the MPEG-2 TS Stream API

![](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/e50683f1c4e7d1a13e9ef468f8cc945b0dbc853c/mirakurun-fig-api-variety.svg)

#### Figure: Stream Flow

![](https://gist.githubusercontent.com/kanreisa/0ab27d7771e97edce5a24cc81b9b8ce6/raw/e50683f1c4e7d1a13e9ef468f8cc945b0dbc853c/mirakurun-fig-flow-stream.svg)

## Requirements / Supported Platforms

* [Node.js](http://nodejs.org/) 14, 16, 18

* Linux w/ [PM2](http://pm2.keymetrics.io/) or [Docker](https://hub.docker.com/r/chinachu/mirakurun)

see: [doc/Platforms.md](doc/Platforms.md)

## **Install / Update / Uninstall / CLI**

see: [doc/Platforms.md](doc/Platforms.md)

## Web UI

```sh

# 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](https://pm2.io/plus/) (Keymetrics)

## Client Implementations

* [Rivarun](https://github.com/Chinachu/Rivarun)

* [BonDriver_Mirakurun](https://github.com/Chinachu/BonDriver_Mirakurun)

* Mirakurun Client ([Built-in](https://github.com/Chinachu/Mirakurun/blob/master/src/client.ts))

  * "Air" (in development codename)

  * [Chinachu γ](https://github.com/Chinachu/Chinachu/wiki/Gamma-Installation-V2)

  * [EPGStation](https://github.com/l3tnun/EPGStation)

## Contributing

[CONTRIBUTING.md](CONTRIBUTING.md)

## Supporting

* [Tip4Commit](https://tip4commit.com/github/Chinachu/Mirakurun) (BTC) - to Every Committers

* [Open Collective](https://opencollective.com/Mirakurun) (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](https://opencollective.com/Mirakurun#backer)]



## Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/Mirakurun#sponsor)]





















## Copyright / License

© 2016- [kanreisa](https://github.com/kanreisa).

* Code: [Apache License, Version 2.0](LICENSE)

* Docs: [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)

* Logo: [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/)

**Commercial License / Support** is provided by [Pixely LLC](https://pixely.jp/).

[npm-img]: https://img.shields.io/npm/v/mirakurun.svg

[npm-url]: https://npmjs.org/package/mirakurun

[downloads-image]: https://img.shields.io/npm/dm/mirakurun.svg?style=flat

[downloads-url]: https://npmjs.org/package/mirakurun

[azure-pipelines-img]: https://dev.azure.com/chinachu/Mirakurun/_apis/build/status/Chinachu.Mirakurun?branchName=master

[azure-pipelines-url]: https://dev.azure.com/chinachu/Mirakurun/_build/latest?definitionId=1&branchName=master

[docker-url]: https://hub.docker.com/r/chinachu/mirakurun