diff --git a/README.md b/README.md index b490e4c6..ef4e7aad 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@

- [![Website](https://img.shields.io/badge/website-website-blue)](https://mediamtx.org) + [![Website](https://img.shields.io/badge/website-mediamtx.org-1c94b5)](https://mediamtx.org) [![Test](https://github.com/bluenviron/mediamtx/actions/workflows/code_test.yml/badge.svg)](https://github.com/bluenviron/mediamtx/actions/workflows/code_test.yml) [![Lint](https://github.com/bluenviron/mediamtx/actions/workflows/code_lint.yml/badge.svg)](https://github.com/bluenviron/mediamtx/actions/workflows/code_lint.yml) [![CodeCov](https://codecov.io/gh/bluenviron/mediamtx/branch/main/graph/badge.svg)](https://app.codecov.io/gh/bluenviron/mediamtx/tree/main) diff --git a/docs/2-usage/4-read.md b/docs/2-usage/4-read.md index 0382b0c9..ec939e53 100644 --- a/docs/2-usage/4-read.md +++ b/docs/2-usage/4-read.md @@ -17,6 +17,7 @@ We provide instructions for reading with the following software: - [FFmpeg](#ffmpeg) - [GStreamer](#gstreamer) - [VLC](#vlc) +- [OBS Studio](#obs-studio) - [Unity](#unity) - [Web browsers](#web-browsers) @@ -276,6 +277,18 @@ snap install vlc At the moment VLC doesn't support reading encrypted RTSP streams. However, you can use a proxy like [stunnel](https://www.stunnel.org) or [nginx](https://nginx.org/) or a local _MediaMTX_ instance to decrypt streams before reading them. +### OBS Studio + +OBS Studio can read streams from the server by using the [RTSP protocol](#rtsp). + +Open OBS, click on _Add Source_, _Media source_, _OK_, uncheck _Local file_, insert in _Input_: + +``` +rtsp://localhost:8554/stream +``` + +Then _Ok_. + ### Unity Software written with the Unity Engine can read a stream from the server by using the [WebRTC protocol](#webrtc). diff --git a/docs/2-usage/6-authentication.md b/docs/2-usage/6-authentication.md index 562b0f7f..877d3a7a 100644 --- a/docs/2-usage/6-authentication.md +++ b/docs/2-usage/6-authentication.md @@ -166,6 +166,8 @@ These are the recommended methods for each client: | GStreamer | RTMP | Query parameter | | | any | SRT | unsupported | SRT truncates passwords and query parameters to 512 characters, so it's impossible to use SRT+JWT. See [#3430](https://github.com/bluenviron/mediamtx/issues/3430) | +### Keycloak setup + Here's a tutorial on how to setup the [Keycloak identity server](https://www.keycloak.org/) in order to provide JWTs: 1. Start Keycloak: