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 getashell #6112

Conversation

Lancelot-Enguerrand
Copy link
Collaborator

@Lancelot-Enguerrand Lancelot-Enguerrand commented Dec 23, 2024

Dynamic compose for getashell

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

Situation tested :
  • 👶 Fresh install of the app
Reaching the app :
In app tests :
  • 📝 Register and log in
  • 🐚 Create a shell
  • 🐢 SSH into it
    • 🔄 Check data after restart
Volumes mapping verified :
  • ${APP_DATA_DIR}/data/:/app/data
  • /var/run/docker.sock:/var/run/docker.sock:ro
Specific instructions verified :
  • 🌳 Environment

Summary by CodeRabbit

  • New Features

    • Introduced dynamic configuration capabilities for the "Get A Shell" application.
    • Updated versioning to reflect the latest changes.
    • Added a new Docker Compose configuration for the getashell service, including environment variable support and volume mappings.
  • Bug Fixes

    • Updated timestamps to reflect the most recent configuration changes.

Copy link
Contributor

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

@github-actions github-actions bot closed this Dec 23, 2024
Copy link
Contributor

coderabbitai bot commented Dec 23, 2024

Warning

Rate limit exceeded

@Lancelot-Enguerrand has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 18 minutes and 24 seconds before requesting another review.

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

📥 Commits

Reviewing files that changed from the base of the PR and between ef74735 and ded37d0.

📒 Files selected for processing (2)
  • apps/getashell/config.json (2 hunks)
  • apps/getashell/docker-compose.json (1 hunks)

Walkthrough

The pull request introduces configuration updates for the "Get A Shell" application. The configuration file config.json has been modified with a new dynamic configuration flag, an incremented Tipi version, and an updated timestamp. Additionally, a new docker-compose.json file has been added to define the Docker service configuration for the application, specifying image, ports, environment variables, and volume mappings.

Changes

File Change Summary
apps/getashell/config.json - Added "dynamic_config": true
- Updated "tipi_version" from 12 to 13
- Updated "updated_at" timestamp
apps/getashell/docker-compose.json - New Docker Compose configuration
- Service name: getashell
- Image: ghcr.io/steveiliop56/getashell:v1.1.3
- Internal port: 3000
- Environment variables and volume mappings added

Sequence Diagram

sequenceDiagram
    participant User
    participant DockerCompose
    participant GetAShellService
    
    User->>DockerCompose: Deploy application
    DockerCompose->>GetAShellService: Start service with config
    GetAShellService-->>DockerCompose: Initialize with env vars
    GetAShellService-->>User: Service ready
Loading

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.

Copy link
Contributor

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

@github-actions github-actions bot closed this Dec 23, 2024
@Lancelot-Enguerrand Lancelot-Enguerrand merged commit 025b7cd into runtipi:master Dec 23, 2024
12 checks passed
@Lancelot-Enguerrand Lancelot-Enguerrand deleted the dynamic-compose/getashell branch December 23, 2024 21:13
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.

1 participant