📧 Added public url variable for emails (#2967)

* Added public url variable for emails * Fixed base url for reset password - the current implementation overrides possibly existing path * Change variable name to editorUrl * Using correct name editorUrl for emails * Changed variable description * Improved base url naming and appending path so it remains consistent * Removed trailing slash from editor base url
n8n-io · Mar 11, 2022 · 94edba2 · 94edba2
1 parent 55255be
commit 94edba2
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 6 deletions.
diff --git a/packages/cli/config/index.ts b/packages/cli/config/index.ts
@@ -411,6 +411,12 @@ const config = convict({
 		env: 'N8N_SSL_CERT',
 		doc: 'SSL Cert for HTTPS Protocol',
 	},
+	editorBaseUrl: {
+		format: String,
+		default: '',
+		env: 'N8N_EDITOR_BASE_URL',
+		doc: 'Public URL where the editor is accessible; path will be concatenated to this base. Also used for emails sent from n8n.',
+	},
 
 	security: {
 		excludeEndpoints: {

diff --git a/packages/cli/src/Interfaces.ts b/packages/cli/src/Interfaces.ts
@@ -446,6 +446,7 @@ export interface IN8nUISettings {
 	};
 	timezone: string;
 	urlBaseWebhook: string;
+	urlBaseEditor: string;
 	versionCli: string;
 	n8nMetadata?: {
 		[key: string]: string | number | undefined;

diff --git a/packages/cli/src/Server.ts b/packages/cli/src/Server.ts
@@ -171,7 +171,7 @@ import { ExecutionEntity } from './databases/entities/ExecutionEntity';
 import { SharedWorkflow } from './databases/entities/SharedWorkflow';
 import { AUTH_COOKIE_NAME, RESPONSE_ERROR_MESSAGES } from './constants';
 import { credentialsController } from './api/credentials.api';
-import { isEmailSetUp } from './UserManagement/UserManagementHelper';
+import { getInstanceBaseUrl, isEmailSetUp } from './UserManagement/UserManagementHelper';
 
 require('body-parser-xml')(bodyParser);
 
@@ -296,6 +296,7 @@ class App {
 			maxExecutionTimeout: this.maxExecutionTimeout,
 			timezone: this.timezone,
 			urlBaseWebhook,
+			urlBaseEditor: getInstanceBaseUrl(),
 			versionCli: '',
 			oauthCallbackUrls: {
 				oauth1: `${urlBaseWebhook}${this.restEndpoint}/oauth1-credential/callback`,

diff --git a/packages/cli/src/UserManagement/UserManagementHelper.ts b/packages/cli/src/UserManagement/UserManagementHelper.ts
@@ -55,7 +55,8 @@ export async function getInstanceOwner(): Promise<User> {
  * Return the n8n instance base URL without trailing slash.
  */
 export function getInstanceBaseUrl(): string {
-	const baseUrl = GenericHelpers.getBaseUrl();
+	const editorBaseUrl = config.get('editorBaseUrl');
+	const baseUrl = editorBaseUrl ? editorBaseUrl + config.get('path') : GenericHelpers.getBaseUrl();
 	return baseUrl.endsWith('/') ? baseUrl.slice(0, baseUrl.length - 1) : baseUrl;
 }
 

diff --git a/packages/cli/src/UserManagement/routes/passwordReset.ts b/packages/cli/src/UserManagement/routes/passwordReset.ts
@@ -11,11 +11,10 @@ import { LoggerProxy as Logger } from 'n8n-workflow';
 
 import { Db, InternalHooksManager, ResponseHelper } from '../..';
 import { N8nApp } from '../Interfaces';
-import { validatePassword } from '../UserManagementHelper';
+import { getInstanceBaseUrl, validatePassword } from '../UserManagementHelper';
 import * as UserManagementMailer from '../email';
 import type { PasswordResetRequest } from '../../requests';
 import { issueCookie } from '../auth/jwt';
-import { getBaseUrl } from '../../GenericHelpers';
 import config = require('../../../config');
 
 export function passwordResetNamespace(this: N8nApp): void {
@@ -73,8 +72,8 @@ export function passwordResetNamespace(this: N8nApp): void {
 
 			await Db.collections.User!.update(id, { resetPasswordToken, resetPasswordTokenExpiration });
 
-			const baseUrl = getBaseUrl();
-			const url = new URL('/change-password', baseUrl);
+			const baseUrl = getInstanceBaseUrl();
+			const url = new URL(`${baseUrl}/change-password`);
 			url.searchParams.append('userId', id);
 			url.searchParams.append('token', resetPasswordToken);