Skip to content

Commit 817b18b

Browse files
committed
Improve config instructions
1 parent d896d93 commit 817b18b

File tree

2 files changed

+22
-8
lines changed

2 files changed

+22
-8
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.snap

snap/snapcraft.yaml

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,26 +6,39 @@ version: git
66
summary: Client to start an SSH tunnel
77
description: |
88
This snap starts an SSH tunnel by running the ssh command as a service.
9+
10+
The service is disabled by default.
11+
Configure and then start the client as described below:
912
1013
Copy your SSH key(s) to the root user, e.g.:
1114
`sudo cp .ssh/id_ed25519* /root/.ssh/`
1215
13-
Connect ssh-keys interface to access keys and ssh command:
16+
Connect the ssh-keys interface to access keys and the ssh command:
1417
`sudo snap connect ssh-tunnel-client:ssh-keys :ssh-keys`
1518
16-
Set destination:
19+
Set the destination:
1720
`sudo snap set ssh-tunnel-client destination="user@example.com"`
1821
19-
Set destination ssh server port:
22+
Set the destination ssh server port:
2023
`sudo snap set ssh-tunnel-client port="8022"`
2124
22-
Set args:
23-
`snap set ssh-tunnel-client args="-R :9901:localhost:22"`
25+
Pass arguments to the client:
26+
`sudo snap set ssh-tunnel-client args="-R 9901:localhost:22"`
27+
The above example is for TCP remote forwarding; listening on port 9901 on the
28+
remote server, to tunnel traffic to the client on port 22, on the localhost.
29+
For more details, refer to the OpenSSH client manual:
30+
https://man7.org/linux/man-pages/man1/ssh.1.html
2431
25-
Start and enable:
26-
`sudo snap start --enable ssh-tunnel-client `
32+
Start and enable the service:
33+
`sudo snap start --enable ssh-tunnel-client`
2734
28-
grade: devel
35+
Check the logs:
36+
`sudo snap logs -f ssh-tunnel-client`
37+
38+
Found issues or need help? Go to:
39+
https://github.com/TinyIoT/ssh-tunnel/issues
40+
41+
grade: stable
2942
confinement: strict
3043

3144
architectures:

0 commit comments

Comments
 (0)