Skip to content

docs(eng-5200): document domain in .infisical.json and INFISICAL_DOMAIN#6797

Merged
PrestigePvP merged 2 commits into
mainfrom
tre/eng-5200-document-domain-config
Jun 10, 2026
Merged

docs(eng-5200): document domain in .infisical.json and INFISICAL_DOMAIN#6797
PrestigePvP merged 2 commits into
mainfrom
tre/eng-5200-document-domain-config

Conversation

@PrestigePvP

Copy link
Copy Markdown
Contributor

Documents the CLI domain configuration added in Infisical/cli#256.

  • docs/cli/project-config.mdx — new "Set the Infisical instance domain" section covering the domain field, full precedence (--domain > INFISICAL_DOMAIN > .infisical.json domain > default), the http(s) validation, and a trust warning since the file is usually committed
  • docs/cli/usage.mdx — recommend INFISICAL_DOMAIN over the now-legacy INFISICAL_API_URL (still honored), add a .infisical.json tab, and document precedence; updated the self-hosting FAQ to match

Companion to the CLI PR Infisical/cli#256 (ENG-5200). Version-history notes referencing INFISICAL_API_URL for pre-v0.4.0 are left as-is since they describe older releases.

@linear

linear Bot commented Jun 10, 2026

Copy link
Copy Markdown

ENG-5200

@infisical-review-police

Copy link
Copy Markdown

💬 Discussion in Slack: #pr-review-infisical-6797-docs-eng-5200-document-domain-in-infisical-json-and-inf

Posted by Review Police — reviews, comments, new commits, and CI failures will stream into this channel.

@PrestigePvP PrestigePvP requested a review from akhilmhdh June 10, 2026 14:29
@greptile-apps

greptile-apps Bot commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

This PR documents the domain configuration field for the Infisical CLI, covering the .infisical.json domain field and INFISICAL_DOMAIN environment variable as replacements for the now-legacy INFISICAL_API_URL.

  • docs/cli/project-config.mdx gains a new "Set the Infisical instance domain" section with a JSON example, a four-level precedence list, and a <Warning> about the supply-chain trust risk of committing a domain value.
  • docs/cli/usage.mdx replaces all INFISICAL_API_URL references with INFISICAL_DOMAIN, adds a .infisical.json tab alongside the existing environment-variable and --domain tabs, and updates the self-hosting FAQ accordingly.

Confidence Score: 4/5

Documentation-only change with accurate content; safe to merge with minor wording improvements.

The changes correctly document the new domain configuration feature. Two small gaps exist: the relative precedence between INFISICAL_DOMAIN and INFISICAL_API_URL when both are set is never stated, and the acceptance of http:// URLs for a secrets manager carries in-transit credential exposure risk that the existing warning doesn't mention. Neither blocks the PR from being merged, but the http:// omission in the warning text is worth addressing before publishing.

docs/cli/project-config.mdx — precedence ambiguity and the http:// guidance gap both live in the new section added here.

Important Files Changed

Filename Overview
docs/cli/project-config.mdx Adds a new "Set the Infisical instance domain" section with JSON example, precedence list, and a supply-chain warning; precedence of INFISICAL_API_URL relative to INFISICAL_DOMAIN is not specified, and the acceptance of http:// URLs for a secrets manager is undercommunicated.
docs/cli/usage.mdx Replaces INFISICAL_API_URL with INFISICAL_DOMAIN throughout, adds a .infisical.json tab, updates the self-hosting FAQ, and clarifies precedence; changes are consistent and accurate.

Reviews (1): Last reviewed commit: "docs(eng-5200): document domain in .infi..." | Re-trigger Greptile

Comment thread docs/cli/project-config.mdx Outdated
Comment thread docs/cli/project-config.mdx Outdated
@mintlify

mintlify Bot commented Jun 10, 2026

Copy link
Copy Markdown

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
infisical 🟡 Building Jun 10, 2026, 2:28 PM

💡 Tip: Enable Workflows to automatically generate PRs for you.

- Add a `domain` field section to the project config doc, with precedence and a trust warning
- Update CLI usage doc to recommend INFISICAL_DOMAIN (legacy INFISICAL_API_URL still honored) and add the .infisical.json option
- State INFISICAL_DOMAIN wins over legacy INFISICAL_API_URL when both are set
- Recommend https and warn that http sends secrets/credentials in plaintext
@PrestigePvP PrestigePvP merged commit e7549b1 into main Jun 10, 2026
9 checks passed
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.

2 participants