From 063fb607f96942015814ade9c6ae8dceb4ae9f33 Mon Sep 17 00:00:00 2001
From: jolavillette <jolavillette@gmail.com>
Date: Mon, 6 Jul 2026 12:43:25 +0200
Subject: [PATCH] docs(BUILD): require RS_SERVICE_TERMINAL_WEBUI_PASSWORD=ON
 for the service WebUI

RS_WEBUI=ON alone builds the WebUI machinery, but retroshare-service then
has no way to turn it on: enableWebUI defaults to false and only the -W
flag ever sets it, and -W/-B are gated behind
RS_SERVICE_TERMINAL_WEBUI_PASSWORD (a cmake_dependent_option requiring
RS_WEBUI=ON). Document the flag and add it to every build command block.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
---
 BUILD-cmake.md | 17 +++++++++++------
 1 file changed, 11 insertions(+), 6 deletions(-)

diff --git a/BUILD-cmake.md b/BUILD-cmake.md
index 2a337aa0b..cbc7497b6 100644
--- a/BUILD-cmake.md
+++ b/BUILD-cmake.md
@@ -40,6 +40,11 @@ Other notes:
 - `RS_FORUM_DEEP_INDEX=OFF` on purpose (Xapian unused; re-enabled later via the
   ForumContentSearchFTS5 branch).
 - Ninja is used on all three platforms for consistency.
+- `RS_SERVICE_TERMINAL_WEBUI_PASSWORD=ON` is **required** for `retroshare-service`
+  to expose the `-W`/`-B` flags that enable and serve the WebUI. `RS_WEBUI=ON`
+  alone builds the WebUI machinery, but the service then has **no way to turn it
+  on** — `enableWebUI` defaults to false and only `-W` ever sets it, so the WebUI
+  never serves. It is a `cmake_dependent_option` requiring `RS_WEBUI=ON`.
 
 ## Submodules (init WITHOUT --remote)
 
@@ -97,7 +102,7 @@ rm -rf Build-cmake
 cmake -G Ninja -B Build-cmake -S . \
   -DCMAKE_POLICY_VERSION_MINIMUM=3.5 -DCMAKE_BUILD_TYPE=Release \
   -DCMAKE_DISABLE_FIND_PACKAGE_Qt6=ON \
-  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON \
+  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON -DRS_SERVICE_TERMINAL_WEBUI_PASSWORD=ON \
   -DRS_GUI=ON -DRS_SERVICE=ON -DRS_FRIENDSERVER=ON -DRS_PLUGINS=ON -DRS_FORUM_DEEP_INDEX=OFF \
   -DRS_USE_I2P_SAM3=ON -DRS_BITDHT=ON -DRS_MINIUPNPC=ON \
   -DRS_BRODCAST_DISCOVERY=ON -DRS_SQLCIPHER=ON
@@ -109,7 +114,7 @@ Build — **Qt6** (auto-selected once the qt6 `-dev` packages are installed):
 rm -rf Build-cmake
 cmake -G Ninja -B Build-cmake -S . \
   -DCMAKE_POLICY_VERSION_MINIMUM=3.5 -DCMAKE_BUILD_TYPE=Release \
-  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON \
+  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON -DRS_SERVICE_TERMINAL_WEBUI_PASSWORD=ON \
   -DRS_GUI=ON -DRS_SERVICE=ON -DRS_FRIENDSERVER=ON -DRS_PLUGINS=OFF -DRS_FORUM_DEEP_INDEX=OFF \
   -DRS_USE_I2P_SAM3=ON -DRS_BITDHT=ON -DRS_MINIUPNPC=ON \
   -DRS_BRODCAST_DISCOVERY=ON -DRS_SQLCIPHER=ON
@@ -178,7 +183,7 @@ cmake -G Ninja -B Build-cmake -S . \
   -DCMAKE_DISABLE_FIND_PACKAGE_Qt6=ON \
   -DOPENSSL_ROOT_DIR="$(brew --prefix openssl@3)" \
   -DBOTAN_ROOT_DIR="$(brew --prefix botan@2)" \
-  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON \
+  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON -DRS_SERVICE_TERMINAL_WEBUI_PASSWORD=ON \
   -DRS_GUI=ON -DRS_SERVICE=ON -DRS_FRIENDSERVER=ON -DRS_PLUGINS=ON -DRS_FORUM_DEEP_INDEX=OFF \
   -DRS_USE_I2P_SAM3=ON -DRS_BITDHT=ON -DRS_MINIUPNPC=ON \
   -DRS_BRODCAST_DISCOVERY=ON -DRS_SQLCIPHER=ON \
@@ -206,7 +211,7 @@ cmake -G Ninja -B Build-cmake -S . \
   -DCMAKE_PREFIX_PATH="$PREFIX" -DQt6_DIR="$QT6/lib/cmake/Qt6" \
   -DOPENSSL_ROOT_DIR="$(brew --prefix openssl@3)" \
   -DBOTAN_ROOT_DIR="$(brew --prefix botan@2)" \
-  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON \
+  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON -DRS_SERVICE_TERMINAL_WEBUI_PASSWORD=ON \
   -DRS_GUI=ON -DRS_SERVICE=ON -DRS_FRIENDSERVER=ON -DRS_PLUGINS=OFF -DRS_FORUM_DEEP_INDEX=OFF \
   -DRS_USE_I2P_SAM3=ON -DRS_BITDHT=ON -DRS_MINIUPNPC=ON \
   -DRS_BRODCAST_DISCOVERY=ON -DRS_SQLCIPHER=ON \
@@ -263,7 +268,7 @@ cmake -G Ninja -B Build-cmake -S . \
   -DCMAKE_POLICY_VERSION_MINIMUM=3.5 -DCMAKE_BUILD_TYPE=Release \
   -DRS_LIBRETROSHARE_STATIC=OFF -DRS_LIBRETROSHARE_SHARED=ON \
   -DCMAKE_DISABLE_FIND_PACKAGE_Qt6=ON \
-  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON \
+  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON -DRS_SERVICE_TERMINAL_WEBUI_PASSWORD=ON \
   -DRS_GUI=ON -DRS_SERVICE=ON -DRS_FRIENDSERVER=ON -DRS_PLUGINS=ON -DRS_FORUM_DEEP_INDEX=OFF \
   -DRS_USE_I2P_SAM3=ON -DRS_BITDHT=ON -DRS_MINIUPNPC=ON \
   -DRS_BRODCAST_DISCOVERY=ON -DRS_SQLCIPHER=ON \
@@ -278,7 +283,7 @@ rm -rf Build-cmake
 cmake -G Ninja -B Build-cmake -S . \
   -DCMAKE_POLICY_VERSION_MINIMUM=3.5 -DCMAKE_BUILD_TYPE=Release \
   -DRS_LIBRETROSHARE_STATIC=OFF -DRS_LIBRETROSHARE_SHARED=ON \
-  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON \
+  -DRS_RNPLIB=ON -DRS_JSON_API=ON -DRS_WEBUI=ON -DRS_SERVICE_TERMINAL_WEBUI_PASSWORD=ON \
   -DRS_GUI=ON -DRS_SERVICE=ON -DRS_FRIENDSERVER=ON -DRS_PLUGINS=OFF -DRS_FORUM_DEEP_INDEX=OFF \
   -DRS_USE_I2P_SAM3=ON -DRS_BITDHT=ON -DRS_MINIUPNPC=ON \
   -DRS_BRODCAST_DISCOVERY=ON -DRS_SQLCIPHER=ON \