Skip to content

📺 Transform your Raspberry Pi into an awesome streaming device.

License

Notifications You must be signed in to change notification settings

Tastyep/Pi-OpenCast

Repository files navigation

Banner


OpenCast

Test status for master branch codecov.io status for master branch Sanitizing status for master branch 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

$ 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:

$ ./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:

$ hostname -I

You can then access the webpage from any device on the same local network at <ip-addr>: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)
$ systemctl --user [start|stop|restart|status] opencast
  • Using the shell entry-point (advanced):
$ ./OpenCast.sh service [start|stop|restart|status]

Logs can be accessed running:

$ 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.