aboutsummaryrefslogtreecommitdiffstats
path: root/docs/QUICKSTART.md
diff options
context:
space:
mode:
authorChristophe Besson <cbesson@gmail.com>2026-10-12 01:27:00 +0200
committerChristophe Besson <cbesson@gmail.com>2026-10-12 01:27:00 +0200
commit3324b4eb701e34f64e859dd90937793ccf7f75c5 (patch)
treef22af245c36b76a1a158b91cc97f98df763ecb0f /docs/QUICKSTART.md
parent14911aae21ec4975f7a805b91e3c4867cb41974b (diff)
downloadmeshbay-3324b4eb701e34f64e859dd90937793ccf7f75c5.tar.gz
feat: keep the sidebar for groups; search in the nav, the rest in the user menu
Search is an icon in the nav, left of the tray button and the bell, and marks itself current on its page. Administration, Node, Create group and Android Sync moved to the user menu, between Settings and the theme, each under the condition it had in the sidebar. The sidebar keeps Public groups and the groups. On a phone, a tablet or the Android application the menu trigger is the avatar alone (max-width 768px or a coarse pointer); the name is the dropdown's first line, one line with an ellipsis. Measured: a 20-character handle put the trigger 159 px off a 320 px screen with search and transfers in the nav, and a 64-character one pushed the dropdown 122 px off the left. Creating a group is a desktop-application feature by design: a hand-typed #/create-group no longer opens the form in a browser, and QUICKSTART step 6 now says to use the desktop application instead of the browser. test_layout_responsive read only the first 768px media block; it reads them all now. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Diffstat (limited to 'docs/QUICKSTART.md')
-rw-r--r--docs/QUICKSTART.md23
1 files changed, 15 insertions, 8 deletions
diff --git a/docs/QUICKSTART.md b/docs/QUICKSTART.md
index ea75cab..cfb0743 100644
--- a/docs/QUICKSTART.md
+++ b/docs/QUICKSTART.md
@@ -48,8 +48,11 @@ Three things, and it is worth knowing which is which before you start:
- [ ] **An email address** you can read — account sign-up sends a code to it.
- [ ] **About half an hour**, plus however long a first index takes — which
depends on how much you are sharing, and does not need watching.
-- [ ] **Terminal access** to that machine. Everything below works over SSH; no
- graphical session is needed on the node.
+- [ ] **Terminal access** to that machine. Everything on the node works over
+ SSH; no graphical session is needed there.
+- [ ] **The desktop application, on any computer with a screen** — the node
+ machine or another one. Creating a group is done there and only there
+ (Step 6).
You do **not** need a static IP, a domain name, port forwarding, or a router
you control. Two residential ISPs have been measured working without any of it.
@@ -65,11 +68,11 @@ distribution:
|---|---|---|
| **`meshbay-common`** — required, install it first | `.deb` | `.rpm` |
| **`meshbay-node`** — the daemon that hosts your files | `.deb` | `.rpm` |
-| `meshbay-client` — the desktop application, optional | `.deb` | `.rpm` |
+| `meshbay-client` — the desktop application | `.deb` | `.rpm` |
-You need the first two. The desktop application is worth having if this machine
-has a screen, but nothing in this guide requires it: a terminal and a browser
-are enough.
+The node machine needs the first two. The desktop application goes on whichever
+computer you will sit at — this one if it has a screen, another one otherwise:
+Step 6 needs it, because a group cannot be created from a browser.
Put them in one directory — the next step installs them together.
@@ -91,7 +94,8 @@ sudo apt install ./meshbay-common_*.deb ./meshbay-node_*.deb
sudo dnf install ./meshbay-common-*.rpm ./meshbay-node-*.rpm
```
-Add `./meshbay-client_*` to that line to install the desktop application too.
+Add `./meshbay-client_*` to that line if this is also the computer you will use
+the desktop application on.
`meshbay-common` carries everything the others need, so there is nothing else
to install and no Python environment to set up. **ffmpeg**, required for video
@@ -208,7 +212,10 @@ correct.
## Step 6 — Create the group
-In the browser, on meshbay.org: **Create group** in the sidebar.
+In the **desktop application**, signed in with your account: **Create group**
+in the menu under your avatar, top right. It is there once the node key from
+Step 4 is linked to your account. A browser does not offer it: creating a group
+is a desktop-application feature, by design.
- **Name** — anything. It is shown to members as `name@yourusername`.
- **Join policy** — leave it on **Invite only**. The alternative, *Open*, lists