docs: warn self-hosted users about infisical-core/CLI package conflict in gateway and relay docs#5385
Open
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
Open
Conversation
…t in gateway and relay deployment guides Co-Authored-By: arsh@infisical.com <arshsb1998@gmail.com>
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
Contributor
Greptile OverviewGreptile SummaryThis PR adds critical documentation warnings about a package conflict between
The documentation changes are well-structured, consistently formatted, and provide clear guidance for self-hosted users. The NPM installation workaround ( Confidence Score: 5/5
Important Files Changed
|
Collaborator
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
When a self-hosted Infisical instance is deployed using the
infisical-coreLinux package, attempting to install theinfisicalCLI package (needed for gateway/relay) viaapt-getsilently removesinfisical-coredue to a package-level conflict:This is particularly problematic for self-hosted users who want to run a gateway or relay on the same machine as their Infisical server — the docs currently direct them to install the CLI via apt without any warning.
This PR adds:
<Warning>in the gateway deployment "Install the Infisical CLI" step about the conflict, with alternative install methods (NPM, separate machine).Steps to verify the change
docs/documentation/platform/gateways/gateway-deployment.mdx— confirm the Warning block renders inside the "Install the Infisical CLI" step and the new FAQ accordion appears.docs/documentation/platform/gateways/relay-deployment/overview.mdx— confirm the new "Install the Infisical CLI" step appears before "Select a Deployment Method" with the Warning block.npm install -g @infisical/cliis a valid alternative that produces a working CLI binary equivalent to the apt package.Type
Checklist
Review focus areas
npm install -g @infisical/clia reliable workaround? The NPM install method is suggested as the primary alternative — please confirm it produces a fully functional CLI (includinggatewayandrelaysubcommands).infisicalCLI deb package appears to declare a conflict withinfisical-core. A separate effort to update the CLI packaging to allow coexistence would be the proper long-term fix.Link to Devin run: https://app.devin.ai/sessions/4b7a943d803a457d9c272c701822d1a9
Requested by: @0xArshdeep