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 ingress #322

Closed
wants to merge 1 commit into from
Closed

Add ingress #322

wants to merge 1 commit into from

Conversation

adamoutler
Copy link

@adamoutler adamoutler commented Oct 7, 2024

Proposed Changes

I opened the addon for the first time and wanted to try it. I'm checking alternative password managers. It cannot be done from HA without setting up certificates for the initial login. Establishing Ingress let me create an account so that I could try the addon.

Related Issues

N/A

Summary by CodeRabbit

  • New Features
    • Enhanced configuration for Vaultwarden with new ingress settings for improved network access.
      • Ingress enabled by default.
      • Specified port for ingress traffic set to 7277.
      • Support for streaming over ingress is now available.

Copy link

coderabbitai bot commented Oct 7, 2024

Walkthrough

The configuration file for Vaultwarden (Bitwarden) has been updated to include new ingress-related settings. The additions consist of enabling ingress, specifying the ingress port as 7277, and supporting streaming over ingress. The existing configuration structure remains unchanged, with other parameters intact.

Changes

File Change Summary
bitwarden/config.yaml Added ingress: true, ingress_port: 7277, and ingress_stream: true fields.

Poem

In the garden of code, where the rabbits play,
New paths of ingress have come out to stay.
With ports set to seven-two-seven-seven,
Our service now dances, a leap towards heaven.
Hopping through settings, so spry and so bright,
Vaultwarden's new features bring joy to the night! 🐇✨


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

@adamoutler
Copy link
Author

Looks like job failed because I can't add enhancement label

@frenck
Copy link
Member

frenck commented Oct 7, 2024

We cannot add ingress to this add-on, as it requires the use of SSL, which cannot be enforced via this route.

Nevertheless, thanks for being willing to contribute 👍

../Frenck

@frenck frenck closed this Oct 7, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (2)
bitwarden/config.yaml (2)

14-16: LGTM! Consider adding a comment for clarity.

The addition of ingress configuration looks good and aligns well with the PR objectives. The ingress port (7277) matches the existing Web interface port, which is great for consistency.

Consider adding a brief comment above these new lines to explain the purpose of ingress for future maintainers. For example:

# Enable ingress for easier initial setup and access
ingress: true
ingress_port: 7277
ingress_stream: true

Update the addon's documentation to include ingress configuration

The ingress settings have been successfully added to bitwarden/config.yaml. However, there are no mentions of ingress in the documentation. Please update the addon's documentation or README to reflect the new ingress functionality and provide guidance on its usage.

🔗 Analysis chain

Line range hint 1-37: Verify documentation and code changes for ingress support

The ingress configuration has been added successfully and is consistent with the existing settings. To ensure a smooth integration, please consider the following:

  1. Update the addon's documentation or README to reflect the new ingress functionality and how users can benefit from it.
  2. Verify if any changes are needed in the addon's code to fully support ingress. This might include adjusting internal routing or handling ingress-specific requests.

To help with the verification process, you can run the following script to check for any mentions of ingress in the addon's documentation and code:

This script will help identify areas where documentation updates or code adjustments might be necessary to fully support the new ingress functionality.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for ingress-related content in documentation and code

# Search for ingress mentions in markdown files (documentation)
echo "Searching for ingress mentions in documentation:"
rg --type md 'ingress' -C 2

echo -e "\nSearching for ingress-related code:"
# Search for ingress-related code in Python files
rg --type python '(ingress|request\.headers\.get\(["'']X-Ingress-Path["''])' -C 2

# Search for ingress-related code in JavaScript files
rg --type js '(ingress|window\.ingress)' -C 2

Length of output: 529


Script:

#!/bin/bash
# Description: Corrected search for ingress-related content in documentation and code

echo "Searching for ingress mentions in markdown files:"
rg --type markdown 'ingress' -C 2

echo -e "\nSearching for ingress-related code in Python files:"
rg --type py '(ingress|request\.headers\.get\(["'']X-Ingress-Path["''])' -C 2

echo -e "\nSearching for ingress-related code in JavaScript files:"
rg --type js '(ingress|window\.ingress)' -C 2

echo -e "\nSearching for ingress-related code in YAML files:"
rg --type yaml 'ingress' -C 2

Length of output: 1207

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1934e98 and 50ca002.

📒 Files selected for processing (1)
  • bitwarden/config.yaml (1 hunks)
🧰 Additional context used

@adamoutler
Copy link
Author

Wouldn't it be the same experience with or without ingress? Or is there some conditions I'm not understanding?

@github-actions github-actions bot locked and limited conversation to collaborators Oct 11, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants