algora-tv/README.md at 535cc26993da5a2efe71a6f22bf6261bd22df74b

self-hosted/algora-tv

Fork 0

mirror of https://github.com/algora-io/tv.git synced 2024-11-26 01:00:20 +02:00

deepakdinesh1123 535cc26993

update setup docs (#79 )

2024-09-20 17:28:32 +03:00

5.5 KiB

Raw Blame History

Algora TV

The interactive livestreaming & video sharing service for developers.
Website · Discord · Twitter · YouTube · Issues

✨ New feature: Earn with Livestream Billboards! ✨

Algora Live Billboards allow for in-video ads, helping devs earn money while livestreaming and giving devtools companies a novel channel to reach new audiences. Learn more

https://github.com/user-attachments/assets/6f706a4b-210f-4ec8-a817-2a72cea0954a

Getting Started

To get a local copy up and running, follow these steps.

Prerequisites

Elixir and Erlang/OTP
- We recommend using asdf to install Elixir and Erlang/OTP.
- Keep in mind that each Elixir version supports specific Erlang/OTP versions.
- Make sure you have at least Elixir 1.12 installed to run Algora TV.
PostgreSQL
FFmpeg
ImageMagick
OBS Studio (recommended for testing livestreaming features)

Setting up the project

Clone the repo and go to the project folder

git clone https://github.com/algora-io/tv.git; cd tv

Fetch dependencies
```
mix deps.get
```
Note: If you're using an Apple machine with an ARM-based chip, you need to install the Rust compiler and run mix compile.rambo
Initialize your .env file
```
cp .env.example .env
```

Create your database

sudo -u postgres psql

CREATE USER algora WITH PASSWORD 'password';
CREATE DATABASE tv;
GRANT ALL PRIVILEGES ON DATABASE tv TO algora;

Paste your connection string into your .env file

DATABASE_URL="postgresql://algora:password@localhost:5432/tv"

Run migrations and seed your database

env $(cat .env | xargs -L 1) mix ecto.setup

Start your development server

env $(cat .env | xargs -L 1) iex -S mix phx.server

Setting up external services

Some features of Algora TV rely on external services. If you're not planning on using these features, feel free to skip setting them up.

GitHub

GitHub is used for authenticating users.

Create a GitHub OAuth app and set

Homepage URL: http://localhost:4000
Authorization callback URL: http://localhost:4000/oauth/callbacks/github

Once you have obtained your client ID and secret, add them to your .env file.

GITHUB_CLIENT_ID=""
GITHUB_CLIENT_SECRET="..."

Tigris

Tigris is used for storing and delivering livestreams and other media.

Create a public Tigris bucket to obtain your secrets and add them to your .env file.

AWS_ENDPOINT_URL_S3="https://fly.storage.tigris.dev"
AWS_REGION="auto"
AWS_ACCESS_KEY_ID="tid_..."
AWS_SECRET_ACCESS_KEY="tsec_..."
BUCKET_MEDIA="..."

Architecture

Overview

graph
    Streamers{Streamers} --> Fly
    Fly[Fly<br>Elixir App] --> RTMP
    Fly --> Web[Phoenix<br>Web Server]
    Fly --> Db[Fly<br>Postgres]
    RTMP[Membrane<br>RTMP Server] -->|First mile delivery| Tigris[Tigris<br>Object Storage]
    Viewers{Viewers} -->|Last mile delivery| Tigris
    Viewers --> Fly

Livestream pipeline

graph
    Encoder{Encoder<br>e.g. OBS} -->|RTMP| Source[FLV Demuxer]
    Source -->|video| H264Parser[H264 Parser]
    Source -->|audio| AACParser[AAC Parser]
    H264Parser --> H264Payloader[H264 Payloader]
    AACParser --> AACPayloader[AAC Payloader]
    H264Payloader --> CMAFMuxerVideo[CMAF Muxer]
    AACPayloader --> CMAFMuxerAudio[CMAF Muxer]
    CMAFMuxerVideo --> fMP4
    CMAFMuxerAudio --> fMP4
    fMP4[Fragmented MP4] -->|HLS| Tigris{Tigris Object Storage}

License

Distributed under the AGPLv3 License. See LICENSE for more information.

Acknowledgements

Special thanks to these amazing projects which help power Algora TV:

5.5 KiB Raw Blame History