mirror of
				https://github.com/algora-io/tv.git
				synced 2025-10-30 23:07:56 +02:00 
			
		
		
		
	
			
				
					
						
					
					e673971509f87a9a1130154f8cd723623e08be81
				
			
			
		
	Algora TV
    The interactive livestreaming & video sharing service for developers.
    
    Website
    ·
    Discord
    ·
    Twitter
    ·
    YouTube
    ·
    Issues
  
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}
Getting Started
To get a local copy up and running, please follow these steps.
Prerequisites
Here is what you need to be able to run Algora TV.
- Elixir (Version: >=1.12)
- OTP
- PostgreSQL
- FFmpeg
Development
Setup
- 
Clone the repo into a public GitHub repository (or fork https://github.com/algora-io/tv/fork). git clone https://github.com/algora-io/tv.git
- 
Go to the project folder cd tv
- 
Install dependencies with mix mix deps.get
- 
Set up your .envfile- Duplicate .env.exampleto.env
- Add your environment variables in the .envfile
 
- Duplicate 
- 
Create and migrate your database with mix mix ecto.setup
- 
Start your development server env $(cat .env | xargs -L 1) iex -S mix phx.server
License
Distributed under the AGPLv3 License. See LICENSE for more information.
Acknowledgements
Special thanks to these amazing projects which help power Algora TV:
					Languages
				
				
								
								
									Elixir
								
								87.4%
							
						
							
								
								
									HTML
								
								9.2%
							
						
							
								
								
									TypeScript
								
								2.1%
							
						
							
								
								
									CSS
								
								0.5%
							
						
							
								
								
									Dockerfile
								
								0.3%
							
						
							
								
								
									Other
								
								0.5%