From 30814f3f46c6b8a8b9481c32432b1bbe63b46830 Mon Sep 17 00:00:00 2001 From: Mark Rapson Date: Fri, 28 Aug 2026 20:24:10 +0100 Subject: [PATCH] Align environment documentation order --- docker-compose/README.md | 29 +++++++++++++++-------------- 1 file changed, 15 insertions(+), 14 deletions(-) diff --git a/docker-compose/README.md b/docker-compose/README.md index 5486ab4..e500af4 100644 --- a/docker-compose/README.md +++ b/docker-compose/README.md @@ -113,15 +113,15 @@ Important values: - `PULSE_SIGNAGE_WEB_IMAGE` - image to run for the web app and bridge services, typically `.../pulse-signage-web:latest` - `PULSE_SIGNAGE_PLAYER_IMAGE` - image to run for the player services, typically `.../pulse-signage-player:latest` - `PULSE_SIGNAGE_SHARED_SECRET` - long random secret shared by the web, player, and bridge services for authenticated requests -- `PLAYER_IDENTIFIER` - unique local player identifier - `DB_*` - MySQL credentials and database name for the stack +- `MYSQL_ROOT_PASSWORD` - root password for the local MySQL container +- `WEB_PUBLIC_URL` - public URL of the web application +- `WEB_INTERNAL_URL` - internal URL the bridge uses to call the web app directly +- `PLAYER_IDENTIFIER` - unique local player identifier - `PLAYER_PUBLIC_URL` - public URL the player advertises - `PLAYER_INTERNAL_URL` - internal URL the web app uses for local player calls - `BRIDGE_INTERNAL_URL` - bridge URL the web app uses for player snapshot and command forwarding -- `WEB_INTERNAL_URL` - internal URL the bridge uses to call the web app directly - `DEFAULT_ADMIN_*` - bootstrap admin account values -- `PASSWORD_HASH_ITERATIONS` - password hashing cost -- `MYSQL_ROOT_PASSWORD` - root password for the local MySQL container ### `.env.remote.example` @@ -163,19 +163,20 @@ Leave it blank only if you intentionally want to run without request signing in | `DB_USER` | web, player, bridge, mysql | Database user. | | `DB_PASSWORD` | web, player, bridge, mysql | Database password. | | `MYSQL_ROOT_PASSWORD` | mysql | Root password for the local MySQL container. | -| `DEFAULT_ADMIN_USERNAME` | web | Bootstrap admin username. | -| `DEFAULT_ADMIN_NAME` | web | Bootstrap admin display name. | -| `DEFAULT_ADMIN_PASSWORD` | web | Bootstrap admin password. | -| `PLAYER_INTERNAL_URL` | web, player | Internal player URL used by the dashboard and player runtime. | -| `BRIDGE_INTERNAL_URL` | web | Bridge URL used by the web app for player snapshot and command forwarding. | -| `WEB_INTERNAL_URL` | player-bridge | Internal web URL used by the bridge to call the dashboard app directly. | -| `PLAYER_PUBLIC_URL` | player, remote player | Public URL advertised by the player. | -| `BRIDGE_PUBLIC_URL` | player, remote player | URL of the bridge service. | -| `PLAYER_IDENTIFIER` | player | Stable player identifier. | -| `PLAYER_AGENT_RECONNECT_DELAY_MS` | remote player | Delay before reconnecting to the bridge. | | `MYSQL_DATABASE` | mysql | Database name used by the local MySQL container. | | `MYSQL_USER` | mysql | Database user used by the local MySQL container. | | `MYSQL_PASSWORD` | mysql | Database password used by the local MySQL container. | +| `WEB_PUBLIC_URL` | web, player-bridge | Public URL of the web application. | +| `WEB_INTERNAL_URL` | player-bridge | Internal web URL used by the bridge to call the dashboard app directly. | +| `PLAYER_IDENTIFIER` | player | Stable player identifier. | +| `PLAYER_PUBLIC_URL` | player, remote player | Public URL advertised by the player. | +| `PLAYER_INTERNAL_URL` | web, player | Internal player URL used by the dashboard and player runtime. | +| `BRIDGE_INTERNAL_URL` | web | Bridge URL used by the web app for player snapshot and command forwarding. | +| `DEFAULT_ADMIN_USERNAME` | web | Bootstrap admin username. | +| `DEFAULT_ADMIN_NAME` | web | Bootstrap admin display name. | +| `DEFAULT_ADMIN_PASSWORD` | web | Bootstrap admin password. | +| `BRIDGE_PUBLIC_URL` | remote player | URL of the bridge service. | +| `PLAYER_AGENT_RECONNECT_DELAY_MS` | remote player | Delay before reconnecting to the bridge. | ## Ports