docs: add deployment troubleshooting tips

[dashitongzhi]

Summary

• add README deployment troubleshooting guidance for common self-hosting issues
• document required TCP/UDP ports, Docker Compose port mappings, relay address checks, and key/config path pitfalls
• include quick checks for firewalls, reverse proxies, persistent data, and service restarts

Testing

• documentation-only change; reviewed rendered Markdown source

Summary by CodeRabbit

• Documentation
  • Added deployment troubleshooting section with common self-hosting issues and quick verification checks for resolving server connectivity problems and configuration validation.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5a48e10f-c009-454f-8fa6-e80fee939b2c

📥 Commits

Reviewing files that changed from the base of the PR and between 815c728 and 5773fe8.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

A new "Deployment troubleshooting" section is added to README.md under Installation. It provides a checklist of common self-hosting issues and a numbered "Quick checks" list covering ports, Docker Compose setup, relay address configuration, key persistence, proxy passthrough, and restart guidance.

Changes

Deployment Troubleshooting Documentation

Layer / File(s)

Summary

Deployment troubleshooting section README.md

Adds a checklist of self-hosting connectivity issues (firewall/router port exposure, Docker port publishing, relay address, key persistence and permissions, container health, external reachability) and a "Quick checks" numbered list covering client/server address matching, relay port listening, Docker Compose launch directory, proxy TCP/UDP passthrough, and port-rule consistency across environments.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐇 Hoppy the rabbit checks every port,
TCP and UDP, nothing falls short.
Keys must persist, relay must be right,
Docker Compose launched in the right site.
With a quick restart, connections ignite! 🎉

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'docs: add deployment troubleshooting tips' directly and accurately reflects the main change—adding a deployment troubleshooting section to the README documentation.
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

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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