Skip to content

Latest commit

 

History

History
51 lines (33 loc) · 3.77 KB

rtmpwebhookauth.md

File metadata and controls

51 lines (33 loc) · 3.77 KB
Raw

Webhook Authentication

Incoming streams can be authenticated using webhooks. To use these webhooks, node operators must implement their own web service / endpoint to be accessed only by the Livepeer node. As new streams appear, the Livepeer node will call this endpoint to determine whether the given stream is allowed.

Webhooks can authenticate streams supported by the RTMP and HTTP push ingest protocols. See the ingest documentation for details on how to use these protocols.

To enable webhook authentication functionality, the Livepeer node should be started with the -authWebhookUrl flag, along with the webhook endpoint URL.

For example:

livepeer -authWebhookUrl http://ownserver/auth

For each incoming stream, the Livepeer node will make a POST request to the http://ownserver/auth endpoint, passing the URL of the request as JSON object.

For example, if the incoming request was made to rtmp://livepeer.node/manifest, the Liverpeer node will provide the following object as a request to the webhook endpoint:

{
    "url": "rtmp://livepeer.node/manifest"
}

The webhook server should respond with HTTP status code 200 in order to authenticate / authorize the stream. A response with a HTTP status code other than 200 will cause the Livepeer node to disconnect the stream.

The webhook may respond with an empty body. In this case, the manifestID property of the stream will be taken from the URL. If the URL does not specify a manifest id, then it will be generated at random. Otherwise, the webhook endpoint should respond with a JSON object in the following format:

{
    "manifestID": "ManifestID",
    "streamKey":  "SecretKey",
    "presets":    ["Preset", "Names"],
    "profiles":   [{"name":"ProfileName", "width":320, "height":240, "bitrate":1000000, "fps":30, "fpsDen":1, "profile":"H264Baseline", "gop" "2.5"}]
}

The Livepeer node will use the returned manifestID for the given stream.

The manifestID should consist of alphanumeric characters, only. Please avoid using any punctuation characters or slashes within the manifestID

An optional streamKey may be provided in order to protect the RTMP stream from playback. If the streamKey is omitted, a random key will be generated.

Presets can be specified to override the default transcoding options. The available presets are listed here.

Custom transcoding profiles can be provided if the presets are not sufficient. Given a stream name (manifest ID) of "ManifestID" and a profile name of "ProfileName", the specific profile will be available for playback at /stream/ManifestID/ProfileName.m3u8. However, to take advantage of ABR features in HLS players, the top-level stream name should usually be supplied instead, eg /stream/ManifestID.m3u8 The bitrate field is in bits per second. The fps field can be omitted to preserve the source frame rate. The fpsDen (denominator) field can also be omitted for a default of 1. Both presets and profiles can be used together to specify the desired transcodes.

The profile field is used to select the codec (H264) profile. Supported values are "H264Baseline, H264Main, H264High, H264ConstrainedHigh", the field can be omitted (or set to "None") to use the encoder default.

The gop field is used to set the GOP length, in seconds. This may help in post-transcoding segmentation to smooth out playback if the original segments are long or irregularly sized. Omitting this field will use the encoder default. To force all intra frames, use "intra".

There is simple webhook authentication server example.