-
Notifications
You must be signed in to change notification settings - Fork 1
feat(docker): add production compose file, update README #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat(docker): add production compose file, update README #11
Conversation
…setup_volumes.sh - Introduced a new docker-compose.prod.yml file for production configuration. - Updated README to reflect changes in volume management and service startup instructions. - Removed the setup_volumes.sh script as volume directories are now managed directly in the docker-compose files.
WalkthroughThe changes remove the manual setup of volume directories for Docker Compose by deleting the setup script and updating documentation. The Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant DockerCompose
participant HostFS
User->>DockerCompose: Start in Development (docker compose up -d)
DockerCompose->>DockerCompose: Create anonymous volumes
DockerCompose->>HostFS: Use Docker-managed storage (no explicit host bind)
User->>DockerCompose: Start in Production (docker-compose -f ... up -d)
DockerCompose->>HostFS: Bind mount /data/n8n, /data/opensearch, /data/postgresql
DockerCompose->>DockerCompose: Use explicit host directories for persistence
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
💤 Files with no reviewable changes (1)
⏰ Context from checks skipped due to timeout of 90000ms (2)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
🔍 Vulnerabilities of
|
| digest | sha256:266cca6c63605986e4b35d9933726415085b8077932685ca9e3bdc08a60dc620 |
| vulnerabilities | |
| platform | linux/amd64 |
| size | 243 MB |
| packages | 1628 |
📦 Base Image node:20-alpine
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
| ||||||||||||
Description
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (4)
docker-compose.prod.yml (3)
2-3: Inconsistent volume naming convention
The volume names mix snake_case (n8n_data) and kebab-case (opensearch-data,postgresql-data), which can confuse readers and tooling. Pick one convention (e.g.,n8n-data) and apply it uniformly.-volumes: - n8n_data: +volumes: + n8n-data: driver: localAlso applies to: 8-9, 14-15
5-7: Parameterize host data directory path
Hard-coding/data/...reduces flexibility across environments. Consider introducing an environment variable (e.g.,${HOST_DATA_DIR}) for the host directory root so you can override it without editing the Compose file.driver_opts: type: none o: bind - device: /data/n8n + device: ${HOST_DATA_DIR:-/data}/n8n(Apply the same pattern to
/data/opensearchand/data/postgresql.)Also applies to: 11-13, 17-19
19-19: Add newline at end of file
YAML files should end with a newline to satisfy POSIX standards and avoid lint errors.@@ device: /data/postgresql +🧰 Tools
🪛 YAMLlint (1.35.1)
[error] 19-19: no new line character at the end of file
(new-line-at-end-of-file)
README.md (1)
37-49: Unify Docker CLI commands
The instructions use bothdocker compose(modern CLI) anddocker-compose(legacy). For consistency and clarity, prefer the unifieddocker composesyntax throughout.-#### 2. Production -```bash -docker-compose -f docker-compose.yml -f docker-compose.prod.yml up -d -``` +#### 2. Production +```bash +docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d +```
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
README.md(2 hunks)docker-compose.prod.yml(1 hunks)docker-compose.yml(0 hunks)scripts/setup_volumes.sh(0 hunks)
💤 Files with no reviewable changes (2)
- docker-compose.yml
- scripts/setup_volumes.sh
🧰 Additional context used
🪛 YAMLlint (1.35.1)
docker-compose.prod.yml
[error] 19-19: no new line character at the end of file
(new-line-at-end-of-file)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: Docker Security Scanning (n8n, Dockerfile.n8n, n8n-test:latest)
killev
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Approved
- Eliminated the step to create volume directories as it is no longer necessary. - Updated the workflow to streamline the setup process for Docker.
|



docker-compose.prod.ymlfile for production configuration.