playground compose file

Author: KevyVo

.github/workflows/deploy-changed-samples.yml

@@ -107,8 +107,6 @@ jobs:
           TEST_TAVILY_API_KEY: ${{ secrets.TEST_TAVILY_API_KEY }}
           TEST_ALLOWED_HOSTS: ${{ secrets.TEST_ALLOWED_HOSTS }}
           TEST_N8N_ENCRYPTION_KEY: ${{ secrets.TEST_N8N_ENCRYPTION_KEY }}
-          TEST_DB_POSTGRESDB_SSL_ENABLED: ${{ secrets.TEST_DB_POSTGRESDB_SSL_ENABLED }}
-          TEST_DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED: ${{ secrets.TEST_DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED }}
           TEST_DB_POSTGRESDB_PASSWORD: ${{ secrets.TEST_POSTGRES_PASSWORD }}
         run: |
           SAMPLES=$(sed 's|^samples/||' changed_samples.txt | paste -s -d ',' -)

samples/n8n/.github/workflows/deploy.yaml

@@ -20,9 +20,7 @@ jobs:
       - name: Deploy
         uses: DefangLabs/[email protected]
         with:
-          config-env-vars: POSTGRES_USER N8N_ENCRYPTION_KEY DB_POSTGRESDB_SSL_ENABLED DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED
+          config-env-vars: POSTGRES_USER N8N_ENCRYPTION_KEY
         env:
           POSTGRES_PASSWORD: ${{ secrets.POSTGRES_PASSWORD }}
           N8N_ENCRYPTION_KEY: ${{ secrets.N8N_ENCRYPTION_KEY }}
-          DB_POSTGRESDB_SSL_ENABLED: ${{ secrets.DB_POSTGRESDB_SSL_ENABLED }}
-          DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED: ${{ secrets.DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED }}

samples/n8n/README.md

@@ -34,22 +34,13 @@ For this sample, you will need to provide the following [configuration](https://
 
 The password for your Postgres database. You need to set this before deploying for the first time.
 
-*You can easily set this to a random string using `defang config set POSTGRES_PASSWORD --random`*
+_You can easily set this to a random string using `defang config set POSTGRES_PASSWORD --random`_
 
 ### `N8N_ENCRYPTION_KEY`
 
-The encryption key for your n8n instance. This is used to encrypt sensitive data in the database. 
-
-*You can easily set this to a random string using `defang config set N8N_ENCRYPTION_KEY --random`*
-
-### `DB_POSTGRESDB_SSL_ENABLED`
-
-Set to `true` to enable SSL. Set to `false` to disable SSL.
-
-### `DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED`
-
-Set to `true` to reject unauthorized certificates. Set to `false` to accept unauthorized certificates. Counterintuitive, but leave this as **true** to **disable SSL** (required for local dev and playground).
+The encryption key for your n8n instance. This is used to encrypt sensitive data in the database.
 
+_You can easily set this to a random string using `defang config set N8N_ENCRYPTION_KEY --random`_
 
 ## Deployment
 
@@ -61,13 +52,27 @@ Set to `true` to reject unauthorized certificates. Set to `false` to accept unau
 Deploy your application to the Defang Playground by opening up your terminal and typing:
 
 ```bash
-defang compose up
+defang compose -f compose.playground.yaml up
 ```
 
 ### BYOC
 
 If you want to deploy to your own cloud account, you can [use Defang BYOC](https://docs.defang.io/docs/tutorials/deploy-to-your-cloud).
 
+There no need to specify a compose file, as the default `compose.yaml` will be used.
+
+## Tips and Troubleshooting
+
+If you like to learn more about n8n configuration, check out the [n8n docs](https://docs.n8n.io/hosting/configuration/environment-variables/).
+
+### `DB_POSTGRESDB_SSL_ENABLED`
+
+Set to `true` to enable SSL. Set to `false` to disable SSL.
+
+### `DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED`
+
+Set to `true` to reject unauthorized certificates. Set to `false` to accept unauthorized certificates. Counterintuitive, but leave this as **true** to **disable SSL** (required for local dev and playground).
+
 ---
 
 Title: n8n

samples/n8n/compose.dev.yaml

@@ -7,8 +7,6 @@ services:
       - POSTGRES_PASSWORD=password
     volumes:
       - db_storage:/var/lib/postgresql/data
-    healthcheck:
-      test: ["CMD-SHELL", "pg_isready -h localhost -U n8nuser -d n8ndatabase"]
 
   n8n:
     extends:
@@ -18,17 +16,14 @@ services:
       - DB_POSTGRESDB_SSL_ENABLED=false
       - DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED=true # counterintuitive, but leave this as true to *disable* SSL (required for local dev)
       - N8N_ENCRYPTION_KEY=unsafe-encryption-key
+      - N8N_PROTOCOL=http
+      - N8N_HOST=localhost
+      - WEBHOOK_URL=http://localhost:5678/
+      - N8N_PROXY_HOPS=0
       - DB_POSTGRESDB_PASSWORD=password
-    ports:
-      - 5678:5678
-    links:
-      - postgres
     volumes:
       - n8n_storage:/home/node/.n8n
-    depends_on:
-      postgres:
-        condition: service_healthy
 
 volumes:
   db_storage:
-  n8n_storage:
+  n8n_storage:

samples/n8n/compose.playground.yaml

@@ -0,0 +1,13 @@
+services:
+  postgres:
+    extends:
+      file: compose.yaml
+      service: postgres
+
+  n8n:
+    extends:
+      file: compose.yaml
+      service: n8n
+    environment:
+      - DB_POSTGRESDB_SSL_ENABLED=false
+      - DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED=true

samples/n8n/compose.yaml

@@ -32,8 +32,8 @@ services:
       - N8N_PROXY_HOPS=1 # Required behind a load balancer
       - NODE_ENV=production
       - WEBHOOK_URL=https://n8n
-      - DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED
-      - DB_POSTGRESDB_SSL_ENABLED
+      - DB_POSTGRESDB_SSL_ENABLED=true
+      - DB_POSTGRESDB_SSL_REJECT_UNAUTHORIZED=false
       # MANAGED CONFIG
       - N8N_ENCRYPTION_KEY
       - DB_POSTGRESDB_PASSWORD=${POSTGRES_PASSWORD}