Merge pull request #4073 from NginxProxyManager/develop

v2.12.0

.version

@@ -1 +1 @@
-2.12.1
+2.12.0

Jenkinsfile

@@ -43,7 +43,7 @@ pipeline {
 					steps {
 						script {
 							// Defaults to the Branch name, which is applies to all branches AND pr's
-							buildxPushTags = "-t docker.io/nginxproxymanager/${IMAGE}-dev:${BRANCH_LOWER}"
+							buildxPushTags = "-t docker.io/jc21/${IMAGE}:github-${BRANCH_LOWER}"
 						}
 					}
 				}
@@ -203,13 +203,7 @@ pipeline {
 					}
 					steps {
 						script {
-							npmGithubPrComment("""Docker Image for build ${BUILD_NUMBER} is available on
-[DockerHub](https://cloud.docker.com/repository/docker/nginxproxymanager/${IMAGE}-dev)
-as `nginxproxymanager/${IMAGE}-dev:${BRANCH_LOWER}`
-
-**Note:** ensure you backup your NPM instance before testing this image! Especially if there are database changes
-**Note:** this is a different docker image namespace than the official image
-""", true)
+							npmGithubPrComment("Docker Image for build ${BUILD_NUMBER} is available on [DockerHub](https://cloud.docker.com/repository/docker/jc21/${IMAGE}) as `jc21/${IMAGE}:github-${BRANCH_LOWER}`\n\n**Note:** ensure you backup your NPM instance before testing this PR image! Especially if this PR contains database changes.", true)
 						}
 					}
 				}

README.md

@@ -1,7 +1,7 @@
 <p align="center">
 	<img src="https://nginxproxymanager.com/github.png">
 	<br><br>
-	<img src="https://img.shields.io/badge/version-2.12.1-green.svg?style=for-the-badge">
+	<img src="https://img.shields.io/badge/version-2.12.0-green.svg?style=for-the-badge">
 	<a href="https://hub.docker.com/repository/docker/jc21/nginx-proxy-manager">
 		<img src="https://img.shields.io/docker/stars/jc21/nginx-proxy-manager.svg?style=for-the-badge">
 	</a>

backend/internal/nginx.js

@@ -5,20 +5,6 @@ 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 (isNaN(user_port) || 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 = {
 
 	/**
@@ -195,9 +181,7 @@ const internalNginx = {
 	 * @param   {Object}  host
 	 * @returns {Promise}
 	 */
-	generateConfig: (host_type, host_row) => {
-		// Prevent modifying the original object:
-		let host             = JSON.parse(JSON.stringify(host_row));
+	generateConfig: (host_type, host) => {
 		const nice_host_type = internalNginx.getFileFriendlyHostType(host_type);
 
 		if (config.debug()) {
@@ -246,10 +230,8 @@ const internalNginx = {
 				locationsPromise = Promise.resolve();
 			}
 
-			// Set the IPv6 and port setting for the host
-			host.ipv6       = internalNginx.ipv6Enabled();
-			host.http_port  = internalNginx.httpPort();
-			host.https_port = internalNginx.httpsPort();
+			// Set the IPv6 setting for the host
+			host.ipv6 = internalNginx.ipv6Enabled();
 
 			locationsPromise.then(() => {
 				renderEngine
@@ -303,9 +285,7 @@ const internalNginx = {
 				return;
 			}
 
-			certificate.ipv6       = internalNginx.ipv6Enabled();
-			certificate.http_port  = internalNginx.httpPort();
-			certificate.https_port = internalNginx.httpsPort();
+			certificate.ipv6 = internalNginx.ipv6Enabled();
 
 			renderEngine
 				.parseAndRender(template, certificate)
@@ -450,30 +430,7 @@ 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/schema/components/proxy-host-object.json

@@ -23,7 +23,9 @@
 		"locations",
 		"hsts_enabled",
 		"hsts_subdomains",
-		"certificate"
+		"certificate",
+		"use_default_location",
+		"ipv6"
 	],
 	"additionalProperties": false,
 	"properties": {
@@ -149,6 +151,12 @@
 					"$ref": "./access-list-object.json"
 				}
 			]
+		},
+		"use_default_location": {
+			"type": "boolean"
+		},
+		"ipv6": {
+			"type": "boolean"
 		}
 	}
 }

backend/schema/components/redirection-host-object.json

@@ -28,7 +28,7 @@
 		},
 		"forward_scheme": {
 			"type": "string",
-			"enum": ["auto", "http", "https"]
+			"enum": ["http", "https"]
 		},
 		"forward_domain_name": {
 			"description": "Domain Name",

backend/schema/components/setting-object.json

@@ -25,7 +25,7 @@
 		"value": {
 			"description": "Value in almost any form",
 			"example": "congratulations",
-			"anyOf": [
+			"oneOf": [
 				{
 					"type": "string",
 					"minLength": 1
@@ -46,10 +46,7 @@
 		},
 		"meta": {
 			"description": "Extra metadata",
-			"example": {
-				"redirect": "http://example.com",
-				"html": "<h1>404</h1>"
-			},
+			"example": {},
 			"type": "object"
 		}
 	}

backend/schema/paths/nginx/access-lists/listID/put.json

@@ -49,7 +49,8 @@
 										"minLength": 1
 									},
 									"password": {
-										"type": "string"
+										"type": "string",
+										"minLength": 1
 									}
 								}
 							}

backend/schema/paths/nginx/dead-hosts/hostID/put.json

@@ -94,7 +94,9 @@
 									"avatar": "",
 									"roles": ["admin"]
 								},
-								"certificate": null
+								"certificate": null,
+								"use_default_location": true,
+								"ipv6": true
 							}
 						}
 					},

backend/schema/paths/nginx/dead-hosts/post.json

@@ -79,7 +79,9 @@
 									"nickname": "Admin",
 									"avatar": "",
 									"roles": ["admin"]
-								}
+								},
+								"use_default_location": true,
+								"ipv6": true
 							}
 						}
 					},

backend/schema/paths/nginx/proxy-hosts/hostID/put.json

@@ -129,7 +129,9 @@
 									"roles": ["admin"]
 								},
 								"certificate": null,
-								"access_list": null
+								"access_list": null,
+								"use_default_location": true,
+								"ipv6": true
 							}
 						}
 					},

backend/schema/paths/nginx/proxy-hosts/post.json

@@ -114,7 +114,9 @@
 									"avatar": "//www.gravatar.com/avatar/e64c7d89f26bd1972efa854d13d7dd61?default=mm",
 									"roles": ["admin"]
 								},
-								"access_list": null
+								"access_list": null,
+								"use_default_location": true,
+								"ipv6": true
 							}
 						}
 					},

backend/schema/paths/nginx/redirection-hosts/hostID/put.json

@@ -114,7 +114,9 @@
 									"avatar": "",
 									"roles": ["admin"]
 								},
-								"certificate": null
+								"certificate": null,
+								"use_default_location": true,
+								"ipv6": true
 							}
 						}
 					},

backend/schema/paths/nginx/redirection-hosts/post.json

@@ -99,7 +99,9 @@
 									"nickname": "Admin",
 									"avatar": "",
 									"roles": ["admin"]
-								}
+								},
+								"use_default_location": true,
+								"ipv6": true
 							}
 						}
 					},

backend/schema/paths/nginx/streams/streamID/put.json

@@ -129,7 +129,9 @@
 									"roles": ["admin"]
 								},
 								"certificate": null,
-								"access_list": null
+								"access_list": null,
+								"use_default_location": true,
+								"ipv6": true
 							}
 						}
 					},

backend/schema/paths/settings/settingID/put.json

@@ -13,8 +13,7 @@
 			"name": "settingID",
 			"schema": {
 				"type": "string",
-				"minLength": 1,
-				"enum": ["default-site"]
+				"minLength": 1
 			},
 			"required": true,
 			"description": "Setting ID",
@@ -32,21 +31,10 @@
 					"minProperties": 1,
 					"properties": {
 						"value": {
-							"type": "string",
-							"minLength": 1,
-							"enum": ["congratulations", "404", "444", "redirect", "html"]
+							"$ref": "../../../components/setting-object.json#/properties/value"
 						},
 						"meta": {
-							"type": "object",
-							"additionalProperties": false,
-							"properties": {
-								"redirect": {
-									"type": "string"
-								},
-								"html": {
-									"type": "string"
-								}
-							}
+							"$ref": "../../../components/setting-object.json#/properties/meta"
 						}
 					}
 				}

backend/templates/_access.conf

@@ -4,7 +4,7 @@
     auth_basic            "Authorization required";
     auth_basic_user_file  /data/access/{{ access_list_id }};
 
-    {% if access_list.pass_auth == 0 or access_list.pass_auth == true %}
+    {% if access_list.pass_auth == 0 %}
     proxy_set_header Authorization "";
     {% endif %}
 
@@ -17,7 +17,7 @@
     deny all;
 
     # Access checks must...
-    {% if access_list.satisfy_any == 1 or access_list.satisfy_any == true %}
+    {% if access_list.satisfy_any == 1 %}
     satisfy any;
     {% else %}
     satisfy all;

backend/templates/_listen.conf

@@ -1,20 +1,15 @@
-  listen {{ http_port }};
+  listen 80;
 {% if ipv6 -%}
-  listen [::]:{{ http_port }};
+  listen [::]:80;
 {% else -%}
-  #listen [::]:{{ http_port }};
+  #listen [::]:80;
 {% endif %}
 {% if certificate -%}
-  listen {{ https_port }} ssl;
+  listen 443 ssl{% if http2_support == 1 or http2_support == true %} http2{% endif %};
 {% if ipv6 -%}
-  listen [::]:{{ https_port }} ssl;
+  listen [::]:443 ssl{% if http2_support == 1 or http2_support == true %} http2{% endif %};
 {% else -%}
-  #listen [::]:{{ https_port }};
+  #listen [::]:443;
 {% endif %}
 {% endif %}
   server_name {{ domain_names | join: " " }};
-{% if http2_support == 1 or http2_support == true %}
-  http2 on;
-{% else -%}
-  http2 off;
-{% endif %}

backend/templates/_location.conf

@@ -7,7 +7,11 @@
     proxy_set_header X-Forwarded-For    $remote_addr;
     proxy_set_header X-Real-IP		$remote_addr;
 
-    proxy_pass       {{ forward_scheme }}://{{ forward_host }}:{{ forward_port }}{{ forward_path }};
+    set $proxy_forward_scheme {{ forward_scheme }};
+    set $proxy_server         "{{ forward_host }}";
+    set $proxy_port           {{ forward_port }};
+
+    proxy_pass       $proxy_forward_scheme://$proxy_server:$proxy_port{{ forward_path }};
 
     {% include "_access.conf" %}
     {% include "_assets.conf" %}

docker/docker-compose.dev.yml

@@ -33,8 +33,6 @@ 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,6 +18,5 @@ 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

@@ -1,62 +0,0 @@
-#!/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'
-
-	echo "Setting HTTP listen port to $HTTP_PORT and HTTPS listen port to $HTTPS_PORT in: $1"
-
-	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 /etc/nginx/conf.d
-process_folder /data/nginx

docs/src/advanced-config/index.md

@@ -164,18 +164,6 @@ 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
 

docs/src/setup/index.md

@@ -137,13 +137,5 @@ Email:    admin@example.com
 Password: changeme
 ```
 
-Immediately after logging in with this default user you will be asked to modify your details and change your password. You can change defaults with:
-
-
-```
-    environment:
-      INITIAL_ADMIN_EMAIL: my@example.com
-      INITIAL_ADMIN_PASSWORD: mypassword1
-```
-
+Immediately after logging in with this default user you will be asked to modify your details and change your password.
 

global/certbot-dns-plugins.json

@@ -7,7 +7,7 @@
 		"credentials": "dns_acmedns_api_url = http://acmedns-server/\ndns_acmedns_registration_file = /data/acme-registration.json",
 		"full_plugin_name": "dns-acmedns"
 	},
-	"active24":{
+    "active24":{
 		"name": "Active24",
 		"package_name": "certbot-dns-active24",
 		"version": "~=1.5.1",
@@ -303,14 +303,6 @@
 		"credentials": "dns_joker_username = <Dynamic DNS Authentication Username>\ndns_joker_password = <Dynamic DNS Authentication Password>\ndns_joker_domain = <Dynamic DNS Domain>",
 		"full_plugin_name": "dns-joker"
 	},
-	"leaseweb": {
-		"name": "LeaseWeb",
-		"package_name": "certbot-dns-leaseweb",
-		"version": "~=1.0.1",
-		"dependencies": "",
-		"credentials": "dns_leaseweb_api_token = 01234556789",
-		"full_plugin_name": "dns-leaseweb"
-	},
 	"linode": {
 		"name": "Linode",
 		"package_name": "certbot-dns-linode",
@@ -432,13 +424,13 @@
 		"full_plugin_name": "dns-rfc2136"
 	},
 	"rockenstein": {
-		"name": "rockenstein AG",
-		"package_name": "certbot-dns-rockenstein",
-		"version": "~=1.0.0",
-		"dependencies": "",
-		"credentials": "dns_rockenstein_token=<token>",
-		"full_plugin_name": "dns-rockenstein"
-	},
+                "name": "rockenstein AG",
+                "package_name": "certbot-dns-rockenstein",
+                "version": "~=1.0.0",
+                "dependencies": "",
+                "credentials": "dns_rockenstein_token=<token>",
+                "full_plugin_name": "dns-rockenstein"
+        },
 	"route53": {
 		"name": "Route 53 (Amazon)",
 		"package_name": "certbot-dns-route53",

test/cypress/e2e/api/FullCertProvision.cy.js

@@ -9,7 +9,7 @@ describe('Full Certificate Provisions', () => {
 		});
 	});
 
-	it('Should be able to create new http certificate', function() {
+	it.only('Should be able to create new http certificate', function() {
 		cy.task('backendApiPost', {
 			token: token,
 			path:  '/api/nginx/certificates',
@@ -35,7 +35,7 @@ describe('Full Certificate Provisions', () => {
 	it('Should be able to create new DNS certificate with Powerdns', function() {
 		cy.task('backendApiPost', {
 			token: token,
-			path:  '/api/nginx/certificates',
+			path:  '/api/certificates',
 			data:  {
 				domain_names: [
 					'website2.example.com'
@@ -45,8 +45,7 @@ describe('Full Certificate Provisions', () => {
 					dns_challenge: true,
 					dns_provider: 'powerdns',
 					dns_provider_credentials: 'dns_powerdns_api_url = http://ns1.pdns:8081\r\ndns_powerdns_api_key = npm',
-					letsencrypt_agree: true,
-					propagation_seconds: 5,
+					letsencrypt_agree: true
 				},
 				provider: 'letsencrypt'
 			}

test/cypress/e2e/api/Hosts.cy.js

@@ -1,6 +1,6 @@
 /// <reference types="cypress" />
 
-describe('Proxy Hosts endpoints', () => {
+describe('Hosts endpoints', () => {
 	let token;
 
 	before(() => {

test/cypress/e2e/api/Settings.cy.js

@@ -1,124 +0,0 @@
-/// <reference types="cypress" />
-
-describe('Settings endpoints', () => {
-	let token;
-
-	before(() => {
-		cy.getToken().then((tok) => {
-			token = tok;
-		});
-	});
-
-	it('Get all settings', function() {
-		cy.task('backendApiGet', {
-			token: token,
-			path:  '/api/settings',
-		}).then((data) => {
-			cy.validateSwaggerSchema('get', 200, '/settings', data);
-			expect(data.length).to.be.greaterThan(0);
-		});
-	});
-
-	it('Get default-site setting', function() {
-		cy.task('backendApiGet', {
-			token: token,
-			path:  '/api/settings/default-site',
-		}).then((data) => {
-			cy.validateSwaggerSchema('get', 200, '/settings/{settingID}', data);
-			expect(data).to.have.property('id');
-			expect(data.id).to.be.equal('default-site');
-		});
-	});
-
-	it('Default Site congratulations', function() {
-		cy.task('backendApiPut', {
-			token: token,
-			path:  '/api/settings/default-site',
-			data: {
-				value: 'congratulations',
-			},
-		}).then((data) => {
-			cy.validateSwaggerSchema('put', 200, '/settings/{settingID}', data);
-			expect(data).to.have.property('id');
-			expect(data.id).to.be.equal('default-site');
-			expect(data).to.have.property('value');
-			expect(data.value).to.be.equal('congratulations');
-		});
-	});
-
-	it('Default Site 404', function() {
-		cy.task('backendApiPut', {
-			token: token,
-			path:  '/api/settings/default-site',
-			data: {
-				value: '404',
-			},
-		}).then((data) => {
-			cy.validateSwaggerSchema('put', 200, '/settings/{settingID}', data);
-			expect(data).to.have.property('id');
-			expect(data.id).to.be.equal('default-site');
-			expect(data).to.have.property('value');
-			expect(data.value).to.be.equal('404');
-		});
-	});
-
-	it('Default Site 444', function() {
-		cy.task('backendApiPut', {
-			token: token,
-			path:  '/api/settings/default-site',
-			data: {
-				value: '444',
-			},
-		}).then((data) => {
-			cy.validateSwaggerSchema('put', 200, '/settings/{settingID}', data);
-			expect(data).to.have.property('id');
-			expect(data.id).to.be.equal('default-site');
-			expect(data).to.have.property('value');
-			expect(data.value).to.be.equal('444');
-		});
-	});
-
-	it('Default Site redirect', function() {
-		cy.task('backendApiPut', {
-			token: token,
-			path:  '/api/settings/default-site',
-			data: {
-				value: 'redirect',
-				meta: {
-					redirect: 'https://www.google.com',
-				},
-			},
-		}).then((data) => {
-			cy.validateSwaggerSchema('put', 200, '/settings/{settingID}', data);
-			expect(data).to.have.property('id');
-			expect(data.id).to.be.equal('default-site');
-			expect(data).to.have.property('value');
-			expect(data.value).to.be.equal('redirect');
-			expect(data).to.have.property('meta');
-			expect(data.meta).to.have.property('redirect');
-			expect(data.meta.redirect).to.be.equal('https://www.google.com');
-		});
-	});
-
-	it('Default Site html', function() {
-		cy.task('backendApiPut', {
-			token: token,
-			path:  '/api/settings/default-site',
-			data: {
-				value: 'html',
-				meta: {
-					html: '<p>hello world</p>'
-				},
-			},
-		}).then((data) => {
-			cy.validateSwaggerSchema('put', 200, '/settings/{settingID}', data);
-			expect(data).to.have.property('id');
-			expect(data.id).to.be.equal('default-site');
-			expect(data).to.have.property('value');
-			expect(data.value).to.be.equal('html');
-			expect(data).to.have.property('meta');
-			expect(data.meta).to.have.property('html');
-			expect(data.meta.html).to.be.equal('<p>hello world</p>');
-		});
-	});
-});

test/cypress/plugins/backendApi/client.js

@@ -7,7 +7,7 @@ const BackendApi = function(config, token) {
 
 	this.axios = axios.create({
 		baseURL: config.baseUrl,
-		timeout: 90000,
+		timeout: 60000,
 	});
 };