Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
iSchluff committed Apr 21, 2020
1 parent 93a9424 commit bb32166
Showing 1 changed file with 18 additions and 10 deletions.
28 changes: 18 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
```
```

0 comments on commit bb32166

Please sign in to comment.