Editing SSH Port Forwarding:Configuration

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

== Configuration File Format ==

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

<pre>
DEVICE_NAME:EXTERNAL_PORT:VPN_IP:SSH_PORT
</pre>

=== Example ===

<pre>
synology:22222:10.8.0.2:22
raspberrypi:22223:10.8.0.3:22
server:22224:10.8.0.4:22
</pre>

=== Fields ===

* '''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>)

* '''SSH_PORT''': The SSH port on the target device (default: <code>22</code>)

=== Comments ===

Lines starting with <code>#</code> are treated as comments and ignored.

== Manual Configuration File Editing ==

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

<pre class="lang-bash">
=== Edit config file ===
sudo nano /etc/ssh-port-forwards.conf

== Apply changes ==
sudo ssh-forward apply
</pre>

== Related Documentation ==

* [[Documentation:Overview](Overview|- System architecture

* [Management]])(management.md) - Managing port forwards

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