https://github.com/tastyep/pi-opencast
:tv: Transform your Raspberry Pi into an awesome streaming device.
https://github.com/tastyep/pi-opencast
cast chromecast media-player media-server playlist raspberry-pi raspberrypi youtube
Last synced: 9 days ago
JSON representation
:tv: Transform your Raspberry Pi into an awesome streaming device.
- Host: GitHub
- URL: https://github.com/tastyep/pi-opencast
- Owner: Tastyep
- License: mit
- Created: 2018-10-14T11:36:22.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-09-16T11:56:55.000Z (over 1 year ago)
- Last Synced: 2023-09-16T21:37:37.608Z (over 1 year ago)
- Topics: cast, chromecast, media-player, media-server, playlist, raspberry-pi, raspberrypi, youtube
- Language: Python
- Homepage:
- Size: 40.7 MB
- Stars: 40
- Watchers: 2
- Forks: 2
- Open Issues: 21
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
.. image:: https://raw.githubusercontent.com/Tastyep/Pi-OpenCast/master/assets/images/banner.webp
:scale: 80 %
:align: center
:alt: Banner
|
========
OpenCast
========
.. image:: https://github.com/Tastyep/Pi-OpenCast/workflows/Test/badge.svg
:target: https://github.com/Tastyep/Pi-OpenCast/actions?query=workflow%3ATest
:alt: Test status for master branch
.. image:: https://codecov.io/gh/Tastyep/Pi-OpenCast/branch/develop/graph/badge.svg
:target: https://codecov.io/gh/Tastyep/Pi-OpenCast
:alt: codecov.io status for master branch
.. image:: https://github.com/Tastyep/Pi-OpenCast/workflows/Sanitize/badge.svg
:target: https://github.com/Tastyep/Pi-OpenCast/actions?query=workflow%3ASanitize
:alt: Sanitizing status for master branch
.. image:: https://github.com/Tastyep/Pi-OpenCast/workflows/Documentation/badge.svg
:target: https://tastyep.github.io/Pi-OpenCast/
:alt: OpenCast generated documentation
OpenCast is a home theater application whose goal is to transform a computer as small as a Raspberry Pi into
an awesome streaming device.
Key Features
============
- Lightweight fast media server, able to run on raspberry-pi.
- Tons of `supported sites `_.
- Stream support (Youtube, Twitch ...)
- Playlist support
- Local library.
- VLC under the hood.
How To
======
Install
-------
.. code-block:: bash
$ git clone https://github.com/Tastyep/Pi-OpenCast.git
$ cd Pi-OpenCast && ./setup.sh
⚠️ Because the web application has grown in size over time, it is possible that building on a raspberry-pi with <= 1giga of RAM will fail as it will run out of memory. In that case, you will have to build it manually on your computer by running the following command:
.. code-block:: bash
$ ./OpenCast.sh build webapp
Then transfer the generated ``./webapp/build`` directory into the ``webapp`` directory on your raspberry-pi (filezilla is your friend).
Use
-------
After successfully installing OpenCast, you should note the IP address of your raspberry-pi:
.. code-block:: bash
$ hostname -I
You can then access the webpage from any device on the same local network at ``:8081``
Monitor
-------
OpenCast is managed as a systemd service and loaded automatically at startup time.
To interact with the service, two options are available:
- Using systemctl (**recommended**)
.. code-block:: bash
$ systemctl --user [start|stop|restart|status] opencast
- Using the shell entry-point (**advanced**):
.. code-block:: bash
$ ./OpenCast.sh service [start|stop|restart|status]
Logs can be accessed running:
.. code-block:: bash
$ journalctl --user -u opencast
$ ./OpenCast.sh service back log
Configure
-------
The backend and the web application can be configured through their configuration file:
- Backend: ``config.yml``
- Webapp: ``webapp/.env``
Source Code
===========
The project is hosted on `Github `_.
Please feel free to file an issue on the `bug tracker `_
if you have found a bug or have suggestions to improve OpenCast.
License
-------
OpenCast is distributed under the `MIT License `_.