Updated Docs
This commit is contained in:
@@ -58,10 +58,10 @@ You can override the seeded admin credentials with these environment variables:
|
||||
|
||||
#### Database
|
||||
|
||||
- `DB_HOST` - MySQL or MariaDB host, default `127.0.0.1`
|
||||
- `DB_HOST` - MySQL or MariaDB host, default `mysql`
|
||||
- `DB_PORT` - MySQL or MariaDB port, default `3306`
|
||||
- `DB_NAME` - database name, default `signage`
|
||||
- `DB_USER` - database user, default `signage_user`
|
||||
- `DB_NAME` - database name, default `pulse-signage`
|
||||
- `DB_USER` - database user, default `pulse-signage`
|
||||
- `DB_PASSWORD` - database password, default `signage_password`
|
||||
|
||||
The default database container uses MySQL 8.4, but the app can also run against a compatible MariaDB server if you swap the image.
|
||||
|
||||
+3
-1
@@ -2,7 +2,9 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Player service base URL: `http://localhost:3001`
|
||||
Player service base URL default for local setups: `http://localhost:3001`
|
||||
|
||||
In Docker or behind a reverse proxy, use the player service address exposed in your deployment instead.
|
||||
|
||||
This document covers the player HTTP surface only. The admin dashboard exposes its own routes for screen commands and onboarding management.
|
||||
|
||||
|
||||
+4
-2
@@ -2,7 +2,9 @@
|
||||
|
||||
## Overview
|
||||
|
||||
Player service websocket base URL: `ws://localhost:3001`
|
||||
Player service websocket base URL default for local setups: `ws://localhost:3001`
|
||||
|
||||
In Docker or behind a reverse proxy, use the websocket address that matches your player service exposure.
|
||||
|
||||
This document uses OpenAPI-style sections, but stays in plain markdown.
|
||||
|
||||
@@ -15,7 +17,7 @@ Player control channel.
|
||||
|
||||
This is the bidirectional socket used by the player page. The player sends status messages to the server, and the server sends commands back to the player.
|
||||
|
||||
Access: the player page must include a valid `auth` query parameter signed with the shared secret. The browser page refreshes this token automatically while it is active.
|
||||
Access: the player page appends a valid `auth` query parameter signed with the shared secret when one is configured. The browser page refreshes this token automatically while it is active.
|
||||
|
||||
### `GET /ws/screens/{slug}/events`
|
||||
Player snapshot channel.
|
||||
|
||||
Reference in New Issue
Block a user