Update README with Dolphin GUI flow, remote usage instructions, and release checklist
This commit is contained in:
30
README.md
30
README.md
@@ -68,6 +68,26 @@ Installed into:
|
||||
- Plasma 6: `/usr/share/kio/servicemenus/`
|
||||
- Plasma 5: `/usr/share/kservices5/ServiceMenus/`
|
||||
|
||||
### 🖱️ Dolphin (GUI) Flow — Share with Invite
|
||||
|
||||
1. **Right-click a folder → “Share via BackTunnel…”**
|
||||
2. Enter **Remote** (`user@host` or `user:host`), choose **Duration**, **Tunnel port** (default `2222`), and **Local SSH port** (default `22`).
|
||||
3. When prompted:
|
||||
- **Print invite line for chat?** → Yes to get a one-liner your colleague can paste.
|
||||
- **Show QR code for the invite?** → Yes (requires `qrencode`) to display a terminal QR.
|
||||
- **Suggested mount point** → Accept `/mnt/remote-rssh` or set your own.
|
||||
4. A terminal opens, shows the **invite** (and QR if selected), and keeps the share open for the chosen duration.
|
||||
- Stop early with **Ctrl+C**.
|
||||
|
||||
**What the remote user does (on the remote host):**
|
||||
|
||||
```bash
|
||||
# Paste the invite you sent them, e.g.:
|
||||
backtunnel-access '/path/to/folder' from user@vps.example.com -p 2222 -m '/mnt/remote-rssh'
|
||||
# Unmount when done:
|
||||
fusermount -u /mnt/remote-rssh # or: umount /mnt/remote-rssh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Requirements
|
||||
@@ -89,6 +109,16 @@ sudo bash scripts/uninstall.sh
|
||||
|
||||
---
|
||||
|
||||
## 📦 Release checklist (BackTunnel v1.2.x)
|
||||
|
||||
1. **Version bump** (if needed) in docs/man where referenced (man page already shows `1.2`).
|
||||
2. **Tag the repo**:
|
||||
|
||||
```bash
|
||||
git tag -a v1.2.0 -m "BackTunnel 1.2.0"
|
||||
git push --tags
|
||||
```
|
||||
|
||||
## 📖 Man Page
|
||||
```bash
|
||||
man backtunnel
|
||||
|
||||
Reference in New Issue
Block a user