Skip to content

Update README with accurate service list, port table, and prerequisites#27

Merged
joshdev8 merged 1 commit into
mainfrom
docs/update-readme
Apr 1, 2026
Merged

Update README with accurate service list, port table, and prerequisites#27
joshdev8 merged 1 commit into
mainfrom
docs/update-readme

Conversation

@joshdev8
Copy link
Copy Markdown
Owner

@joshdev8 joshdev8 commented Apr 1, 2026

Summary

  • Add prerequisites section (Docker, Plex claim token, VPN provider)
  • Replace flat component list with categorized tables including port numbers
  • Add "Not included but recommended" section for services mentioned but not in docker-compose.yml (Radarr, Sonarr, Lidarr, Bazarr, Prowlarr, Jackett, Portainer)
  • Add network architecture overview
  • Add Kometa configuration summary
  • Use modern docker compose syntax (no hyphen)
  • Note required Tracearr secrets (DB_PASSWORD, JWT_SECRET, COOKIE_SECRET) in Getting Started

Test plan

  • Verify all links render correctly on GitHub
  • Verify port numbers match docker-compose.yml
  • Verify service descriptions are accurate

🤖 Generated with Claude Code

- Add prerequisites section (Docker, Plex claim token, VPN)
- Replace flat component list with categorized tables including ports
- Add "Not included but recommended" section for services not in docker-compose
- Add network architecture section
- Add Kometa configuration overview
- Use modern `docker compose` syntax (no hyphen)
- Note required Tracearr secrets in Getting Started

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 1, 2026

Warning

Rate limit exceeded

@joshdev8 has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 27 minutes and 19 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 27 minutes and 19 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: eca828d5-fe22-46f0-af48-8b867a67ce13

📥 Commits

Reviewing files that changed from the base of the PR and between b7c9a30 and 30d5588.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/update-readme

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

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

@joshdev8 joshdev8 merged commit 20ad20a into main Apr 1, 2026
3 checks passed
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.

1 participant