Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/agustinsrg/hls-websocket-cdn
Simple CDN to deliver HLS video streams using websocket connections.
https://github.com/agustinsrg/hls-websocket-cdn
cdn hls streaming video websocket
Last synced: 26 days ago
JSON representation
Simple CDN to deliver HLS video streams using websocket connections.
- Host: GitHub
- URL: https://github.com/agustinsrg/hls-websocket-cdn
- Owner: AgustinSRG
- License: mit
- Created: 2024-11-16T15:32:08.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2024-12-06T11:24:56.000Z (about 1 month ago)
- Last Synced: 2024-12-06T12:23:46.411Z (about 1 month ago)
- Topics: cdn, hls, streaming, video, websocket
- Language: Go
- Homepage:
- Size: 996 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HLS Websocket CDN
This project is a simple CDN (Content delivery network) to deliver HLS (HTTP Live Streaming) video streams using websocket connections, with the purpose of reducing the delay as much as possible and keeping the system scalable.
The project incudes the following components:
- [Server](./server/README.md) - The main backend component of the CDN, implemented in the [Go](https://go.dev/) programming language.
- [Javascript client](./client-js/README.md) - A JavasScript client for browsers to be able to receive the streams.
- [Publisher client library](./client-publisher/README.md) - A library to publish to the CDN, implemented in the [Go](https://go.dev/) programming language.
- [Tester](./tester/README.md) - Test program to publish video files in loop and spectate from a browser.
## Installation
To use the project, the best method is to run the server with Docker.
You can find the docker image for this project available in Docker Hub: https://hub.docker.com/r/asanrom/hls-websocket-cdn
To pull it type:
```sh
docker pull asanrom/hls-websocket-cdn
```
Make sure to read the [image overview](https://hub.docker.com/r/asanrom/hls-websocket-cdn) to know about all the configuration options.
You can also compile the server yourself. In order to do that, read the [server compilation instructions](./server/README.md#compilation).
## Design
The CDN is composed by servers. Servers allow both pushing and pulling HLS streams via websocket.
If you have a single server, the architecture is the simplest: The server will relay the HLS fragments from the publisher to the spectators.
The most frequent case is having multiple servers. In this case, a publish registry database ([Redis](https://redis.io) or equivalent) is required for the servers to share information about what server is the one where a stream is being published.
When receiving a pull request, the server will try to find the stream from 3 different sources, in this order:
- First, if publishing is enabled for the server, it will try finding the stream internally. It it finds it, it will relay the fragments without connecting to any other servers.
- Second, if enabled, it will ask the Redis database to figure out what server is the one being used to publish the stream. If found, the server will connect to the publishing server and relay the fragments received from it.
- Third, if enabled, it will connect to another server and relay the fragments from it.
The 3 methods can be individually enabled or disabled. This allows you to customize your CDN architecture.
Example: You can separate the servers used to publish from the servers used to receive the stream using gateways for each region.
## Documentation
- [Server configuration options](./server/README.md#configuration)
- [Websocket protocol documentation](./documentation/websocket-protocol.md)
- [Authentication mechanism documentation](./documentation/authentication.md)
## License
This project is under the [MIT License](./LICENSE).