Support for chaning the HTTP and HTTPS port that hosts will listen on

I have seen a few issues that mention that changing the port that nginx
listens on is important (especially when using hostNetwork).

I am not totally convinced that NPM should allow these use-cases but I
was bored enough to implement it anyway.

Related Issue: #4122

backend/internal/nginx.js

@@ -5,6 +5,20 @@ const config = require('../lib/config');
 const utils  = require('../lib/utils');
 const error  = require('../lib/error');
 
+/**
+ * 
+ * @param {int} user_port 
+ * @param {int} default_port
+ * @returns {int} port
+ */
+const validatePort = (user_port, default_port) => {
+	if (user_port === NaN || user_port < 1 || user_port > 65535) {
+		console.error(`Environment variable HTTP_PORT must be an integer between 1 and 65535 (got: ${user_port}). Using default port ${default_port}`);
+		return default_port;
+	}
+	return user_port;
+}
+
 const internalNginx = {
 
 	/**
@@ -234,6 +248,8 @@ const internalNginx = {
 
 			// Set the IPv6 setting for the host
 			host.ipv6 = internalNginx.ipv6Enabled();
+			host.http_port = internalNginx.httpPort();
+			host.https_port = internalNginx.httpsPort();
 
 			locationsPromise.then(() => {
 				renderEngine
@@ -288,6 +304,8 @@ const internalNginx = {
 			}
 
 			certificate.ipv6 = internalNginx.ipv6Enabled();
+			certificate.http_port = internalNginx.httpPort();
+			certificate.https_port = internalNginx.httpsPort();
 
 			renderEngine
 				.parseAndRender(template, certificate)
@@ -432,7 +450,30 @@ const internalNginx = {
 		}
 
 		return true;
+	},
+
+	/**
+	 * @returns {integer}
+	 */
+	httpPort: function () {
+		if (typeof process.env.HTTP_PORT !== 'undefined') {
+			let httpPort = parseInt(process.env.HTTP_PORT);
+			return validatePort(httpPort, 443);
+		}
+		return 80;
+	},
+
+	/**
+	 * @returns {integer}
+	 */
+	httpsPort: function () {
+		if (typeof process.env.HTTPS_PORT !== 'undefined') {
+			let httpPort = parseInt(process.env.HTTPS_PORT);
+			return validatePort(httpPort, 443);
+		}
+		return 80;
 	}
+
 };
 
 module.exports = internalNginx;

backend/templates/_listen.conf

@@ -1,15 +1,15 @@
-  listen 80;
+  listen {{ http_port }};
 {% if ipv6 -%}
-  listen [::]:80;
+  listen [::]:{{ http_port }};
 {% else -%}
-  #listen [::]:80;
+  #listen [::]:{{ http_port }};
 {% endif %}
 {% if certificate -%}
-  listen 443 ssl;
+  listen {{ https_port }} ssl;
 {% if ipv6 -%}
-  listen [::]:443 ssl;
+  listen [::]:{{ https_port }} ssl;
 {% else -%}
-  #listen [::]:443;
+  #listen [::]:{{ https_port }};
 {% endif %}
 {% endif %}
   server_name {{ domain_names | join: " " }};

docker/docker-compose.dev.yml

@@ -33,6 +33,8 @@ services:
       DB_MYSQL_NAME: 'npm'
       # DB_SQLITE_FILE: "/data/database.sqlite"
       # DISABLE_IPV6: "true"
+      # HTTP_PORT: "1234"
+      # HTTPS_PORT: "5678"
       # Required for DNS Certificate provisioning testing:
       LE_SERVER: 'https://ca.internal/acme/acme/directory'
       REQUESTS_CA_BUNDLE: '/etc/ssl/certs/NginxProxyManager.crt'

docker/rootfs/etc/s6-overlay/s6-rc.d/prepare/00-all.sh

@@ -18,5 +18,6 @@ fi
 . /etc/s6-overlay/s6-rc.d/prepare/30-ownership.sh
 . /etc/s6-overlay/s6-rc.d/prepare/40-dynamic.sh
 . /etc/s6-overlay/s6-rc.d/prepare/50-ipv6.sh
+. /etc/s6-overlay/s6-rc.d/prepare/55-http-https-port.sh
 . /etc/s6-overlay/s6-rc.d/prepare/60-secrets.sh
 . /etc/s6-overlay/s6-rc.d/prepare/90-banner.sh

docker/rootfs/etc/s6-overlay/s6-rc.d/prepare/55-http-https-port.sh

@@ -0,0 +1,59 @@
+#!/command/with-contenv bash
+# shellcheck shell=bash
+
+# This command reads the `HTTP_PORT` and `HTTPS_PORT` env vars and will rerender
+# the nginx files to the port defined in these variables
+
+set -e
+
+log_info 'HTTP_PORT ...'
+
+DEFAULT_HTTP_PORT="80"
+DEFAULT_HTTPS_PORT="443"
+
+# Make sure HTTP_PORT and HTTPS_PORT are set correctly
+case "$HTTP_PORT" in
+	''|*[!0-9]*)
+		echo "Could not parse HTTP_PORT as integer (got \"$HTTP_PORT\")."
+		echo "Using default http port \"$DEFAULT_HTTP_PORT\""
+		HTTP_PORT="$DEFAULT_HTTP_PORT"
+		;;
+	*) true ;;
+esac
+if [ "$HTTP_PORT" -lt "1" ] || [ "$HTTP_PORT" -gt "65535" ]; then
+	echo "HTTP_PORT must be between 1 and 65535 (got \"$HTTP_PORT\")."
+	echo "Using default http port \"$DEFAULT_HTTP_PORT\""
+	HTTP_PORT="$DEFAULT_HTTP_PORT"
+fi
+case "$HTTPS_PORT" in
+	''|*[!0-9]*)
+		echo "Could not parse HTTPS_PORT as integer (got \"$HTTPS_PORT\")."
+		echo "Using default https port \"$DEFAULT_HTTPS_PORT\""
+		HTTPS_PORT="$DEFAULT_HTTPS_PORT"
+		;;
+	*) true ;;
+esac
+if [ "$HTTPS_PORT" -lt "1" ] || [ "$HTTPS_PORT" -gt "65535" ]; then
+    echo "HTTPS_PORT must be between 1 and 65535 (got \"$HTTPS_PORT\")."
+	echo "Using default https port \"$DEFAULT_HTTPS_PORT\""
+	HTTPS_PORT="$DEFAULT_HTTPS_PORT"
+fi
+
+process_folder () {
+	FILES=$(find "$1" -type f -name "*.conf")
+
+	HTTP_SED_REGEX='/ssl/! s/listen (\[::\]:)?[0-9]+/listen \1'$HTTP_PORT'/g'
+	HTTPS_SED_REGEX='/ssl/ s/listen (\[::\]:)?[0-9]+/listen \1'$HTTPS_PORT'/g'
+
+	for FILE in $FILES
+	do
+		echo "- ${FILE}"
+		echo "$(sed -E "$HTTP_SED_REGEX" "$FILE")" > $FILE
+		echo "$(sed -E "$HTTPS_SED_REGEX" "$FILE")" > $FILE
+	done
+
+	# ensure the files are still owned by the npm user
+	chown -R "$PUID:$PGID" "$1"
+}
+
+process_folder /data/nginx

docs/src/advanced-config/index.md

@@ -164,6 +164,18 @@ The easy fix is to add a Docker environment variable to the Nginx Proxy Manager
       DISABLE_IPV6: 'true'
 ```
 
+## Chaning the HTTP and HTTPS Listen Port
+
+If you are unable to configure the port mapping within Docker (eg. when using
+`hostNetwork: true`) you can change the port that proxy-hosts and
+redirection-hosts listen on by setting the environment variables `HTTP_PORT` and
+`HTTPS_PORT`:
+
+```yml
+    environment:
+      HTTP_PORT: "1234"
+      HTTPS_PORT: "5678"
+```
 
 ## Custom Nginx Configurations