update documentation (#4914)

This commit is contained in:
Alessandro Ros
2025-08-30 16:52:53 +02:00
committed by GitHub
parent 1a5e736b59
commit f29299db39
3 changed files with 16 additions and 1 deletions

View File

@@ -6,7 +6,7 @@
<br>
<br>
[![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)

View File

@@ -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).

View File

@@ -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: