added readme

This commit is contained in:
Muaz Ahmad 2023-08-24 14:40:57 +05:00
parent 33fc16f38c
commit 6677ec6afd

21
README.md Normal file
View file

@ -0,0 +1,21 @@
# stream-server
Extremely basic live stream server
Currently implements a degraded subset of the RTMP protocol for ingest.
Uses the std lib http server implementation for the http serving side.
**Not intended for actual use**. The stream key use is not secure and is used to handle directories without a user db system, than to provide auth
Limits to a single stream at a time, mostly for the lack of db to handle connections rather than concurrency problems.
Currently always transcodes to h264 + aac, segments to fragmented mp4. Creates one segment playlist, no manifest. Uses ffmpeg
HTTP streaming relies on hls.js. Will be broken until I figure out how to modify the `EXT-X-MAP:URI` field to prepend a path prefix.
Currently produces no logs nor debug info. Will just abandon a connection if there is a problem. Will not send any RTMP replies since flash server docs seem dead and abort messages are netStream commands
Ports are hard-coded into main.go. Modify if needed
Run with `go run main.go`. Could also build if you prefer that instead.