PMISuite/BackTunnel
5
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add invite and QR code features to backtunnel-share

Browse Source
This commit is contained in:
Matjaž Mozetič
2025-09-14 12:54:06 +02:00
parent d510d777ca
commit 07dbd79aa2
3 changed files with 134 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
man/backtunnel.1
View File

@@ -1,4 +1,4 @@
.TH backtunnel 1 "September 2025" "1.1" "BackTunnel – Reverse SSH Sharing Toolkit"
.TH backtunnel 1 "September 2025" "1.2" "BackTunnel – Reverse SSH Sharing Toolkit"
.SH NAME
backtunnel-share, backtunnel-access \- Secure reverse SSH folder sharing and access
@@ -15,6 +15,9 @@ backtunnel-share, backtunnel-access \- Secure reverse SSH folder sharing and acc
The tunnel exposes the local sshd (typically port 22) on a loopback port on the remote host using \fBssh -R\fR.
The sharing ends automatically after the given \fIduration\fR via \fBtimeout\fR.
With the \fB--invite\fR option, \fBbacktunnel-share\fR prints a ready-to-copy access command for the remote user,
which can be pasted directly into a chat or terminal. The invite can also be rendered as a QR code or written to a file.
\fBbacktunnel-access\fR mounts the shared folder from the remote side using \fBsshfs\fR by connecting to \fBlocalhost:<port>\fR on the remote host (the port exposed by \fBbacktunnel-share\fR).
.SH OPTIONS
@@ -27,6 +30,22 @@ Remote port to bind with \fB-R\fR (default: 2222).
.B -l, --local-ssh-port <PORT>
Local sshd port to forward to (default: 22).
.TP
.B -i, --invite
Print a ready-to-copy invite command for the remote user.
.TP
.B --invite-mount <PATH>
Mount point suggested in the invite (default: /mnt/remote-rssh).
.TP
.B --invite-file <FILE>
Also write the invite text (including unmount hint) to the given file.
.TP
.B --qr
Render the invite as a terminal QR code (requires \fBqrencode\fR).
.SS backtunnel-access options
.TP
.B -p, --port <PORT>
@@ -60,6 +79,16 @@ Share for 1 day, using custom ports:
.B backtunnel-share
/home/user/docs with alice:vps.example.com for 1d -p 4422 -l 2222
.TP
Share with invite printed:
.B backtunnel-share
/home/user/docs with alice@vps.example.com for 2h -i
.TP
Share with QR invite:
.B backtunnel-share
/home/user/docs with alice@vps.example.com for 2h -i --qr
.TP
Mount with default port and mount point:
.B backtunnel-access
@@ -74,8 +103,11 @@ Mount with custom port and mount point:
By default, \fBssh -R\fR binds to 127.0.0.1 on the remote side, limiting access to local users on the remote machine.
The client connects to \fBlocalhost:<port>\fR from the remote host.
The invite feature is intended for convenience: copy-paste the printed command into chat for the remote user.
Unmount with \fBfusermount -u <mountpoint>\fR after use.
.SH SEE ALSO
ssh(1), sshfs(1), timeout(1), autossh(1), fusermount(1)
ssh(1), sshfs(1), timeout(1), autossh(1), qrencode(1), fusermount(1)
.SH AUTHOR
Matjaž Mozetič