Discover Overseerr integration

[joostlek]

Proposed Changes

Discover Overseerr integration

One thing we could consider is also fetching the api key from the integration using jq '.main.apiKey' /config/settings.json. Not sure if that would be acceptable, but it would improve the set up even more

Summary by CodeRabbit

• New Features
  • Added automatic discovery integration for Overseerr with Home Assistant, enabling the service to be detected and configured more easily.
• Chores
  • Updated configuration files to support the new discovery feature.

[coderabbitai]

Walkthrough

A new discovery mechanism for the Overseerr add-on was introduced by updating the configuration file and adding a new s6-rc one-shot service. The configuration file now includes a discovery key. The service consists of a script that waits for Overseerr to be available, then sends discovery information to Home Assistant using the bashio library. Supporting files were added to integrate this script into the s6 supervision system, ensuring it runs once during initialization.

Changes

File(s)	Change Summary
overseerr/config.yaml	Added a new top-level discovery key with overseerr entry to the configuration file.
overseerr/rootfs/etc/s6-overlay/s6-rc.d/discovery/run	New script added to send Overseerr discovery info to Home Assistant after waiting for service availability.
overseerr/rootfs/etc/s6-overlay/s6-rc.d/discovery/type	Added file specifying the service as oneshot for s6 supervision.
overseerr/rootfs/etc/s6-overlay/s6-rc.d/discovery/up	Added file referencing the run script to manage service lifecycle in s6.

Sequence Diagram(s)

sequenceDiagram
    participant S6 as s6-rc (init)
    participant Discovery as discovery/run script
    participant Overseerr as Overseerr Service
    participant HA as Home Assistant

    S6->>Discovery: Start oneshot discovery service
    Discovery->>Overseerr: Wait for port 5055 to be available
    Overseerr-->>Discovery: Service becomes available
    Discovery->>HA: Send discovery info (host, port) via bashio
    Discovery->>S6: Log success or failure, exit

Loading

Suggested labels

documentation

Poem

A bunny hops through configs anew,
Discovery scripts now join the crew!
Overseerr shouts, "I'm here, let's play!"
Home Assistant hears from far away.
With s6 in tow, the service runs once—
A hop, a skip, and then it's done!
🐇✨

---

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

🪧 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.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @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.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[joostlek]

Boop

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[joostlek]

Boop

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

overseerr/rootfs/etc/s6-overlay/s6-rc.d/discovery/run (1)

1-22: Discovery script implementation looks good with minor suggestions

The script correctly:

• Waits for the Overseerr service to be available
• Sends discovery information to Home Assistant
• Handles success and error cases

A few observations:

1. There's a typo in line 19: "send" should be "sent"

-    bashio::log.info "Successfully send discovery information to Home Assistant."
+    bashio::log.info "Successfully sent discovery information to Home Assistant."

2. The port value has a "^" prefix in line 15. Is this intentional for bashio formatting?

3. The PR description mentioned possibly fetching the API key from settings.json, but this isn't implemented here. Was this intentionally omitted?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between c295e75 and d67ad83.

📒 Files selected for processing (4)

• overseerr/config.yaml (1 hunks)
• overseerr/rootfs/etc/s6-overlay/s6-rc.d/discovery/run (1 hunks)
• overseerr/rootfs/etc/s6-overlay/s6-rc.d/discovery/type (1 hunks)
• overseerr/rootfs/etc/s6-overlay/s6-rc.d/discovery/up (1 hunks)

🔇 Additional comments (3)

overseerr/config.yaml (1)

18-19: Discovery configuration looks good!

The addition of the discovery key with overseerr as a value properly enables the Home Assistant discovery mechanism for this add-on, which aligns with the PR objective.

overseerr/rootfs/etc/s6-overlay/s6-rc.d/discovery/type (1)

1-1: Appropriate service type configuration

Setting this as a "oneshot" service is the correct approach for a discovery service that only needs to run once during container initialization.

overseerr/rootfs/etc/s6-overlay/s6-rc.d/discovery/up (1)

1-1: Proper s6 service execution path

The "up" file correctly references the run script, following standard s6-overlay service configuration patterns.

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.

[github-actions]

There hasn't been any activity on this pull request recently. This pull request has been automatically marked as stale because of that and will be closed if no further activity occurs within 7 days. Thank you for your contributions.