Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add dynamic compose for homebox #6223

Merged

Conversation

Lancelot-Enguerrand
Copy link
Collaborator

@Lancelot-Enguerrand Lancelot-Enguerrand commented Jan 5, 2025

Dynamic compose for homebox

This is a homebox update for using dynamic compose. (no other change)

Situations tested :
  • 👶 Fresh install of the app
Reaching the app :
In App tests :
  • 📝 Register and create entries
  • 🌆 Uploading data
    • 🔄 Check data after restart
Volumes mapping verified :
  • ${APP_DATA_DIR}/data/homebox-data:/data/
Specific instructions verified :
  • 🌳 Environment (HBOX_LOG_LEVEL=info, HBOX_LOG_FORMAT=text, HBOX_WEB_MAX_UPLOAD_SIZE=10, HBOX_OPTIONS_ALLOW_REGISTRATION=${HBOX_OPTIONS_ALLOW_REGISTRATION})
  • 👤 User (1000:1000)

Summary by CodeRabbit

  • New Features

    • Added support for dynamic configuration in HomeBox application
    • Introduced new Docker Compose configuration for HomeBox service
  • Updates

    • Upgraded Tipi framework version to 22
    • Updated HomeBox service to version 0.16.0-rootless
    • Configured logging and upload settings for the service
  • Configuration

    • Added persistent data volume for HomeBox
    • Enabled configurable registration settings

Copy link
Contributor

github-actions bot commented Jan 5, 2025

Thank you for your contribution!

Unfortunately, we are no longer accepting pull requests from external collaborators due to the high volume of PRs we have to deal with daily.

We have reached a point in which it has become too complicated to validate, test and maintain this huge amount of apps resulting in a poor experience for our users.

We are working at the moment to implement a new feature to allow you to add multiple app stores to your Runtipi instance, so you can add your own apps without the need to send a PR to our repository.

This feature will be available very soon, so stay tuned! In the mean time, if you really need your app in Runtipi, you can add your own repository to your Runtipi instance relevant docs

Copy link
Contributor

coderabbitai bot commented Jan 5, 2025

Walkthrough

The pull request introduces configuration updates for the HomeBox application. A new Docker Compose configuration file has been added to define the service, specifying the Docker image, port, user settings, and environment variables. The application's configuration file has been updated with a new dynamic configuration flag, an incremented Tipi version, and an updated timestamp.

Changes

File Changes
apps/homebox/config.json - Added "dynamic_config": true
- Updated "tipi_version" from 21 to 22
- Updated "updated_at" timestamp
apps/homebox/docker-compose.json - New Docker Compose service configuration for HomeBox
- Image: ghcr.io/sysadminsmedia/homebox:0.16.0-rootless
- Internal port: 7745
- User ID/Group ID: 1000:1000
- Added environment variables for logging and upload settings
- Configured volume mapping for data persistence

Sequence Diagram

sequenceDiagram
    participant App as HomeBox Application
    participant Config as Configuration
    participant Volume as Data Volume

    Config->>App: Load dynamic configuration
    App->>Volume: Mount persistent data directory
    App->>App: Apply environment settings
    App->>App: Start service on port 7745
Loading

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7578179 and cf02f90.

📒 Files selected for processing (2)
  • apps/homebox/config.json (2 hunks)
  • apps/homebox/docker-compose.json (1 hunks)
🔇 Additional comments (4)
apps/homebox/docker-compose.json (2)

12-12: Clarify the upload size unit

The HBOX_WEB_MAX_UPLOAD_SIZE is set to "10" but the unit is not specified. Is this 10MB or 10GB? Consider adding a comment or updating the value to be explicit (e.g., "10G" or "10M").


1-23: Well-structured Docker Compose configuration!

The configuration follows best practices:

  • Uses rootless container image
  • Proper volume mapping for data persistence
  • Consistent environment variable naming
  • Correct user permissions (UID/GID: 1000)
apps/homebox/config.json (2)

7-9: Configuration updates look good!

The changes are well-structured and consistent:

  • Dynamic compose feature enabled
  • Version increment reflects the framework update
  • Timestamp properly updated

Also applies to: 31-31


7-7: Verify schema compatibility with dynamic_config

The addition of "dynamic_config": true aligns with the PR objective. However, let's verify this property is defined in the schema.

✅ Verification successful

The dynamic_config property is properly defined in the schema

The schema in apps/schema.json explicitly defines the dynamic_config property as a boolean type in its properties section, making the configuration change valid and compatible with the schema definition.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check if dynamic_config is defined in schema
jq -r 'if has("properties") and .properties | has("dynamic_config") then "Schema supports dynamic_config" else "dynamic_config not defined in schema" end' apps/schema.json

Length of output: 256


Script:

#!/bin/bash
# Let's first check if schema.json exists and see its content
fd schema.json --type f

# Check the content of any schema files
fd schema.json --type f --exec cat {}

Length of output: 7026


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
🪧 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.

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.

@nicotsx nicotsx merged commit 7cebad6 into runtipi:master Jan 5, 2025
14 checks passed
@Lancelot-Enguerrand Lancelot-Enguerrand deleted the dynamic-compose/homebox branch January 5, 2025 14:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants