diff options
Diffstat (limited to 'docs/PACKAGING-GUIDE.md')
| -rw-r--r-- | docs/PACKAGING-GUIDE.md | 38 |
1 files changed, 28 insertions, 10 deletions
diff --git a/docs/PACKAGING-GUIDE.md b/docs/PACKAGING-GUIDE.md index c4f6b00..4dcda30 100644 --- a/docs/PACKAGING-GUIDE.md +++ b/docs/PACKAGING-GUIDE.md @@ -67,15 +67,24 @@ node (with `meshbay-common` inside it). There is no Windows hub. ### Install Run the installer. It is **per-user** and lands in -`%LOCALAPPDATA%\Programs\meshbay-client\` without needing admin rights. The +`%LOCALAPPDATA%\Programs\MeshBay\` without needing admin rights. The node daemon ships beside the app at `resources\node-runtime\meshbay-node.exe`; the client finds it automatically. -It does ask one thing: **"Allow MeshBay through Windows Firewall now?"** — -say yes and one administrator confirmation adds both inbound rules the client -and the node need for WebRTC. Say no and the install finishes the same either -way; Windows will show its own "Allow access" dialog instead, once for each, -the first time they actually need to accept a connection. +It asks two things, both skippable: + +- **"Run MeshBay Node as a background service?"** — Yes starts the node **at + boot, before you even sign in**, and needs one administrator confirmation + (which also sets up the firewall rules, in the same step — see below). No + keeps the normal per-user mode: the node starts when you sign in, with no + admin needed, and you can turn autostart on later from the Node page. +- **(per-user mode only) "Allow MeshBay through Windows Firewall now?"** — one + administrator confirmation adds the inbound rules the client and the node + need for WebRTC and casting. Declining is fine — Windows shows its own + "Allow access" dialog instead, the first time each is actually used. + +Running setup again (an upgrade, a repair install) asks neither question if +the firewall rules are already there. **ffmpeg** is required for video streaming and is *not* in the installer unless it was built with `-FfmpegDir`. Otherwise install it separately @@ -87,17 +96,26 @@ 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) +meshbay-node autostart install # per-user mode: run at every sign-in (no admin) +meshbay-node service install # service mode: run at boot (needs an elevated prompt) ``` +The Node page's Start/Stop/Restart buttons work the same either way — they +drive the Scheduled Task when service mode is active, or the daemon process +directly otherwise. + Runtime data — `node.toml`, `keystore.enc`, `unlock.key`, `data\` — lives in -`%LOCALAPPDATA%\meshbay\` and **survives uninstall/reinstall**. +`%LOCALAPPDATA%\meshbay\` and **survives uninstall/reinstall**, in either mode +(service mode runs as your own account too — never LocalSystem — so nothing +about where your data lives changes). ### 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). +entry. It stops a running daemon and removes the sign-in launcher; it offers +(opt-in, one admin confirmation) to also remove the firewall rules and the +boot-time service task, if you set one up. None of this touches +`%LOCALAPPDATA%\meshbay\` (the keystore). ### Build from source |