Add public OBS overlay modes, themes and token protection
This commit is contained in:
29
README.md
29
README.md
@@ -27,6 +27,35 @@ JMK RB RaceController is an RC timing and race-control system with support for s
|
||||
### Judging
|
||||

|
||||
|
||||
## Public Overlay And OBS
|
||||
|
||||
The app now supports a dedicated public overlay route so you do not need to expose the full admin UI externally.
|
||||
|
||||
- Public overlay route: `/public-overlay/<mode>`
|
||||
- OBS mode: `/public-overlay/obs`
|
||||
- OBS overlay can be configured from the `Overlay` menu:
|
||||
- rows
|
||||
- layout: `leaderboard`, `grid`, `lowerthird`
|
||||
- theme: `panel`, `transparent`, `chroma`
|
||||
- visible columns and blocks
|
||||
- Use `Copy OBS URL` to generate a ready-to-paste browser-source link for OBS.
|
||||
|
||||
If you want simple protection for public overlays, set this environment variable on the server:
|
||||
|
||||
```bash
|
||||
PUBLIC_OVERLAY_TOKEN=your-secret-token
|
||||
```
|
||||
|
||||
Then the public overlay URL must include:
|
||||
|
||||
```text
|
||||
/public-overlay/obs?token=your-secret-token
|
||||
```
|
||||
|
||||
Recommended deployment:
|
||||
- publish only `/public-overlay/*` through your reverse proxy
|
||||
- keep the main app/admin UI internal
|
||||
|
||||
## Features
|
||||
- Event modes:
|
||||
- `Race (driver transponders)`
|
||||
|
||||
Reference in New Issue
Block a user