diff options
Diffstat (limited to 'docs/USERGUIDE.md')
| -rw-r--r-- | docs/USERGUIDE.md | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/docs/USERGUIDE.md b/docs/USERGUIDE.md index 0589929..6a86897 100644 --- a/docs/USERGUIDE.md +++ b/docs/USERGUIDE.md @@ -226,15 +226,15 @@ The person running the group can send you a **link** instead of a code — the way in when you have no account yet. 1. **Open the link.** It says *"You have been invited"*. -2. **Create an account** with the e-mail address the invitation was sent to — - exactly that address — or sign in if you already have one. Confirm your - address with the code the hub mails you, then sign in. +2. **Create an account**, with any e-mail address you like, or sign in if you + already have one. Confirm your address with the code the hub mails you, + then sign in. 3. You are brought back to the invitation: *"… invites you to join …"*. **Join.** 4. The group opens, and you type no code: the link carried it. -The link works once, and only for the account registered with that address; to -anyone else it says it was sent to another address. In the desktop +The link works once, for seven days: after that, or once somebody has used it, +it says it is no longer valid — ask for a new one. In the desktop application, paste the link into **Join with an invitation link** on the home page. @@ -522,7 +522,7 @@ and running `meshbay-node reload`: | Setting | Default | What it decides | |---|---|---| -| `invite_ttl_hours` | 168 (7 days) | how long an invitation stays usable | +| `invite_ttl_hours` | 168 (7 days) | how long an invitation code stays usable (an invitation link is always 7 days) | | `pair_ttl_hours` | 24 | how long an operator pairing code lasts | | `device_request_ttl_minutes` | 60 | how long a device request waits for approval | | `max_concurrent_streams` | 8 | how many people can watch video at once | @@ -570,16 +570,20 @@ need to be online then. **Inviting someone who has no account yet** is a link: ```bash -meshbay-node member invite alice@example.org --link +meshbay-node member invite --link meshbay-node member cancel <link id> # printed with the link, and in member list ``` -or the **Invite by link** box in the Members tab, under the first one: type -their e-mail address and **Create link**. Send them the -link, or leave **Send the invitation by e-mail** ticked and the hub mails it. -They register with that address and land in the group without typing a code. -The link works once and only for an account with that address, so a copy that -travels further — a forwarded mail, a chat — lets nobody else in. Links nobody +or the **Invite by link** box in the Members tab, under the first one: **Create +link**, then **Copy** it — or **Share** it, on a phone — and send it however you +like: a messaging application, a text. The e-mail address is optional: type one +and leave **Send the invitation by e-mail** ticked, and the hub mails the link +there too; it also names the link in the list below. They register (with any +address) and land in the group without typing a code. +**The link is for whoever opens it first**: it works once, for seven days, and +anyone holding it can use it — so send it only to the person it is for, and +**Cancel** it if it went somewhere else. You are notified when somebody joins +through one. Links nobody has used yet are listed under the box, and **Cancel** takes one back; once somebody joins through a link it leaves that list, and they are in the member list above it. A hub mails at most ten @@ -855,7 +859,7 @@ and every member re-admitted. It is small — back it up somewhere safe. | | | |---|---| | Invitation code | 7 days, single use, one account, one group | -| Invitation link | 7 days, single use, one group, the account registered with its address; 20 pending per group | +| Invitation link | 7 days (fixed), single use, one group, whoever opens it first; 20 pending per group | | Operator pairing code | 24 hours | | Device linking code | 1 hour | | Devices per account per node | 5 | |