Docker self-hosting improvements #2177
Conversation
|
WalkthroughThe changes update documentation and configuration files related to Docker-based self-hosting. The minimum hardware requirements for the worker machine are increased, and git clone commands in setup instructions are updated to use shallow clones. A note is added regarding modifying the default registry authentication file before production deployment. The 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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
hosting/docker/webapp/docker-compose.yml (1)
207-207: Add newline at EOF
YAML files should end with a newline to satisfy linters.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
docs/self-hosting/docker.mdx(4 hunks)hosting/docker/.env.example(5 hunks)hosting/docker/webapp/docker-compose.yml(9 hunks)hosting/docker/worker/docker-compose.yml(3 hunks)
🧰 Additional context used
🪛 YAMLlint (1.37.1)
hosting/docker/webapp/docker-compose.yml
[error] 207-207: no new line character at the end of file
(new-line-at-end-of-file)
🪛 dotenv-linter (3.3.0)
hosting/docker/.env.example
[warning] 46-46: [UnorderedKey] The DEV_OTEL_EXPORTER_OTLP_ENDPOINT key should go before the LOGIN_ORIGIN key
[warning] 67-67: [UnorderedKey] The DOCKER_REGISTRY_PASSWORD key should go before the DOCKER_REGISTRY_URL key
⏰ Context from checks skipped due to timeout of 90000ms (25)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (6, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (8, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (7, 10)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (7, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (10, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (5, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (9, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (3, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (2, 10)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (4, 10)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (8, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (5, 8)
- GitHub Check: units / webapp / 🧪 Unit Tests: Webapp (1, 10)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (4, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (6, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (3, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (2, 8)
- GitHub Check: units / internal / 🧪 Unit Tests: Internal (1, 8)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: units / packages / 🧪 Unit Tests: Packages (1, 1)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (17)
docs/self-hosting/docker.mdx (3)
52-53: Updated worker minimum specs
Minimum requirements increased to 4+ vCPU and 8+ GB RAM. This aligns with performance improvements and user feedback on resource needs.
73-73: Shallow clone for faster setup
Adding--depth=1optimizes cloning speed and reduces disk usage.
215-215: Production registry auth caution
Highlighting the need to update the default.htpasswdfile before prod is essential to prevent insecure defaults.hosting/docker/worker/docker-compose.yml (4)
3-8: Introduce reusable logging config anchor
Definingx-loggingallows centralized control of log driver settings and aligns with.envfallback variables.
14-14: Apply logging anchor to supervisor service
Ensures supervisor logs respect configured driver and rotation settings.
33-34: Make API and OTLP endpoints configurable
Switching to${...:-default}patterns supports overrides for split deployments.
57-57: Apply logging anchor to docker-proxy service
Consistent logging configuration across proxy service to prevent unbounded log growth.hosting/docker/webapp/docker-compose.yml (4)
3-8: Introduce reusable logging config anchor
Centralizes log rotation settings with environment fallbacks. Good consistency with worker setup.
14-14: Apply logging anchor to all services
Ensures uniform log driver and size/file limits across webapp, databases, and storage services.Also applies to: 72-72, 96-96, 113-113, 132-132, 153-153, 175-175
50-50: Add DEV_OTEL_EXPORTER_OTLP_ENDPOINT override
Allows custom OTLP endpoint for development telemetry with sensible default.
119-119: Externalize Electric service DATABASE_URL
Switches to${DATABASE_URL:-…}for consistency and environment-based overrides.hosting/docker/.env.example (6)
21-24: Add placeholders for Worker URLs
ProvidingTRIGGER_API_URLandOTEL_EXPORTER_OTLP_ENDPOINTimproves clarity for split setups.
37-37: Refine example TRIGGER_IMAGE_TAG
Using a specific example tag (v4.0.0-v4-beta.21) demonstrates locking best practices.
46-46: Add DEV_OTEL_EXPORTER_OTLP_ENDPOINT to example env
Complements webapp compose changes for telemetry endpoint configuration.
64-64: Update registry docs link anchor
Pointing directly to#registry-setupimproves navigation to relevant section.
71-71: Update object storage docs link anchor
Direct link to#object-storagestreamlines setup reference.
110-115: Add Docker logging configuration examples
Commented variables guide customization of log driver, rotation size, and compression.
A lot of settings now more easily configurable by editing
.envfile only. The default logging driver settings will now prevent excessive disk usage. Min worker specs have been raised after user feedback.