Services:Step By Step - Revision history

Josh: Updated documentation from markdown files

2026-05-16T14:04:34Z

Updated documentation from markdown files

Josh: Major update - troubleshooting guide: Step-by-Step Process for Adding Services (18 sections)

2026-01-01T13:44:43Z

Major update - troubleshooting guide: Step-by-Step Process for Adding Services (18 sections)

← Older revision		Revision as of 13:44, 1 January 2026
Line 1:		Line 1:
	~~= Step-by-Step Process for Adding Services =~~

	Follow these steps to add a new service to the reverse proxy system.		Follow these steps to add a new service to the reverse proxy system.

Line 18:		Line 16:

	location / {		location / {
	# Reverse Proxy to Synology's internal VPN IP and service port		=== Reverse Proxy to Synology's internal VPN IP and service port ===
	proxy_pass http://10.8.0.2:PORT_NUMBER;		proxy_pass http://10.8.0.2:PORT_NUMBER;
	proxy_set_header Host $host;		proxy_set_header Host $host;
Line 24:		Line 22:
	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
	proxy_set_header X-Forwarded-Proto $scheme;		proxy_set_header X-Forwarded-Proto $scheme;
	# Necessary for Synology Reverse Proxy compatibility		=== Necessary for Synology Reverse Proxy compatibility ===
	proxy_set_header Upgrade $http_upgrade;		proxy_set_header Upgrade $http_upgrade;
	proxy_set_header Connection "upgrade";		proxy_set_header Connection "upgrade";
	# Timeouts for long-running requests		=== Timeouts for long-running requests ===
	proxy_read_timeout 300s;		proxy_read_timeout 300s;
	proxy_connect_timeout 75s;		proxy_connect_timeout 75s;
Line 157:		Line 155:
	To remove a service:		To remove a service:

	= '''Disable the site''': =		=== '''Disable the site''': ===
	<pre class="lang-bash">		<pre class="lang-bash">
	sudo rm /etc/nginx/sites-enabled/service.jb-vpn.uk		sudo rm /etc/nginx/sites-enabled/service.jb-vpn.uk
	</pre>		</pre>

	= '''Test configuration''': =		== '''Test configuration''': ==
	<pre class="lang-bash">		<pre class="lang-bash">
	sudo nginx -t		sudo nginx -t
	</pre>		</pre>

	= '''Reload nginx''': =		== '''Reload nginx''': ==
	<pre class="lang-bash">		<pre class="lang-bash">
	sudo systemctl reload nginx		sudo systemctl reload nginx
	</pre>		</pre>

	= '''Optional - Remove configuration file''': =		== '''Optional - Remove configuration file''': ==
	<pre class="lang-bash">		<pre class="lang-bash">
	sudo rm /etc/nginx/sites-available/service.jb-vpn.uk		sudo rm /etc/nginx/sites-available/service.jb-vpn.uk
	</pre>		</pre>

	= '''Optional - Revoke SSL certificate''': =		== '''Optional - Revoke SSL certificate''': ==
	<pre class="lang-bash">		<pre class="lang-bash">
	sudo certbot revoke --cert-path /etc/letsencrypt/live/service.jb-vpn.uk/cert.pem		sudo certbot revoke --cert-path /etc/letsencrypt/live/service.jb-vpn.uk/cert.pem

Josh: Content added - troubleshooting guide: Step-by-Step Process for Adding Services (10 sections)

2026-01-01T13:28:20Z

Content added - troubleshooting guide: Step-by-Step Process for Adding Services (10 sections)

← Older revision		Revision as of 13:28, 1 January 2026
Line 38:		Line 38:

	'''Replace''':		'''Replace''':
	'' <code>newservice.jb-vpn.uk</code> with your subdomain		* <code>newservice.jb-vpn.uk</code> with your subdomain
	'' <code>PORT_NUMBER</code> with your service's port
			* <code>PORT_NUMBER</code> with your service's port

	'''For HTTPS Internal Services''':		'''For HTTPS Internal Services''':
Line 75:		Line 76:

	'''If there are errors''': Fix them before proceeding. Common issues:		'''If there are errors''': Fix them before proceeding. Common issues:
	'' Syntax errors (missing semicolons, brackets)		* Syntax errors (missing semicolons, brackets)
	'' Duplicate server names
	'' Invalid port numbers		* Duplicate server names

			* Invalid port numbers

	== Step 4: Reload Nginx ==		== Step 4: Reload Nginx ==
Line 96:		Line 99:

	You should receive an HTTP response. If you get a connection error:		You should receive an HTTP response. If you get a connection error:
	'' Check DNS: <code>nslookup newservice.jb-vpn.uk</code>		* Check DNS: <code>nslookup newservice.jb-vpn.uk</code>
	'' Verify service is running: <code>curl http://10.8.0.2:PORT_NUMBER</code>
	'' Check nginx logs: <code>tail -f /var/log/nginx/error.log</code>		* Verify service is running: <code>curl http://10.8.0.2:PORT_NUMBER</code>

			* Check nginx logs: <code>tail -f /var/log/nginx/error.log</code>

	== Step 6: Set Up SSL Certificate ==		== Step 6: Set Up SSL Certificate ==
Line 109:		Line 114:

	'''What this does''':		'''What this does''':
	'' Requests SSL certificate from Let's Encrypt		* Requests SSL certificate from Let's Encrypt
	'' Configures nginx for HTTPS
	'' Sets up HTTP to HTTPS redirect		* Configures nginx for HTTPS
	'' Configures automatic renewal
			* Sets up HTTP to HTTPS redirect

			* Configures automatic renewal

	'''If Certbot fails''':		'''If Certbot fails''':
	'' Verify DNS is pointing to VPS: <code>nslookup newservice.jb-vpn.uk</code>		* Verify DNS is pointing to VPS: <code>nslookup newservice.jb-vpn.uk</code>
	'' Ensure port 80 is open and accessible
	'' Check firewall rules: <code>sudo iptables -L -n -v</code>		* Ensure port 80 is open and accessible

			* Check firewall rules: <code>sudo iptables -L -n -v</code>

	== Step 7: Verify HTTPS Access ==		== Step 7: Verify HTTPS Access ==
Line 137:		Line 147:

	Verify:		Verify:
	'' SSL certificate is valid (green lock icon)		* SSL certificate is valid (green lock icon)
	'' Service loads correctly
	'' All functionality works as expected		* Service loads correctly

			* All functionality works as expected

	== Removing a Service ==		== Removing a Service ==
Line 173:		Line 185:
	== Related Documentation ==		== Related Documentation ==

	'' [[Documentation:Prerequisites](Prerequisites\|- Requirements before starting		* [[Documentation:Prerequisites](Prerequisites\|- Requirements before starting
	'' [Configuration Options]])(configuration-options.md) - Advanced configuration
	'' [Service Examples](service-examples.md) - Service-specific examples		* [Configuration Options]])(configuration-options.md) - Advanced configuration
	'' [[Documentation:Index\|Troubleshooting]] - Common issues
			* [Service Examples](service-examples.md) - Service-specific examples

			* [[Documentation:Index\|Troubleshooting]] - Common issues

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

Josh: Added troubleshooting guide: Step-by-Step Process for Adding Services

2026-01-01T13:16:06Z

Added troubleshooting guide: Step-by-Step Process for Adding Services

New page

= Step-by-Step Process for Adding Services =

Follow these steps to add a new service to the reverse proxy system.

== Step 1: Create Nginx Configuration File ==

Create a new configuration file in <code>/etc/nginx/sites-available/</code>:

<pre class="lang-bash">
sudo nano /etc/nginx/sites-available/newservice.jb-vpn.uk
</pre>

'''Basic HTTP Configuration Template''':

<pre class="lang-nginx">
server {
server_name newservice.jb-vpn.uk;

location / {
# Reverse Proxy to Synology's internal VPN IP and service port
proxy_pass http://10.8.0.2:PORT_NUMBER;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
# Necessary for Synology Reverse Proxy compatibility
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
# Timeouts for long-running requests
proxy_read_timeout 300s;
proxy_connect_timeout 75s;
}

listen 80;

}
</pre>

'''Replace''':
'' <code>newservice.jb-vpn.uk</code> with your subdomain
'' <code>PORT_NUMBER</code> with your service's port

'''For HTTPS Internal Services''':

If your internal service uses HTTPS, change the proxy_pass line:
<pre class="lang-nginx">
proxy_pass https://10.8.0.2:PORT_NUMBER;
</pre>

'''For Services Requiring Special Headers''':

Some services (like Plex) require additional headers. See [Service Examples](service-examples.md) for reference.

== Step 2: Enable the Site ==

Create a symlink to enable the site:

<pre class="lang-bash">
sudo ln -s /etc/nginx/sites-available/newservice.jb-vpn.uk /etc/nginx/sites-enabled/newservice.jb-vpn.uk
</pre>

== Step 3: Test Nginx Configuration ==

Always test the configuration before reloading:

<pre class="lang-bash">
sudo nginx -t
</pre>

'''Expected Output''':
<pre>
nginx: the configuration file /etc/nginx/nginx.conf syntax is ok
nginx: configuration file /etc/nginx/nginx.conf test is successful
</pre>

'''If there are errors''': Fix them before proceeding. Common issues:
'' Syntax errors (missing semicolons, brackets)
'' Duplicate server names
'' Invalid port numbers

== Step 4: Reload Nginx ==

Reload nginx to apply the new configuration (graceful reload, no downtime):

<pre class="lang-bash">
sudo systemctl reload nginx
</pre>

== Step 5: Verify HTTP Access ==

Test that the service is accessible via HTTP:

<pre class="lang-bash">
curl -I http://newservice.jb-vpn.uk
</pre>

You should receive an HTTP response. If you get a connection error:
'' Check DNS: <code>nslookup newservice.jb-vpn.uk</code>
'' Verify service is running: <code>curl http://10.8.0.2:PORT_NUMBER</code>
'' Check nginx logs: <code>tail -f /var/log/nginx/error.log</code>

== Step 6: Set Up SSL Certificate ==

Use Certbot to automatically configure SSL:

<pre class="lang-bash">
sudo certbot --nginx -d newservice.jb-vpn.uk --non-interactive --agree-tos --redirect --email admin@jb-vpn.uk
</pre>

'''What this does''':
'' Requests SSL certificate from Let's Encrypt
'' Configures nginx for HTTPS
'' Sets up HTTP to HTTPS redirect
'' Configures automatic renewal

'''If Certbot fails''':
'' Verify DNS is pointing to VPS: <code>nslookup newservice.jb-vpn.uk</code>
'' Ensure port 80 is open and accessible
'' Check firewall rules: <code>sudo iptables -L -n -v</code>

== Step 7: Verify HTTPS Access ==

Test that HTTPS is working:

<pre class="lang-bash">
curl -I https://newservice.jb-vpn.uk
</pre>

You should receive a 200 OK or similar response with SSL certificate details.

== Step 8: Test in Browser ==

Open your browser and navigate to:
<pre>
https://newservice.jb-vpn.uk
</pre>

Verify:
'' SSL certificate is valid (green lock icon)
'' Service loads correctly
'' All functionality works as expected

== Removing a Service ==

To remove a service:

= '''Disable the site''': =
<pre class="lang-bash">
sudo rm /etc/nginx/sites-enabled/service.jb-vpn.uk
</pre>

= '''Test configuration''': =
<pre class="lang-bash">
sudo nginx -t
</pre>

= '''Reload nginx''': =
<pre class="lang-bash">
sudo systemctl reload nginx
</pre>

= '''Optional - Remove configuration file''': =
<pre class="lang-bash">
sudo rm /etc/nginx/sites-available/service.jb-vpn.uk
</pre>

= '''Optional - Revoke SSL certificate''': =
<pre class="lang-bash">
sudo certbot revoke --cert-path /etc/letsencrypt/live/service.jb-vpn.uk/cert.pem
sudo certbot delete --cert-name service.jb-vpn.uk
</pre>

== Related Documentation ==

'' [[Documentation:Prerequisites](Prerequisites|- Requirements before starting
'' [Configuration Options]])(configuration-options.md) - Advanced configuration
'' [Service Examples](service-examples.md) - Service-specific examples
'' [[Documentation:Index|Troubleshooting]] - Common issues

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