Grove User Guide
<!-- grove:last-verified v1.98 -->
Dashboard Overview
The Grove dashboard is a single-page app with tabs:
| Tab |
What it does |
| ๐ Home |
Cell status, storage, network health, activity log |
| ๐ Files |
Browse your file tree, upload, organize โ your content (like a drive) |
| ๐ก Feed |
Files shared with you by friends โ signal, not storage |
| ๐ฌ Chat |
E2E encrypted messaging with peers |
| ๐ค AI |
GroveAI chat + search (visible only when AI is configured) |
| โ๏ธ Settings |
Cell name, password, theme, relay, remote access, backup |
> No separate Invites tab. Invite management lives in โ๏ธ Settings โ ๐ Cells.
Files Tab
Your content. Think of it like Google Drive, but encrypted and peer-replicated.
Uploading Files
- Drag and drop files onto the upload zone, or click to browse
- Progress bar shows speed (MB/s) and ETA
- Generic filenames from mobile (image.jpg, photo.jpg) auto-timestamped
- Files are automatically encrypted, chunked, and synced to peers
View Modes
- ๐ List view โ traditional file list with details
- ๐ผ๏ธ Gallery view โ image grid with thumbnails (click toggle in header)
- Sort: A-Z, Size, or Date buttons โ click again to toggle asc/desc
File Type Icons
Files show type-specific icons: ๐ผ๏ธ image, ๐ฌ video, ๐ต audio, ๐ text, ๐ PDF, ๐ฆ archive, ๐ document, ๐ spreadsheet, ๐ฝ๏ธ presentation, โ๏ธ executable
File Actions (โฏ menu)
For files on this device and backed up (the "On device + backed up" badge):
- โ๏ธ Rename โ rename the file in place
- โฌ Download โ download file to your device (works from phone too)
- ๐ Share โ share with friend cells
- ๐ Show in Portal โ toggle file visibility on your linked remote portal (owner only)
- โ๏ธ Free up space (keeps backup) โ removes the on-device copy; the file stays backed up on your peers
- ๐ฒ Stop backing up (keeps this file) โ permanently deletes the encrypted copies on your peers; your local file stays put in GroveHome (this is not the Recycle Bin โ the backup is gone for good)
For Backup only files (no local copy):
- ๐ Restore local copy โ download it back from peers to this device
(Files in GroveHome back up to your peers automatically โ there's no per-file "back up" button to press.)
Rename and Move
- Rename: โ๏ธ Rename in the โฏ menu โ edits in place
- Move: Select files with checkboxes โ Move batch button โ pick destination folder
Folders
- ๐๏ธ Watch โ auto-backup new or modified files in this folder (two options: Watch Only, or Watch + Back Up)
- ๐ Auto-Share โ auto-share new files added to this folder with a friend cell
- ๐ก Serve as Site โ publish folder as a web site with audience control (see Renderers below)
- Click a folder to browse into it
- Batch operations: select multiple files/folders with checkboxes
Renderers (Folder-Level)
When you're inside a folder, you can optionally assign it a role:
- ๐ก Site โ serves as a web page at
/site/<slug>/ with configurable audience (see Sharing)
- Photo and markdown folders get suggestions to serve as a gallery or reader
- ๐ต Music and ๐ฌ Video โ a folder full of audio or video files renders as a library + player
- ๐ธ Tabs โ a folder of Guitar Pro files (
.gp, .gp3, .gp4, .gp5, .gpx) renders as tablature in-browser (vendored alphaTab); individual tab files also preview in Files, Feed, and Shared with me
A folder auto-switches to a media role when it holds at least 3 files of that type and they make up at least half its contents. You can also set it by hand: inside the folder, click ๐ต show as music, ๐ฌ show as video, or ๐ธ show as tabs (shown once there are 3+ matching files), and show as files to revert. The role sticks.
Music & Video Folders
A media folder looks like a music app's library: a track list with a player. Track titles come from the filename (a leading track number like 03 - is stripped), so name your files how you want them to read โ there's no tag reading yet. Sub-folders become a nested tree, so an Artist/Album or Show/Season layout just works.
The player is a compact sticky bar at the bottom:
- Play/pause, previous/next, and a seek scrubber
- ๐ Shuffle and the now-playing title
- Auto-advances to the next track when one finishes
- Lossless audio (FLAC, WAV, ALAC, AIFF) shows a lossless badge
- One player handles both music and video. For video, tap โถ to watch the picture full-screen โ the bar itself stays compact
Big files start instantly and seek anywhere without downloading the whole thing first. Formats your browser can't play in-page (MKV, AVI, some MOV/HEVC) show a Can't play this format here ยท Download link instead of failing silently; MP4, WebM, M4V, OGV and common audio play inline. This works the same everywhere: friends and family see music and video folders in their Files view (and on the portal), no separate tab โ and a media folder someone shares with you renders as a library on your side too, inside ๐ฅ Shared with me (below).
๐ฅ Shared with me
Files and folders other cells share with you show up as a synthetic ๐ฅ Shared with me Smart Folder at the top of your Files tree (not the Feed โ the Feed is just signal). Inside it there's one virtual sub-folder per sending cell, with that sender's own folder layout preserved underneath, so you can browse a share exactly as they organized it. A shared Music or Video folder auto-renders as a library + player here, same as the portal.
This is where you turn a share into your own copy:
- ๐ฒ Add to Grove โ decrypts the file, saves it to GroveHome, ingests it as your own, and syncs it to your peers. It's a two-tap guard: the first tap arms it (button flips to ๐ Tap to confirm), a second tap within 3 seconds commits, otherwise it reverts. Just viewing a shared file never keeps a copy โ only Add to Grove uses your storage.
Source Missing
If a tracked file's local copy moves out of a watched folder or gets deleted and can't be auto-relinked, it lands in the collapsible ๐ Source Missing card in the Files tab. Nothing is lost โ the chunks are kept, so the file is fully recoverable until you decide.
- Items are grouped into a compressed folder tree (click a folder to expand)
- โป๏ธ Restore โ rebuild the file from its kept chunks, back where it was
- ๐ฅ Delete / ๐ฅ Delete all (N) โ permanently remove one file, or a whole folder's worth, manifests and chunks included
- Move the file back into a watched folder and it relinks itself โ no action needed
Recycle Bin
Deleted files go to the Recycle Bin for 24 hours before permanent removal โ Grove-tracked files and untracked files/folders (a true Trash holding area). A banner appears at the top of the Files tab when items are pending.
- View bin โ โ scroll to the Recycle Bin section
- Restore โ recover a deleted item before the timer expires
- Empty Recycle Bin โ permanently delete all items immediately
Feed Tab
A running signal of what friends have shared with you, plus your outgoing shares. It's a notification stream โ not a place to store things. To actually browse or keep an incoming share, open ๐ Files โ ๐ฅ Shared with me.
Views
- ๐ผ๏ธ Gallery โ photo grid (default), great for shared images
- ๐ List โ detailed list with action buttons
File Actions
The Feed is signal only โ the actual copy-into-your-drive step lives in the Files tab now (see ๐ฅ Shared with me).
- ๐ View in Files โ jumps to where the file lives: incoming shares open the ๐ฅ Shared with me Smart Folder; your own outgoing shares open the file's directory
- โ Dismiss โ hide from your Feed (doesn't affect the file or the share; the folder stays in Files)
- ๐ซ Unshare โ revoke sharing (outgoing only)
File States
- Available โ chunks present, ready to view
- ๐ Verified โ cryptographic signature verified
- Unavailable โ chunks not yet on your cell
Lightbox
Click any image to view full-size. Background scroll is locked. Navigate with:
- โ โถ buttons or arrow keys
- Escape to close
- Click outside image to close
- โฌ Download (Files tab) or ๐ View in Files โ (Feed tab โ jumps to the file; Add to Grove is a Files-tab action)
Sharing Files
How to Share
1. Go to Files tab
2. Click โฏ on a file or folder โ ๐ Share
3. Search for and select the friend cell to share with
4. For folders: optionally enable ๐ Auto-share new files added to this folder
5. Click Share
What Happens
- A signed grant is created for the recipient (envelope-encrypted with X25519 โ only they can decrypt)
- Grant is pushed to their cell immediately
- File appears in their Feed tab
Unsharing
- Click โฏ โ ๐ซ Unshare
- Select which peers to revoke
- Their grant is deleted; they lose access
See SHARING.md for full details on grants, folder sharing, Show in Portal, and audience tiers.
Chat
End-to-end encrypted messaging between peers.
- X25519 key exchange โ each message encrypted with recipient's public key
- ChaCha20-Poly1305 โ message encryption
- Messages stored locally on each cell (not on relay)
- Relay carries encrypted messages but can't read them
- Chat input is a multi-line textarea: Enter sends, Shift+Enter for newline
GroveAI Tab
Visible only when AI is configured on at least one cell in your grove.
- ๐ฌ Chat mode โ conversation thread; persists across sessions; supports multiple conversations
- ๐ Search mode โ one-shot question, clean single answer (no thread)
- Tier selector โ per-message quality control; options depend on what's in your grove:
- Lower tiers = faster, cheaper, smaller models
- Higher tiers = more capable models; routes to the best available peer
- Auto โ picks the cheapest model that can handle the question
- ๐จ Image Generation โ available only on cells with the local Flux stack (currently Mac only); generates images from a text prompt; output lands in
~/GroveHome/Images/AI/ even if you close the tab
GroveAI routes to the best LLM in your grove automatically. If no local model is available, the tab may show as offline.
Cells / Peers
Managed from within the โ๏ธ Settings tab under the ๐ Cells section.
Cell Status
- ๐ข Green dot โ online and reachable
- ๐ด Red dot โ offline or unreachable
- โญ Star โ favorite cell (always syncs first)
Cell Actions
- ๐ฅ โ Add/remove as friend (friends can share files)
- โญ โ Toggle favorite
- โ๏ธ โ Rename (edit display name)
- โ โ Remove cell (choice: keep or delete their files)
Adding Cells
- Invite link โ create from Settings โ ๐ Cells, send to person
- Manual โ enter IP/hostname in Add Cell form
- Discovery โ auto-discover cells on local network (mDNS)
- Recommendations โ existing cells can recommend new ones
Storage
Two-Bar Display (Home tab)
- ๐พ Disk โ total disk usage (Grove + other files + free space)
- ๐ฒ Grove Storage โ breakdown of Grove data:
- Your files โ files you own, stored locally + on peers
- Backed up only โ your files only on peers (removed locally)
- Shared โ files shared with you by peers
- Helping peers โ encrypted chunks you're storing for others
Backup Health
Shows how many copies of your chunks exist across the fleet:
- ๐ข Green โ at or above desired replication factor
- ๐ก Yellow โ below desired but above minimum
- ๐ด Red โ at risk (single copy only)
Replication Factor
Default: 3 (your cell + 2 peers). Change in Settings โ My Cell.
- Higher = safer but uses more storage across the fleet
- Opp sync automatically maintains the target
Network Health
- Sync status โ banner shows when background sync is active
- Cells list โ all connected cells with status, speed, and actions (Settings โ Cells)
- Activity log โ recent events (uploads, syncs, shares, errors) on Home tab
- Route benchmark โ runs every 6 hours, measures actual throughput
Settings
The โ๏ธ Settings tab has two collapsible sections:
๐ฌ My Cell
- Cell name โ how other cells see you
- Password โ change dashboard password
- Appearance โ Grove Theme (5 named themes: Honey Hearth, Fern Hollow, Cherry Blossom, Twilight Plum, Midnight Garden) + light/dark toggle
- ๐ Identity Backup โ download/restore your Ed25519 keys (keep these safe)
- ๐ Recovery โ generate a one-use password reset link (valid 24h)
- โ๏ธ Advanced Settings (collapsed):
- ๐ Remote Access โ link this cell to a WAN gateway portal so you can reach it from the web without Tailscale; use "๐ Show in Portal" on files to expose them there
- Portal Host โ enable this cell to host portal accounts for others
- ๐ Relay โ configure relay server, relay hosting, and relay preferences
๐ Cells
- Full peer/cell roster
- Friend toggles, favorites, rename, remove
Keyboard Shortcuts
| Key |
Action |
| Escape |
Close lightbox/modal |
| โ โ |
Navigate gallery lightbox |
| Enter |
Send chat message |
| Shift+Enter |
New line in chat |
Tips
- First time? A tutorial appears on first load โ follow the tips!
- Slow uploads? Check your replication factor (lower = fewer copies to push)
- File missing? Check "Backup only" files in Files view โ it may need a Restore
- Peer offline? Chunks auto-heal to other peers after ~5 minutes
- Want privacy? All chunks are encrypted. Even your peers can't read your files.
- Deleted by accident? Check the Recycle Bin โ you have 24 hours to restore
- Access from anywhere? Set up Remote Access in Settings โ Advanced to reach your files without Tailscale