diff options
Diffstat (limited to 'docs/PACKAGING-GUIDE.md')
| -rw-r--r-- | docs/PACKAGING-GUIDE.md | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/docs/PACKAGING-GUIDE.md b/docs/PACKAGING-GUIDE.md index 0f9997d..5a5c388 100644 --- a/docs/PACKAGING-GUIDE.md +++ b/docs/PACKAGING-GUIDE.md @@ -59,6 +59,51 @@ sudo rpm -e meshbay-client meshbay-hub meshbay-node meshbay-common --- +## Windows + +One installer, **`MeshBay-Setup-<version>.exe`**, carries the client **and** the +node (with `meshbay-common` inside it). There is no Windows hub. + +### Install + +Run the installer. It is **per-user** — no administrator prompt — and lands in +`%LOCALAPPDATA%\Programs\meshbay-client\`. The node daemon ships beside the app +at `resources\node-runtime\meshbay-node.exe`; the client finds it automatically. + +**ffmpeg** is required for video streaming and is *not* in the installer unless +it was built with `-FfmpegDir`. Otherwise install it separately +(`winget install ffmpeg`) so the node finds it on `PATH`. + +### First run + +Open MeshBay and sign in. Use the **Node** page (or a terminal) to provision: + +``` +meshbay-node init +meshbay-node autostart install # run the daemon at every sign-in (no admin) +``` + +Runtime data — `node.toml`, `keystore.enc`, `unlock.key`, `data\` — lives in +`%LOCALAPPDATA%\meshbay\` and **survives uninstall/reinstall**. + +### Uninstall + +*Apps & features → MeshBay → Uninstall*, or the Start-menu *Uninstall MeshBay* +entry. It stops a running daemon and removes the sign-in launcher; it does not +touch `%LOCALAPPDATA%\meshbay\` (the keystore). + +### Build from source + +See [`packaging/win/README.md`](../packaging/win/README.md). On a machine with +Node ≥ 22 and Python ≥ 3.12: + +```powershell +cd packages\meshbay-client +npm run dist:win +``` + +--- + ## Post-install: Node (desktop user) ### 1. Initialize |