Skip to content

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
devin/1770326286-gateway-cli-coexist-docs
Open

docs: warn self-hosted users about infisical-core/CLI package conflict in gateway and relay docs#5385
devin-ai-integration[bot] wants to merge 1 commit intomainfrom
devin/1770326286-gateway-cli-coexist-docs

Conversation

@devin-ai-integration
Copy link
Contributor

Context

When a self-hosted Infisical instance is deployed using the infisical-core Linux package, attempting to install the infisical CLI package (needed for gateway/relay) via apt-get silently removes infisical-core due to a package-level conflict:

sudo apt-get update && sudo apt-get install -y infisical
The following packages will be REMOVED:
  infisical-core
The following NEW packages will be installed:
  infisical

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:

  • A <Warning> in the gateway deployment "Install the Infisical CLI" step about the conflict, with alternative install methods (NPM, separate machine).
  • A new "Install the Infisical CLI" step in the relay deployment guide (which was previously missing) with the same warning.
  • A new FAQ entry in the gateway docs: "Can I run the gateway on the same machine as my self-hosted Infisical server?"

Note: This does not fix the underlying package conflict between infisical and infisical-core — that would require changes to the CLI package build (which lives outside this repo). This PR only addresses the documentation gap.

Steps to verify the change

  1. Review the rendered MDX for 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.
  2. Review the rendered MDX for 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.
  3. Verify that npm install -g @infisical/cli is a valid alternative that produces a working CLI binary equivalent to the apt package.

Type

  • Fix
  • Feature
  • Improvement
  • Breaking
  • Docs
  • Chore

Checklist

Review focus areas

  • Is npm install -g @infisical/cli a reliable workaround? The NPM install method is suggested as the primary alternative — please confirm it produces a fully functional CLI (including gateway and relay subcommands).
  • Relay docs step ordering — a new step was inserted; verify the flow still reads naturally.
  • Should the underlying package conflict be fixed? The infisical CLI deb package appears to declare a conflict with infisical-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

…t in gateway and relay deployment guides

Co-Authored-By: arsh@infisical.com <arshsb1998@gmail.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@greptile-apps
Copy link
Contributor

greptile-apps bot commented Feb 5, 2026

Greptile Overview

Greptile Summary

This PR adds critical documentation warnings about a package conflict between infisical-core (self-hosted server) and the infisical CLI package when installing via apt/yum. The changes include:

  • Warning block in gateway deployment docs explaining the conflict and suggesting NPM installation or separate machines as workarounds
  • New "Install the Infisical CLI" step in relay deployment docs (previously missing) with the same warning
  • New FAQ entry explaining the conflict and recommended solutions

The documentation changes are well-structured, consistently formatted, and provide clear guidance for self-hosted users. The NPM installation workaround (npm install -g @infisical/cli) is a legitimate alternative documented in the CLI installation guide.

Confidence Score: 5/5

  • This PR is safe to merge with no risk - it only adds documentation warnings about an existing package conflict
  • This is a documentation-only change that adds helpful warnings to prevent users from accidentally removing their self-hosted server. No code changes, no breaking changes, and the suggested workarounds are verified to be legitimate installation methods
  • No files require special attention

Important Files Changed

Filename Overview
docs/documentation/platform/gateways/gateway-deployment.mdx Added warning about infisical-core/CLI package conflict and FAQ entry explaining the issue with workaround solutions
docs/documentation/platform/gateways/relay-deployment/overview.mdx Added new CLI installation step with warning about package conflict, inserted before deployment method selection

@maidul98
Copy link
Collaborator

maidul98 commented Feb 5, 2026

Snyk checks have passed. No issues have been found so far.

Status Scanner Critical High Medium Low Total (0)
Open Source Security 0 0 0 0 0 issues

💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant