aboutsummaryrefslogtreecommitdiffstats
path: root/docs/USERGUIDE.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/USERGUIDE.md')
-rw-r--r--docs/USERGUIDE.md20
1 files changed, 18 insertions, 2 deletions
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md
index eb9452e..d631804 100644
--- a/docs/USERGUIDE.md
+++ b/docs/USERGUIDE.md
@@ -394,7 +394,9 @@ resume.
**Desktop application only.** A film playing in the application can be sent to a
cast-capable TV or dongle on the same network: *Cast to device* in the player,
-pick one from the list.
+pick one from the list. Devices appear as they answer, usually within a couple
+of seconds; the search carries on for a few more, for a TV that is still
+waking up.
The application decrypts the film and relays it to the TV itself, over your LAN.
The TV is not a group member and holds no key — which is also why the relay's
@@ -435,6 +437,11 @@ list you build yourself with invitation codes. Two things follow from that:
| **The CLI**, over SSH | no browser needed, and it works while the daemon is stopped |
| **A paired browser** | the group's Settings and Members tabs, and the Node page in the desktop application |
+Sharing is decided at the node. Adding a directory, and switching it read-write
+or removable, work only on the machine running the node — the desktop
+application, or `meshbay-node root`. From any other browser the group's
+Settings tab still lists the directories and their switches, read-only.
+
On a headless server the CLI is the only path, and it covers everything you
need to run a group. One gap is known: removing **one** device of one member is
only doable from the interface (§7). Start with:
@@ -893,13 +900,22 @@ the confirmation on destructive commands. `man meshbay-node` has the full page.
| `~/.config/meshbay/node.toml` | configuration — hand-edited, commented, preserved |
| `~/.config/meshbay/node.env` | environment: keystore unlock, third-party tokens |
| `~/.config/meshbay/keystore.enc` | the node's own keys. **Back this up.** |
-| `~/.config/meshbay/unlock.key` | what opens the keystore. Mode 0600. |
+| `~/.config/meshbay/unlock.key` | what opens the keystore. Mode 0600. Whoever has both files opens the keystore, and with it the group chat this node stores |
| `~/.local/share/meshbay/` | roster, indexes, chat, caches, thumbnails |
| `/opt/meshbay-common/venv/` | the shared Python environment |
Losing the keystore means a new node identity: every group has to be re-linked
and every member re-admitted. It is small — back it up somewhere safe.
+The chat this node stores is encrypted under the keystore, and the keystore is
+opened by `unlock.key`, which sits beside it. A stolen disk, an image of the
+machine or a backup of your home directory therefore holds everything needed to
+read it. What protects those is the disk's own encryption — BitLocker or device
+encryption on Windows, LUKS on Linux — or keeping the unlock key on other
+storage: point `[keystore] unlock_file` in `node.toml` at it and remove
+`unlock.key`. (`node.env` is in the same directory, so moving the key there
+changes nothing.) The node then cannot start without that storage.
+
### Ports
| | |