Update README & Add N8N start options

Author: 7PH

.env.template

@@ -5,4 +5,10 @@ DOCKER_UID=1000
 DOCKER_GID=1000
 
 # Public URL of the server
-PUBLIC_URL=http://n8n.localhost
+PUBLIC_URL=http://localhost
+
+# N8N encryption key
+N8N_ENCRYPTION_KEY=
+
+# Options to forward to N8N
+N8N_OPTIONS="--tunnel"

README.md

@@ -0,0 +1,21 @@
+# Self-hosted N8N
+
+This repository is a starter-pack to get a self-hosted N8N instance with:
+- A containerized setup (docker)
+- An export/import workflow to export/import current workflows and credentials to local folders
+- A persistent encryption key to keep your credentials across losing your container
+
+## Install
+
+```bash
+# 1. Clone the repository
+git clone https://github.com/7PH/n8n-self-hosted.git
+cd n8n-self-hosted
+
+# 2. Copy `.env.template` to `.env` and tweak the environment variables
+#    In particular, ensure `N8N_ENCRYPTION_KEY` is set
+cp .env.template .env
+
+# 3. Run `docker compose up`
+docker compose up
+```

docker-compose.yml

@@ -2,9 +2,10 @@ version: '3.8'
 
 
 services:
-    # /n8n
     n8n:
         container_name: n8n
+        cap_drop:
+            - ALL
         ports:
             - 80:80
         build:
@@ -13,8 +14,8 @@ services:
                 DOCKER_USER: "${DOCKER_USER}"
                 DOCKER_UID: "${DOCKER_UID}"
                 DOCKER_GID: "${DOCKER_GID}"
-        labels:
-            - "traefik.enable=true"
+        env_file:
+            - .env
         volumes:
             - ./credentials/:/app/credentials:rw
             - ./workflows/:/app/workflows:rw

start.sh

@@ -2,4 +2,4 @@
 
 n8n import:credentials --separate --input=credentials
 n8n import:workflow --separate --input=workflows
-n8n start --tunnel
+n8n start $N8N_OPTIONS

workflows/2.json

@@ -1,6 +1,6 @@
 {
   "createdAt": "2023-01-02T10:29:34.090Z",
-  "updatedAt": "2023-01-05T01:12:55.194Z",
+  "updatedAt": "2023-01-05T01:14:44.000Z",
   "id": 2,
   "name": "internal/import",
   "active": false,
@@ -28,6 +28,19 @@
       ],
       "typeVersion": 1,
       "id": "699de5bc-17fc-4383-b060-3890fa70bf67"
+    },
+    {
+      "parameters": {
+        "command": "npx n8n import:credentials --separate --input=credentials"
+      },
+      "name": "Import Credentials",
+      "type": "n8n-nodes-base.executeCommand",
+      "position": [
+        860,
+        340
+      ],
+      "typeVersion": 1,
+      "id": "51a48ad2-1744-4a60-a3f3-78c11b8fefe8"
     }
   ],
   "connections": {
@@ -44,15 +57,21 @@
     },
     "Import Workflows": {
       "main": [
-        []
+        [
+          {
+            "node": "Import Credentials",
+            "type": "main",
+            "index": 0
+          }
+        ]
       ]
     }
   },
   "settings": {},
   "staticData": null,
   "dataLoaded": false,
   "pinData": {},
-  "versionId": "f79b1bbb-ad69-4ef9-8e11-786289a59e05",
+  "versionId": "ee13fa9e-3eef-4745-a33b-5b67fa5b5deb",
   "triggerCount": 0,
   "tags": [
     {