mirror of
https://github.com/nickyeoman/docker-compose-cookbooks.git
synced 2026-09-03 18:36:22 +00:00
complete all stack READMEs to the 9-section template
Existing content preserved and reordered to the canonical section order; missing sections generated from each stack's compose data (ports, volumes, env vars, image links). Fixes copy-paste errors in Dockhand sections (qbittorrent pointed at archivebox; invokeai/thunderbird said SERVICENAME) and persistant->persistent typos in gatus. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
+40
-21
@@ -16,9 +16,15 @@ Docker Compose setup for [n8n](https://n8n.io/), a workflow automation tool.
|
||||
- **Docker Hub Tags:** [Tags](https://hub.docker.com/r/n8nio/n8n/tags)
|
||||
- **Reverse Proxy Port:** `5678`
|
||||
|
||||
## Getting Started
|
||||
|
||||
1. Start the container: `docker compose up -d`
|
||||
2. Open http://localhost:5678 in your browser
|
||||
3. Follow the initial setup wizard to configure the application
|
||||
|
||||
## Environment Variable Notes
|
||||
|
||||
N8N_IMAGE – Docker image tag (default: n8nio/n8n:latest)
|
||||
N8N_IMAGE – Docker image tag (default: n8nio/n8n:latest)
|
||||
N8N_PORT – Container port (default: 5678)
|
||||
N8N_HOST – Hostname for the n8n instance (default: localhost)
|
||||
N8N_PROTOCOL – Protocol (default: http; set to https behind NPM)
|
||||
@@ -26,34 +32,28 @@ Docker Compose setup for [n8n](https://n8n.io/), a workflow automation tool.
|
||||
N8N_SECURE_COOKIE – Set true when using HTTPS (default: true)
|
||||
WEBHOOK_URL – Public-facing webhook URL (default: http://localhost:5678)
|
||||
|
||||
## Reverse Proxy Setup (Nginx Proxy Manager)
|
||||
|
||||
1. In NPM, create a **Proxy Host**:
|
||||
- **Domain Names:** `n8n.yourdomain.com`
|
||||
- **Forward Hostname:** `n8n`
|
||||
- **Forward Port:** `5678`
|
||||
- **Scheme:** `http`
|
||||
- **Websockets Support:** ✔ Enabled
|
||||
- **Block Common Exploits:** ✔ Enabled
|
||||
- **SSL:** ✔ Enable SSL (Let's Encrypt)
|
||||
|
||||
2. Override these env vars:
|
||||
|
||||
N8N_HOST=n8n.yourdomain.com
|
||||
N8N_PROTOCOL=https
|
||||
N8N_EDITOR_BASE_URL=https://n8n.yourdomain.com
|
||||
WEBHOOK_URL=https://n8n.yourdomain.com
|
||||
N8N_SECURE_COOKIE=true
|
||||
|
||||
## Volume Notes
|
||||
|
||||
${VOL_PATH}/n8n/data – n8n database and config (chown 1000:1000)
|
||||
${VOL_PATH}/n8n/data – n8n database and config (chown 1000:1000)
|
||||
${VOL_PATH}/n8n/files – shared file storage for workflows
|
||||
|
||||
## Network Notes
|
||||
|
||||
Requires the external `proxy` network.
|
||||
|
||||
## Docker Run
|
||||
|
||||
```bash
|
||||
docker run -d \
|
||||
--name n8n \
|
||||
-p 5678:5678 \
|
||||
-v /data/n8n/data:/home/node/.n8n \
|
||||
-v /data/n8n/files:/files \
|
||||
n8nio/n8n:latest
|
||||
```
|
||||
|
||||
See compose.yaml for the full set of environment variables.
|
||||
|
||||
## Additional Notes / Gotchas
|
||||
|
||||
- A license key is required (free at the time of writing).
|
||||
@@ -74,3 +74,22 @@ Cookbooks Repository
|
||||
Then "Load" n8n/sample.env into the Environmental variables in dockhand
|
||||
|
||||
Create the Stack
|
||||
|
||||
## Reverse Proxy Setup (Nginx Proxy Manager)
|
||||
|
||||
1. In NPM, create a **Proxy Host**:
|
||||
- **Domain Names:** `n8n.yourdomain.com`
|
||||
- **Forward Hostname:** `n8n`
|
||||
- **Forward Port:** `5678`
|
||||
- **Scheme:** `http`
|
||||
- **Websockets Support:** ✔ Enabled
|
||||
- **Block Common Exploits:** ✔ Enabled
|
||||
- **SSL:** ✔ Enable SSL (Let's Encrypt)
|
||||
|
||||
2. Override these env vars:
|
||||
|
||||
N8N_HOST=n8n.yourdomain.com
|
||||
N8N_PROTOCOL=https
|
||||
N8N_EDITOR_BASE_URL=https://n8n.yourdomain.com
|
||||
WEBHOOK_URL=https://n8n.yourdomain.com
|
||||
N8N_SECURE_COOKIE=true
|
||||
|
||||
Reference in New Issue
Block a user