Remove decorative emojis from README headers and script output for improved consistency
This commit is contained in:
30
README.md
30
README.md
@@ -5,7 +5,7 @@ No third-party relay, no cloud dependency – just peer-to-peer, temporary, SSH-
|
||||
|
||||
---
|
||||
|
||||
## ⚡ Quick Start
|
||||
## Quick Start
|
||||
|
||||
### 1. Accessor: Prepare your key (one-time)
|
||||
|
||||
@@ -37,7 +37,7 @@ backtunnel-umount ~/remote-rssh
|
||||
|
||||
---
|
||||
|
||||
## ✨ Features
|
||||
## Features
|
||||
|
||||
- **NAT/firewall friendly**: works without port forwarding.
|
||||
- **Temporary by design**: shares auto-expire after a set duration.
|
||||
@@ -52,7 +52,7 @@ backtunnel-umount ~/remote-rssh
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Roles and Flow
|
||||
## Roles and Flow
|
||||
|
||||
- Sharer: exposes a local SSH service back to a remote host for a limited time. Runs backtunnel-share.
|
||||
- Accessor: connects to the sharer via the remote host’s `127.0.0.1:PORT` and mounts a folder with sshfs. Runs backtunnel-access.
|
||||
@@ -60,7 +60,7 @@ backtunnel-umount ~/remote-rssh
|
||||
|
||||
---
|
||||
|
||||
## ✅ Requirements
|
||||
## Requirements
|
||||
|
||||
- Linux with Bash
|
||||
- OpenSSH client (ssh, sftp)
|
||||
@@ -71,7 +71,7 @@ backtunnel-umount ~/remote-rssh
|
||||
|
||||
---
|
||||
|
||||
## 🔑 Commands
|
||||
## Commands
|
||||
|
||||
### Sharer side
|
||||
|
||||
@@ -165,7 +165,7 @@ backtunnel-umount ~/remote-rssh
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Security Model
|
||||
## Security Model
|
||||
|
||||
- Reverse tunnel bind: remote side binds on `127.0.0.1:PORT` (loopback only).
|
||||
- Access is SFTP-based:
|
||||
@@ -181,7 +181,7 @@ backtunnel-umount ~/remote-rssh
|
||||
|
||||
---
|
||||
|
||||
## 🧩 Profiles
|
||||
## Profiles
|
||||
|
||||
- Config locations (higher precedence first):
|
||||
- `${XDG_CONFIG_HOME:-$HOME/.config}/backtunnel/profiles.ini`
|
||||
@@ -210,7 +210,7 @@ tunnel_port=4422
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Bash Completion
|
||||
## Bash Completion
|
||||
|
||||
- Source completions/backtunnel.bash or install it via your system’s completion.d directory.
|
||||
- Provides:
|
||||
@@ -223,7 +223,7 @@ tunnel_port=4422
|
||||
|
||||
---
|
||||
|
||||
## 🖥️ Desktop Integration (KDE Dolphin)
|
||||
## Desktop Integration (KDE Dolphin)
|
||||
|
||||
- Right-click in a folder:
|
||||
- “Share via BackTunnel…” → opens a GUI/TUI flow for the sharer.
|
||||
@@ -236,7 +236,7 @@ tunnel_port=4422
|
||||
|
||||
---
|
||||
|
||||
## 🌐 Environment Variables
|
||||
## Environment Variables
|
||||
|
||||
- BACKTUNNEL_HOSTKEY_POLICY
|
||||
- Controls StrictHostKeyChecking for ssh/sftp/sshfs:
|
||||
@@ -249,7 +249,7 @@ tunnel_port=4422
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Installation
|
||||
## Installation
|
||||
|
||||
### From source
|
||||
|
||||
@@ -274,7 +274,7 @@ sudo PURGE=1 bash scripts/uninstall.sh
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Troubleshooting
|
||||
## Troubleshooting
|
||||
|
||||
- Port already in use on remote:
|
||||
- backtunnel-share warns if `127.0.0.1:PORT` is busy; choose another with -p.
|
||||
@@ -295,7 +295,7 @@ sudo PURGE=1 bash scripts/uninstall.sh
|
||||
|
||||
---
|
||||
|
||||
## 🧪 Testing
|
||||
## Testing
|
||||
|
||||
- Bats scaffolds are provided to extend:
|
||||
- tests/test-umount.bats
|
||||
@@ -309,7 +309,7 @@ bats tests
|
||||
|
||||
---
|
||||
|
||||
## 📖 Man Page
|
||||
## Man Page
|
||||
|
||||
```bash
|
||||
man backtunnel
|
||||
@@ -317,6 +317,6 @@ man backtunnel
|
||||
|
||||
---
|
||||
|
||||
## 🧾 License
|
||||
## License
|
||||
GNU GPL v3.0
|
||||
© 2025 LUXIM d.o.o., Slovenia – Matjaž Mozetič
|
||||
|
||||
Reference in New Issue
Block a user