Table of Contents

• About The Project
• Getting Started
  • Prerequisites
  • Configuring Environment
  • Generating Certificates
  • Building from Source
• Contributors
• License

About The Project

Breeezy, stylized br3ezy, is a federated streaming platform that hosts can use to simplify distributed and/or self-hosted streaming to their audience. By self-hosted streaming, these hosts can take sovereignty over their own message without compromising for advertisers. This project will include a killer feature where subletters can sponsor a CDN in their region to propogate better streaming for other viewers, thereby becoming 'heros'.

Getting Started

Prerequisites

• SRT for streaming metrics.
• ffmpeg for stream encoding.
• MySql for database usage.
• Node.js (v20.11.1 or above) for express server.

Configuring Environment

1. Copy the server/.env.example file to a new file named server/.env:
2. Fill .env with your personal preferences.

Generating Certificates

For development, use your own self-signed certs:

openssl req -nodes -new -x509 -keyout key.pem -out cert.pem -days 365

For production, certificates should be obtained from a trusted Certificate Authority (CA).

Ensure they are placed in the cert directory.

Building from Source

1. Clone the repo. git clone https://github.com/Da-Scher/br3ezy
2. Configure .env as stated above.
3. Generate certificates as stated above.
4. Run npm install to install dependencies.
5. Initialize database with npm run db:init -w server.
6. Run npm run build to build static files.
7. Run npm run start to start express server.
8. Point your broadcasting software to srt://<hostname>:2000 to start streaming.
9. Visit https://<hostname>:8000 to access the web interface.

Contributors

• Joe Barteluce: Client-Side Web Developer/Designer
• Dakota Schaeffer: Media Streaming Developer - Content Delivery Engineer
• Justin Sprecco: System Architect - Cloud Engineer

License

Distributed under the GPL-2.0 License. See LICENSE for more information.