From 6677ec6afd4ad23c16e7472722e7853ebbc39d49 Mon Sep 17 00:00:00 2001 From: Muaz Ahmad Date: Thu, 24 Aug 2023 14:40:57 +0500 Subject: [PATCH] added readme --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f9a382c --- /dev/null +++ b/README.md @@ -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.