Finish Simple Example

Author: pedrozadotdev

README.md

@@ -35,9 +35,17 @@ N8N 1.76.1 and above.
 
 ## Usage
 
-Se examples folder
+1. Run `cd examples`;
+2. Run `docker compose up -d`;
+3. Access [http://localhost:8081](http://localhost:8081) and setup N8N;
+4. Create a **Redis Credential** and change **Host** field to **redis**;
+5. Create a workflow and import the **Simple_Workflow.json** file;
+6. Use that credential in **HTTP Forward Auth Trigger** and **HTTP Forward Auth** nodes;
+7. Activate the workflow and access [http://localhost:8080](http://localhost:8080).
+
 
 ## Resources
 
 * [n8n community nodes documentation](https://docs.n8n.io/integrations/community-nodes/)
 * [Caddy Forward Auth](https://caddyserver.com/docs/caddyfile/directives/forward_auth)
+* [RedisVectorStore](https://js.langchain.com/docs/integrations/vectorstores/redis/)

examples/Caddyfile

@@ -15,14 +15,14 @@
 	}
 
 	handle /_auth/login {
-		uri replace /_auth/login webhook/{$WEBHOOK_ID}/login
+		uri replace _auth webhook/{$WEBHOOK_ID}
 		reverse_proxy n8n:5678 {
 			header_up X-Real-IP {remote_host}
 		}
 	}
 
 	handle /_auth/logout {
-		uri replace /_auth/logout webhook/{$WEBHOOK_ID}/logout
+		uri replace _auth webhook/{$WEBHOOK_ID}
 		reverse_proxy n8n:5678
 	}
 

examples/Simple_Workflow.json

@@ -1,20 +1,20 @@
 {
-  "name": "My workflow",
+  "name": "Simple Workflow",
   "nodes": [
     {
       "parameters": {
-        "loginURL": "http://localhost:8080/login",
-        "afterLoginURL": "http://localhost:8080/protected",
-        "logoutURL": "http://localhost:8080/login",
+        "authURL": "http://localhost:8080/_auth",
+        "loginRedirectURL": "http://localhost:8080",
+        "logoutRedirectURL": "http://localhost:8080/signed-out",
         "enableHTTP": true
       },
       "type": "CUSTOM.httpForwardAuthTrigger",
       "typeVersion": 1,
       "position": [
-        -360,
-        20
+        0,
+        0
       ],
-      "id": "de7c6620-31c8-4701-b870-dc6825487f35",
+      "id": "69c907ff-c556-458f-89e4-cd68c6d2bfa8",
       "name": "HTTP Forward Auth Trigger",
       "webhookId": "aa1e42ef-7492-4235-9f22-e3c007358d15"
     },
@@ -26,23 +26,23 @@
       "type": "CUSTOM.httpForwardAuth",
       "typeVersion": 1,
       "position": [
-        920,
-        20
+        1280,
+        0
       ],
-      "id": "3368c9bf-3dab-4bd8-9d7f-d5f1abe7610e",
+      "id": "5c5bd1f9-68ca-45cc-9c3d-169bd5fed21b",
       "name": "HTTP Forward Auth"
     },
     {
       "parameters": {
-        "jsCode": "const db = {\n  \"test1@example.com\": \"g9QaXzlc34l4dEw1c6HOHcBrVP6SFswS|BIVTqZnqdUbrS8JiuugWKl1Ch0NaADWaFcIiDpc4Tac=\",\n  \"[email protected]\": \"eSOLsrieYnZ96jNCXfalGF15sJxdluc2|cXFQ/PT1VNb/CRM6SA/d+ADQlS1hwDgtg/tuWipDbbo=\",\n  \"[email protected]\": \"kos8kWXOH7Nr7v72q3kXUzxUwxmKx2uo|Rj3A2BLRCtpKFVjxb6IxuSgLIigbt3wlKazsFGmO5ic=\"\n};\n\nconst userRaw = db[$input.first().json.user];\n\nif(userRaw) {\n  const [salt, hash] = userRaw.split(\"|\");\n  return { salt, hash }\n}\n\nreturn { salt: \"\", hash: \"\" }"
+        "jsCode": "const db = {\n  \"admin@example.com\": \"g9QaXzlc34l4dEw1c6HOHcBrVP6SFswS|Q5LA5FkQb1HpuRz0ppjnQPm13kpyjy7PdgRKIb+VRPI=\" \n};\n\nconst userRaw = db[$input.first().json.user];\n\nif(userRaw) {\n  const [salt, hash] = userRaw.split(\"|\");\n  return { salt, hash }\n}\n\nreturn { salt: \"\", hash: \"\" }"
       },
       "type": "n8n-nodes-base.code",
       "typeVersion": 2,
       "position": [
-        -60,
-        20
+        300,
+        0
       ],
-      "id": "87fa2215-c45c-4950-ae1a-97216eb30e9f",
+      "id": "1dfbe11d-385d-4eea-9a0f-ebe3425fa6c3",
       "name": "Get Data From DB"
     },
     {
@@ -55,10 +55,10 @@
       "type": "n8n-nodes-base.crypto",
       "typeVersion": 1,
       "position": [
-        280,
-        20
+        640,
+        0
       ],
-      "id": "4ac9ba87-0753-4ad9-af56-acbfdb8ecabf",
+      "id": "ba283396-0f28-43d7-b460-df3291d5d867",
       "name": "Hash Password"
     },
     {
@@ -68,11 +68,24 @@
       "type": "n8n-nodes-base.code",
       "typeVersion": 2,
       "position": [
-        600,
-        20
+        960,
+        0
       ],
-      "id": "c3c058a6-eb0d-418e-81f2-9cf142360e34",
+      "id": "6810f87d-f5b4-40ec-872e-9108167f2dcd",
       "name": "Verify Password"
+    },
+    {
+      "parameters": {
+        "content": "## Access Info\nuser: [email protected]\npassword: password"
+      },
+      "type": "n8n-nodes-base.stickyNote",
+      "position": [
+        240,
+        -180
+      ],
+      "typeVersion": 1,
+      "id": "ad36117b-104b-4f40-9240-c83f909a8085",
+      "name": "Sticky Note"
     }
   ],
   "pinData": {},
@@ -124,19 +137,12 @@
   },
   "active": true,
   "settings": {
-    "executionOrder": "v1",
-    "saveDataErrorExecution": "none",
-    "saveDataSuccessExecution": "none",
-    "saveExecutionProgress": false,
-    "saveManualExecutions": false,
-    "callerPolicy": "workflowsFromSameOwner",
-    "executionTimeout": -1
+    "executionOrder": "v1"
   },
-  "versionId": "9b417754-d9d0-4377-8863-e604f59f97f1",
+  "versionId": "86c9094b-196d-49e0-be04-60f19353569a",
   "meta": {
-    "templateCredsSetupCompleted": true,
-    "instanceId": "505a91c807f383cfa51524b51406539ed2a13b65faca94769375174ae416a1e6"
+    "templateCredsSetupCompleted": true
   },
-  "id": "4hi91Jg1ssmzLJwF",
+  "id": "DRLuFvbB6tyPxGpi",
   "tags": []
 }

examples/docker-compose.yml

@@ -40,24 +40,24 @@ services:
       - ./data/grist:/persist
     environment:
       - GRIST_SESSION_SECRET=invent-a-secret-here
-      - GRIST_DEFAULT_EMAIL=your-email@example.com
+      - GRIST_DEFAULT_EMAIL=admin@example.com
       - GRIST_SANDBOX_FLAVOR=gvisor
       - APP_HOME_URL=http://localhost:8080
       - GRIST_SINGLE_ORG=example-com
       - COOKIE_MAX_AGE=604800000
       - GRIST_HIDE_UI_ELEMENTS=helpCenter,billing,templates,createSite,multiSite,multiAccounts,sendToDrive,tutorials,supportGrist
-      - GRIST_PAGE_TITLE_SUFFIX=" - Example.com"
+      - GRIST_PAGE_TITLE_SUFFIX=
       - GRIST_WIDGET_LIST_URL="https://github.com/gristlabs/grist-widget/releases/download/latest/manifest.json"
       - ALLOWED_WEBHOOK_DOMAINS=n8n:5678
       - GRIST_FORWARD_AUTH_HEADER=X-Forwarded-User
       - GRIST_FORWARD_AUTH_LOGOUT_PATH=/_auth/logout
-      # - GRIST_DOCS_MINIO_ACCESS_KEY=grist
-      # - GRIST_DOCS_MINIO_SECRET_KEY=grist
-      # - GRIST_DOCS_MINIO_ENDPOINT=s3
-      # - GRIST_DOCS_MINIO_PORT=8333
-      # - GRIST_DOCS_MINIO_USE_SSL=0
-      # - GRIST_DOCS_MINIO_BUCKET=grist
       - REDIS_URL=redis://redis:6379
+      # - GRIST_DOCS_MINIO_ACCESS_KEY=
+      # - GRIST_DOCS_MINIO_SECRET_KEY=
+      # - GRIST_DOCS_MINIO_ENDPOINT=
+      # - GRIST_DOCS_MINIO_PORT=
+      # - GRIST_DOCS_MINIO_USE_SSL=
+      # - GRIST_DOCS_MINIO_BUCKET=
     depends_on:
       redis:
         condition: service_healthy

nodes/HttpForwardAuth/HttpForwardAuthTrigger.node.ts

@@ -82,7 +82,7 @@ export class HttpForwardAuthTrigger implements INodeType {
 			}
 		} else if (webhookName === 'default') {
 			// CSRF protection
-			const origin = req.headers.Origin;
+			const { origin } = req.headers;
 			if (!origin || origin !== new URL(authURL).origin) {
 				res.status(403).send('Error 403 - Forbidden').end();
 			} else if (rateLimit && remoteIp && !(await rateLimitConsume(redis, remoteIp))) {
@@ -108,7 +108,7 @@ export class HttpForwardAuthTrigger implements INodeType {
 			res.status(200).send(pageContent).end();
 		} else if (webhookName === 'logout') {
 			// CSRF protection
-			const origin = req.headers.Origin;
+			const { origin } = req.headers;
 			if (!origin || origin !== new URL(authURL).origin) {
 				res.status(403).send('Error 403 - Forbidden').end();
 			} else {