Services:Prerequisites - Revision history

Josh: Updated documentation from markdown files

2026-05-16T14:04:34Z

Updated documentation from markdown files

← Older revision		Revision as of 14:04, 16 May 2026
Line 1:		Line 1:
	Before adding a new ~~service to the reverse proxy system~~, ~~ensure you have~~ the following:		Before adding a new public hostname, gather the following.

	== Service ~~Information~~ ==		== Service information ==

	~~===~~ '''~~Subdomain name~~''' (e.g., <code>newservice.jb-vpn.uk</code>) ~~===~~		* '''Hostname''' (e.g. <code>newservice.jb-vpn.uk</code>)
	~~== '''Internal IP address''' (usually <code>10.8.0.2</code> for Synology NAS) ==~~
	~~== '''Internal port number''' (e.g., <code>8080</code>, <code>3000</code>, etc.) ==~~
	~~== '''Protocol''' (HTTP or HTTPS) ==~~

	~~== DNS Configuration ==~~		* '''Backend location''': VPS (<code>127.0.0.1:PORT</code>) or NAS via VPN (<code>10.8.0.2:PORT</code>)

	~~===~~ '''~~DNS A record created~~''' ~~pointing subdomain to VPS IP (<code>87.106.61.62</code>) ===~~		* '''Protocol''': HTTP or HTTPS on the backend
	~~== '''DNS propagation completed''' (can take up to 48 hours, usually much faster) ==~~

	==~~= Verify~~ DNS ~~Configuration =~~==		== DNS ==

			* '''A record''' pointing the hostname to <code>87.106.61.62</code>

			* Propagation complete (verify with <code>dig</code> or <code>nslookup</code>)

	<pre class="lang-bash">		<pre class="lang-bash">
	~~==== Check DNS resolution ====~~
	~~nslookup newservice.jb-vpn.uk~~

	~~== Or using dig ==~~
	dig newservice.jb-vpn.uk +short		dig newservice.jb-vpn.uk +short
	</pre>		</pre>

	== ~~Service Verification~~ ==		== Backend health ==

			'''VPS service:'''

	~~Before configuring the reverse proxy, verify~~:		<pre class="lang-bash">
			curl -sI http://127.0.0.1:PORT \| head -1
			</pre>

	~~===~~ '''~~Service is running''' on Synology~~ NAS ~~===~~		'''NAS service''' (requires active VPN):
	== '''~~Service is accessible''' from~~ VPN ~~network ==~~
	~~== '''Test from VPS''': <code>curl http://10.8.0.2~~:~~[PORT]</code> ### Test Service Accessibility ==~~

	<pre class="lang-bash">		<pre class="lang-bash">
	~~== Test service from VPS ==~~		ping -c 2 10.8.0.2
	curl http://10.8.0.2:~~8080~~		curl -sI -m 5 http://10.8.0.2:PORT \| head -1
			</pre>

	=~~= Check if service is listening (from Synology NAS or via SSH) ==~~		'''Wiki example:'''
	~~netstat~~ -~~tlnp~~ \| ~~grep PORT_NUMBER~~
			<pre class="lang-bash">
			curl -sI http://127.0.0.1:8010 \| head -1
			curl -sI https://wiki.jb-vpn.uk \| head -1
	</pre>		</pre>

	== System ~~Requirements~~ ==		== System requirements ==

	~~Ensure~~ the ~~following are in place:~~		* '''Caddy''' running on the VPS (<code>systemctl status caddy</code>)

	~~===~~ '''~~OpenVPN tunnel is active'~~'' ~~(tun0 interface up) ===~~		* '''Ports 80/443''' reachable from the internet (for Let's Encrypt)
	== '~~''Synology NAS is connected''' to VPN (10.8.0.2~~ reachable~~) ==~~
	~~== '''Nginx is running''' on~~ the ~~VPS ==~~
	~~== '''Port 80 is accessible'''~~ (~~required~~ for ~~SSL certificate validation~~) ==

	~~=== Verify System Status ===~~		* '''OpenVPN''' up (<code>ip addr show tun0</code>) when the backend is on <code>10.8.0.2</code>

	<pre class="lang-bash">		<pre class="lang-bash">
	~~==== Check VPN connectivity ====~~		systemctl status caddy
	~~ping 10.8.0.2~~

	~~== Check nginx status ==~~
	systemctl status ~~nginx~~

	~~== Check VPN interface ==~~
	ip addr show tun0		ip addr show tun0
			ping -c 2 10.8.0.2
	</pre>		</pre>

	== Related ~~Documentation~~ ==		== Related documentation ==

			* [Step By Step Step-by-Step Process]

	* [~~Step-by-Step Process~~]~~(step-by-step.md) - Next steps after prerequisites~~		* [[System:Network Architecture]]

	* [System Overview](index.md) - System architecture

	[[Category:Documentation]]		[[Category:Documentation]]
	[[Category:Documentation/Services]]		[[Category:Documentation/Services]]
	[[Category:Documentation/Services/Adding Services]]		[[Category:Documentation/Services/Adding Services]]

Josh: Major update - troubleshooting guide: Prerequisites for Adding Services (27 sections)

2026-01-01T13:44:42Z

Major update - troubleshooting guide: Prerequisites for Adding Services (27 sections)

← Older revision		Revision as of 13:44, 1 January 2026
Line 1:		Line 1:
	~~= Prerequisites for Adding Services =~~

	Before adding a new service to the reverse proxy system, ensure you have the following:		Before adding a new service to the reverse proxy system, ensure you have the following:

	== Service Information ==		== Service Information ==

	= '''Subdomain name''' (e.g., <code>newservice.jb-vpn.uk</code>) =		=== '''Subdomain name''' (e.g., <code>newservice.jb-vpn.uk</code>) ===
	= '''Internal IP address''' (usually <code>10.8.0.2</code> for Synology NAS) =		== '''Internal IP address''' (usually <code>10.8.0.2</code> for Synology NAS) ==
	= '''Internal port number''' (e.g., <code>8080</code>, <code>3000</code>, etc.) =		== '''Internal port number''' (e.g., <code>8080</code>, <code>3000</code>, etc.) ==
	= '''Protocol''' (HTTP or HTTPS) =		== '''Protocol''' (HTTP or HTTPS) ==

	== DNS Configuration ==		== DNS Configuration ==

	= '''DNS A record created''' pointing subdomain to VPS IP (<code>87.106.61.62</code>) =		=== '''DNS A record created''' pointing subdomain to VPS IP (<code>87.106.61.62</code>) ===
	= '''DNS propagation completed''' (can take up to 48 hours, usually much faster) =		== '''DNS propagation completed''' (can take up to 48 hours, usually much faster) ==

	=== Verify DNS Configuration ===		=== Verify DNS Configuration ===

	<pre class="lang-bash">		<pre class="lang-bash">
	= Check DNS resolution =		==== Check DNS resolution ====
	nslookup newservice.jb-vpn.uk		nslookup newservice.jb-vpn.uk

	= Or using dig =		== Or using dig ==
	dig newservice.jb-vpn.uk +short		dig newservice.jb-vpn.uk +short
	</pre>		</pre>
Line 29:		Line 27:
	Before configuring the reverse proxy, verify:		Before configuring the reverse proxy, verify:

	= '''Service is running''' on Synology NAS =		=== '''Service is running''' on Synology NAS ===
	= '''Service is accessible''' from VPN network =		== '''Service is accessible''' from VPN network ==
	= '''Test from VPS''': <code>curl http://10.8.0.2:[PORT]</code> ### Test Service Accessibility =		== '''Test from VPS''': <code>curl http://10.8.0.2:[PORT]</code> ### Test Service Accessibility ==

	<pre class="lang-bash">		<pre class="lang-bash">
	= Test service from VPS =		== Test service from VPS ==
	curl http://10.8.0.2:8080		curl http://10.8.0.2:8080

	= Check if service is listening (from Synology NAS or via SSH) =		== Check if service is listening (from Synology NAS or via SSH) ==
	netstat -tlnp \| grep PORT_NUMBER		netstat -tlnp \| grep PORT_NUMBER
	</pre>		</pre>
Line 45:		Line 43:
	Ensure the following are in place:		Ensure the following are in place:

	= '''OpenVPN tunnel is active''' (tun0 interface up) =		=== '''OpenVPN tunnel is active''' (tun0 interface up) ===
	= '''Synology NAS is connected''' to VPN (10.8.0.2 reachable) =		== '''Synology NAS is connected''' to VPN (10.8.0.2 reachable) ==
	= '''Nginx is running''' on the VPS =		== '''Nginx is running''' on the VPS ==
	= '''Port 80 is accessible''' (required for SSL certificate validation) =		== '''Port 80 is accessible''' (required for SSL certificate validation) ==

	=== Verify System Status ===		=== Verify System Status ===

	<pre class="lang-bash">		<pre class="lang-bash">
	= Check VPN connectivity =		==== Check VPN connectivity ====
	ping 10.8.0.2		ping 10.8.0.2

	= Check nginx status =		== Check nginx status ==
	systemctl status nginx		systemctl status nginx

	= Check VPN interface =		== Check VPN interface ==
	ip addr show tun0		ip addr show tun0
	</pre>		</pre>

Josh: Minor update - troubleshooting guide: Prerequisites for Adding Services (7 sections)

2026-01-01T13:28:18Z

Minor update - troubleshooting guide: Prerequisites for Adding Services (7 sections)

← Older revision		Revision as of 13:28, 1 January 2026
Line 65:		Line 65:
	== Related Documentation ==		== Related Documentation ==

	'' [Step-by-Step Process](step-by-step.md) - Next steps after prerequisites		* [Step-by-Step Process](step-by-step.md) - Next steps after prerequisites
	'' [System Overview](index.md) - System architecture
			* [System Overview](index.md) - System architecture

	[[Category:Documentation]]		[[Category:Documentation]]
	[[Category:Documentation/Services]]		[[Category:Documentation/Services]]
	[[Category:Documentation/Services/Adding Services]]		[[Category:Documentation/Services/Adding Services]]

Josh: Added troubleshooting guide: Prerequisites for Adding Services

2026-01-01T13:16:04Z

Added troubleshooting guide: Prerequisites for Adding Services

New page

= Prerequisites for Adding Services =

Before adding a new service to the reverse proxy system, ensure you have the following:

== Service Information ==

= '''Subdomain name''' (e.g., <code>newservice.jb-vpn.uk</code>) =
= '''Internal IP address''' (usually <code>10.8.0.2</code> for Synology NAS) =
= '''Internal port number''' (e.g., <code>8080</code>, <code>3000</code>, etc.) =
= '''Protocol''' (HTTP or HTTPS) =

== DNS Configuration ==

= '''DNS A record created''' pointing subdomain to VPS IP (<code>87.106.61.62</code>) =
= '''DNS propagation completed''' (can take up to 48 hours, usually much faster) =

=== Verify DNS Configuration ===

<pre class="lang-bash">
= Check DNS resolution =
nslookup newservice.jb-vpn.uk

= Or using dig =
dig newservice.jb-vpn.uk +short
</pre>

== Service Verification ==

Before configuring the reverse proxy, verify:

= '''Service is running''' on Synology NAS =
= '''Service is accessible''' from VPN network =
= '''Test from VPS''': <code>curl http://10.8.0.2:[PORT]</code> ### Test Service Accessibility =

<pre class="lang-bash">
= Test service from VPS =
curl http://10.8.0.2:8080

= Check if service is listening (from Synology NAS or via SSH) =
netstat -tlnp | grep PORT_NUMBER
</pre>

== System Requirements ==

Ensure the following are in place:

= '''OpenVPN tunnel is active''' (tun0 interface up) =
= '''Synology NAS is connected''' to VPN (10.8.0.2 reachable) =
= '''Nginx is running''' on the VPS =
= '''Port 80 is accessible''' (required for SSL certificate validation) =

=== Verify System Status ===

<pre class="lang-bash">
= Check VPN connectivity =
ping 10.8.0.2

= Check nginx status =
systemctl status nginx

= Check VPN interface =
ip addr show tun0
</pre>

== Related Documentation ==

'' [Step-by-Step Process](step-by-step.md) - Next steps after prerequisites
'' [System Overview](index.md) - System architecture

[[Category:Documentation]]
[[Category:Documentation/Services]]
[[Category:Documentation/Services/Adding Services]]