Skip to content

docs: Clarify dokploy-network is auto-attached by Dokploy#31

Merged
finallyjay merged 1 commit into
mainfrom
docs-network-convention
Jun 10, 2026
Merged

docs: Clarify dokploy-network is auto-attached by Dokploy#31
finallyjay merged 1 commit into
mainfrom
docs-network-convention

Conversation

@finallyjay

@finallyjay finallyjay commented Jun 10, 2026

Copy link
Copy Markdown
Owner

Documents a repo convention in CLAUDE.md: services that don't need Cloudflare Tunnel exposure should not declare any network in their compose file — Dokploy attaches its own dokploy-network automatically on deploy (e.g. n8n, plex, watchtower).

Surfaced while adding the n8n service (#30), where the network declaration was dropped for this reason. Also notes that traccar's explicit dokploy-network declaration is redundant legacy.

🤖 Generated with Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated architecture guidance to clarify network configuration requirements, specifying which services require explicit network declarations for external exposure and when automatic network attachment applies.

Document that services not exposed via Cloudflare Tunnel should not
declare any network in their compose file — Dokploy attaches its own
dokploy-network automatically on deploy. Note traccar's explicit
declaration is redundant legacy.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Copilot AI review requested due to automatic review settings June 10, 2026 20:33
@coderabbitai

coderabbitai Bot commented Jun 10, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 2251eb55-d83c-43ea-83a3-644ab6fbcafc

📥 Commits

Reviewing files that changed from the base of the PR and between 05b6f86 and fb674f1.

📒 Files selected for processing (1)
  • CLAUDE.md

📝 Walkthrough

Walkthrough

This PR updates architectural guidance in CLAUDE.md to clarify Docker network configuration. It specifies that services requiring Cloudflare internet exposure should declare the cloudflare-exposed network, while services without that requirement should omit custom networks since Dokploy automatically attaches dokploy-network. The change also notes traccar as an exception that redundantly declares dokploy-network explicitly.

Changes

Network Architecture Guidance

Layer / File(s) Summary
Network model architecture guidance
CLAUDE.md
Documentation clarifies which services should declare cloudflare-exposed network (those requiring Cloudflare exposure), specifies that non-exposed services should omit custom networks (Dokploy auto-attaches dokploy-network), and notes traccar as a redundant explicit dokploy-network exception.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 Networks now clear in the doc's gentle lines,
Cloudflare exposed, dokploy designs,
Traccar still redundant, but marked with care,
Architecture guidance floats through the air! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: clarifying that dokploy-network is automatically attached by Dokploy, which is the core documentation update in CLAUDE.md.
Description check ✅ Passed The description provides a clear summary of what the PR does and why it was needed, covering the documentation convention, context from PR #30, and noting the traccar redundancy.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs-network-convention

Comment @coderabbitai help to get the list of available commands and usage tips.

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the repository’s contributor/agent guidance (CLAUDE.md) to clarify the intended Docker network convention when deploying services via Dokploy—specifically that services not exposed via the Cloudflare Tunnel should omit explicit network declarations because Dokploy auto-attaches its own network.

Changes:

  • Clarifies that Cloudflare-exposed services must explicitly join the cloudflare-exposed network.
  • Documents that non-exposed services should not declare any network, since Dokploy auto-attaches dokploy-network.
  • Notes that traccar’s explicit dokploy-network declaration is redundant legacy behavior.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@finallyjay finallyjay merged commit ab46b0e into main Jun 10, 2026
3 checks passed
@finallyjay finallyjay deleted the docs-network-convention branch June 10, 2026 20:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants