From bb3216680b2936edfb5063f6b20dcdcdf638da59 Mon Sep 17 00:00:00 2001 From: Anton Schubert Date: Tue, 21 Apr 2020 02:08:44 +0200 Subject: [PATCH] update readme --- README.md | 28 ++++++++++++++++++---------- 1 file changed, 18 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 961ae28..4d3b54f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,13 @@ # rtmp-auth -Simple Auth backend for nginx-rtmp module +Simple auth backend for nginx-rtmp module written in go. - * expiring auth - * single static binary - * persists state to simple file - * WebUI +## Features + * Expiring auth + * Single static binary + * Persists state to simple file (no database required) + * Web-UI with subpath support (planned) + +In the future I might also add support for removing active streams when they expire. ## Usage @@ -30,17 +33,22 @@ Then start the daemon ./rtmp-auth -app "myrtmp" -apiAddr "localhost:8000" -frontendAddr "localhost:8082" ``` -You will need to set the -insecure flag when testing over http. +**Note: You will need to set the -insecure flag when testing over http.** -Now all rtmp-publish requests for that application will be authenticated against the daemon. +After you reload your nginx with ```systemctl reload nginx``` or similar your +rtmp publish-requests will be authenticated against the daemon. +You can then visit localhost:8082 to add streams. -You can visit localhost:8082 to add streams. +For production usage you will want to deploy the frontend behind a Reverse-Proxy with TLS-support like the nginx you already have. -## Dependencies +## Build Dependencies * protoc with go-support * statik ```go get github.com/rakyll/statik``` +## Runtime Dependencies +None apart from nginx-rtmp obviously + ## Build ``` make -``` \ No newline at end of file +```