Skip to content

Commit c6aa4f2

Browse files
authored
Update README.md
1 parent c6a0796 commit c6aa4f2

File tree

1 file changed

+27
-0
lines changed

1 file changed

+27
-0
lines changed

README.md

+27
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,33 @@ bash ssh_tunnel.sh
5353

5454
This command runs the script in the Bash shell environment.
5555

56+
## Example Usage
57+
58+
### Local to Remote Tunnel
59+
60+
1. Select "Local to Remote" tunneling option from the menu.
61+
2. Enter the local port from which the tunnel will originate.
62+
3. Provide the remote user's username and the hostname or IP address of the remote machine.
63+
4. Enter the port on the remote machine to which the tunnel will connect.
64+
5. Upon successful setup, the script will display a success message confirming the creation of the tunnel.
65+
* try to choose same ports for both local and remote servers(your remote server must accept ssh over the choosen port)
66+
67+
### Remote to Local Tunnel
68+
69+
To create a remote-to-local tunnel, follow similar steps as above, but select the "Remote to Local" tunneling option from the menu.
70+
71+
### Both Sides Tunnel
72+
73+
For both sides of the tunnel, select the corresponding option from the menu and provide the required information for both the local-to-remote and remote-to-local connections.
74+
75+
### Killing Existing Tunnels
76+
77+
To terminate existing tunnels, select the "Kill tunnel" option from the menu and enter the local port associated with the tunnel you wish to terminate.
78+
79+
### Exiting the Script
80+
81+
To exit the script, select the "Exit" option from the menu.
82+
5683
## Contributing
5784
5885
Contributions, bug reports, and suggestions for improvements are welcome! Feel free to open an issue or create a pull request.

0 commit comments

Comments
 (0)