SSH Port Forwarding:Configuration - Revision history

Josh: Content added - configuration guide: SSH Port Forwarding Configuration (8 sections) (configuration)

2026-01-01T13:44:35Z

Content added - configuration guide: SSH Port Forwarding Configuration (8 sections) (configuration)

← Older revision		Revision as of 13:44, 1 January 2026
Line 1:		Line 1:
	~~= SSH Port Forwarding Configuration =~~

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

Line 38:		Line 36:

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

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

Josh: Minor update - configuration guide: SSH Port Forwarding Configuration (6 sections) (configuration)

2026-01-01T13:28:09Z

Minor update - configuration guide: SSH Port Forwarding Configuration (6 sections) (configuration)

← Older revision		Revision as of 13:28, 1 January 2026
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]]

Josh: Added configuration guide: SSH Port Forwarding Configuration (configuration)

2026-01-01T13:15:51Z

Added configuration guide: SSH Port Forwarding Configuration (configuration)

New page

= 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]]