chore(docs): adds info about connection types

[gberenice]

what

• Adds a section about Tailscale connection types, what we prefer, why and how to configure that.

why

• It's not obvious.
• We collected the info about the issue and its workaround.

references

• Unstable connection to postgres via proxy cyrilgdn/terraform-provider-postgresql#495
• Connection types

Summary by CodeRabbit

• Documentation
  • Added comprehensive details about Tailscale connection types (direct and relayed)
  • Introduced guidance on addressing connection stability issues
  • Provided configuration examples for optimizing subnet router connections

[coderabbitai]

Walkthrough

The pull request updates the README.md file with comprehensive documentation about Tailscale subnet router connections. The new content focuses on explaining two primary connection types: Direct (peer-to-peer) and Relayed connections. The documentation provides insights into connection characteristics, potential stability issues, and includes a practical HCL configuration example for optimizing direct connections.

Changes

File	Change Summary
README.md	Added new sections: - "Direct and Relayed Connections" explaining connection types - "Addressing Connection Stability Issues" highlighting potential connectivity problems - "Configuring Direct Connections" with HCL configuration example

Possibly related PRs

• feat: enable log rotation + install CW Agent #48: Documentation enhancement for logging and monitoring, similar to the current README.md improvements

Poem

🌐 Tailscale's connections, direct and bright,
Routing networks with technical might
Subnets dancing, peer to peer
Configuration made crystal clear
A network symphony takes flight! 🚀

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

README.md (2)

77-93: Consider adding more context about connection stability issues.

While the example is helpful, consider adding:

• Frequency of these issues (e.g., rare, common)
• Specific conditions that might trigger them
• Whether this affects all database connections or specific scenarios

---

94-147: Consider adding security recommendations.

The configuration example is comprehensive, but consider adding:

1. A note about the security implications of opening UDP port 41641 to 0.0.0.0/0
2. Guidance on restricting the CIDR range if possible
3. Best practices for securing direct connections in production environments

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between fadaf17 and a7ff66b.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (1)

README.md (1)

70-76: Well-structured introduction to connection types!

The section provides clear and concise explanations of Tailscale's connection types, with helpful references to official documentation.