From 681f3d8c926010a3d23fbff66876fd1891bb096b Mon Sep 17 00:00:00 2001 From: KarolK99 Date: Fri, 10 Nov 2023 17:38:20 +0100 Subject: [PATCH 1/3] Add API for s3 bucket --- docs/getting_started/components/hls.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/getting_started/components/hls.md b/docs/getting_started/components/hls.md index e14b7bfc..a27e926b 100644 --- a/docs/getting_started/components/hls.md +++ b/docs/getting_started/components/hls.md @@ -37,6 +37,10 @@ After a meeting that integrates an HLS component (with the persistent option set To manage this recording, use the [Recording API](../../for_developers/api_reference/rest_api#tag/recording). The recording is also available as HLS Video On Demand (VOD) [API](../../for_developers/api_reference/rest_api#tag/recording/operation/getRecordingContent). +## Store HLS stream on S3 +You can directly store your HLS streams on S3. This solution will automatically send your streams to an AWS bucket right after the end of your meetings. +When initializing your stream, simply include your S3 credentials as part of the configuration [API](http://localhost:3000/jellyfish-docs/next/for_developers/api_reference/rest_api#tag/room/operation/add_component). + ## Example Docker commands The HLS playlist will be created inside the Docker container. To access it from the host, From e3d3ed436bc75932a2e5a3aa1a5991ddc11ecfd2 Mon Sep 17 00:00:00 2001 From: KarolK99 Date: Tue, 14 Nov 2023 14:25:18 +0100 Subject: [PATCH 2/3] Change requests --- docs/getting_started/components/hls.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/getting_started/components/hls.md b/docs/getting_started/components/hls.md index a27e926b..ae88f1a8 100644 --- a/docs/getting_started/components/hls.md +++ b/docs/getting_started/components/hls.md @@ -22,6 +22,8 @@ See [API](../../for_developers/api_reference/rest_api#tag/room/operation/create_ * `persistent` (boolean, default: false) - whether the stream should be saved or not * `targetWindowDuration` (positive integer, default: null) - represents the duration, in seconds, of the live streaming content to be maintained in a rolling window. If set to null (default), the entire stream will be available. +* `s3`` (object, default: nil) - AWS S3 credentials. If credentials are set, the stream will be saved to the specified bucket. + ## Env variables Currently, there are no environment variables related to this component. @@ -38,7 +40,8 @@ To manage this recording, use the [Recording API](../../for_developers/api_refer The recording is also available as HLS Video On Demand (VOD) [API](../../for_developers/api_reference/rest_api#tag/recording/operation/getRecordingContent). ## Store HLS stream on S3 -You can directly store your HLS streams on S3. This solution will automatically send your streams to an AWS bucket right after the end of your meetings. +You can directly store your HLS streams on S3. +This solution will automatically send your streams to an AWS bucket right after the end of your meetings. When initializing your stream, simply include your S3 credentials as part of the configuration [API](http://localhost:3000/jellyfish-docs/next/for_developers/api_reference/rest_api#tag/room/operation/add_component). ## Example Docker commands From 8f5a26fbe152ec1c50b2cedcf8c5e61866ff4a2c Mon Sep 17 00:00:00 2001 From: Karol Konkol <56369082+Karolk99@users.noreply.github.com> Date: Tue, 14 Nov 2023 17:42:27 +0100 Subject: [PATCH 3/3] Update docs/getting_started/components/hls.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Michał Śledź --- docs/getting_started/components/hls.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting_started/components/hls.md b/docs/getting_started/components/hls.md index ae88f1a8..c67d26ee 100644 --- a/docs/getting_started/components/hls.md +++ b/docs/getting_started/components/hls.md @@ -22,7 +22,7 @@ See [API](../../for_developers/api_reference/rest_api#tag/room/operation/create_ * `persistent` (boolean, default: false) - whether the stream should be saved or not * `targetWindowDuration` (positive integer, default: null) - represents the duration, in seconds, of the live streaming content to be maintained in a rolling window. If set to null (default), the entire stream will be available. -* `s3`` (object, default: nil) - AWS S3 credentials. If credentials are set, the stream will be saved to the specified bucket. +* `s3` (object, default: nil) - AWS S3 credentials. If credentials are set, the stream will be saved to the specified bucket. ## Env variables