Jump to content

SSH Port Forwarding:Configuration: Difference between revisions

From jb-vpn.uk Wiki
Added configuration guide: SSH Port Forwarding Configuration (configuration)
 
Minor update - configuration guide: SSH Port Forwarding Configuration (6 sections) (configuration)
Line 21: Line 21:
=== Fields ===
=== Fields ===


'' '''DEVICE_NAME''': A descriptive name for the device (e.g., <code>synology</code>, <code>raspberrypi</code>)
* '''DEVICE_NAME''': A descriptive name for the device (e.g., <code>synology</code>, <code>raspberrypi</code>)
'' '''EXTERNAL_PORT''': The port on the VPS that will receive SSH connections (e.g., <code>22222</code>)
 
'' '''VPN_IP''': The IP address of the device on the VPN network (e.g., <code>10.8.0.2</code>)
* '''EXTERNAL_PORT''': The port on the VPS that will receive SSH connections (e.g., <code>22222</code>)
'' '''SSH_PORT''': The SSH port on the target device (default: <code>22</code>)
 
* '''VPN_IP''': The IP address of the device on the VPN network (e.g., <code>10.8.0.2</code>)
 
* '''SSH_PORT''': The SSH port on the target device (default: <code>22</code>)


=== Comments ===
=== Comments ===
Line 44: Line 47:
== Related Documentation ==
== Related Documentation ==


'' [[Documentation:Overview](Overview|- System architecture
* [[Documentation:Overview](Overview|- System architecture
'' [Management]])(management.md) - Managing port forwards
 
* [Management]])(management.md) - Managing port forwards


[[Category:Documentation]]
[[Category:Documentation]]
[[Category:Documentation/SSH Port Forwarding]]
[[Category:Documentation/SSH Port Forwarding]]

Revision as of 13:28, 1 January 2026

SSH Port Forwarding Configuration

This document describes the configuration file format for SSH port forwarding.

Configuration File Format

The configuration file /etc/ssh-port-forwards.conf uses a simple format:

DEVICE_NAME:EXTERNAL_PORT:VPN_IP:SSH_PORT

Example

synology:22222:10.8.0.2:22
raspberrypi:22223:10.8.0.3:22
server:22224:10.8.0.4:22

Fields

  • DEVICE_NAME: A descriptive name for the device (e.g., synology, raspberrypi)
  • EXTERNAL_PORT: The port on the VPS that will receive SSH connections (e.g., 22222)
  • VPN_IP: The IP address of the device on the VPN network (e.g., 10.8.0.2)
  • SSH_PORT: The SSH port on the target device (default: 22)

Comments

Lines starting with # are treated as comments and ignored.

Manual Configuration File Editing

You can manually edit /etc/ssh-port-forwards.conf and then apply:

= Edit config file =
sudo nano /etc/ssh-port-forwards.conf

= Apply changes =
sudo ssh-forward apply
  • [[Documentation:Overview](Overview|- System architecture
  • [Management]])(management.md) - Managing port forwards