docs: add quickstart guides and end-to-end automation guide#6024
docs: add quickstart guides and end-to-end automation guide#6024LewisDwyer wants to merge 1 commit intoInfisical:mainfrom
Conversation
Add three new documentation pages: - **5-Minute Quickstart** (getting-started/quickstart) — Cloud-focused guide: create account, store a secret, retrieve it with the CLI. Covers `infisical run`, `infisical export`, bulk `.env` import via CLI, and `gitBranchToEnvironmentMapping` config. - **Self-Hosted Quickstart** (getting-started/self-hosted-quickstart) — Docker Compose setup, `infisical bootstrap` for non-interactive admin creation, first secret retrieval. Cross-links to the Cloud quickstart for CLI installation and to the automation guide for scripted flows. - **End-to-End Automation** (self-hosting/guides/end-to-end-automation) — fully scripted flow from empty instance to running application: bootstrap, project creation via API, bulk secret import with `infisical secrets set --file`, manual `.infisical.json`, and `infisical run`. Includes gotchas for Docker networking, HTTPS cookies, readiness timing, and idempotency. All commands verified against existing CLI and API reference docs. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
✅ 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. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c3693be839
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
|
|
||
| ```bash | ||
| cd /path/to/your/project | ||
| infisical init |
There was a problem hiding this comment.
After logging in with --domain, the guide immediately calls infisical init/infisical run without a domain override or INFISICAL_API_URL. Our own CLI docs explicitly warn that non-US/self-hosted usage must set domain for all commands (docs/cli/commands/login.mdx warns this at lines 545-547; docs/cli/usage.mdx lines 137-143), otherwise commands default to US Cloud and can fail with auth/project lookup errors on localhost.
Useful? React with 👍 / 👎.
| infisical secrets set \ | ||
| --projectId="$PROJECT_ID" \ | ||
| --env=dev \ | ||
| --file=".env" |
There was a problem hiding this comment.
The automation script bootstraps against $DOMAIN, but later infisical secrets set/infisical run are executed without --domain (and INFISICAL_API_URL is never exported). Per the CLI domain guidance (docs/cli/usage.mdx lines 137-143), these commands default to US Cloud, so the documented end-to-end self-hosted flow can break when it tries to use a self-hosted machine token against the wrong API host.
Useful? React with 👍 / 👎.
2 participants
Context
Infisical has extensive reference docs but no quickstart
guide that takes a new user from zero to retrieving
their first secret. These three guides fill that gap:
getting-started/quickstart)— Cloud path: create account, store a secret, retrieve
it with the CLI.
(
getting-started/self-hosted-quickstart) — DockerCompose setup with
infisical bootstrapfornon-interactive admin creation.
(
self-hosting/guides/end-to-end-automation) — Fullyscripted flow from empty self-hosted instance to running
application, chaining bootstrap, API project creation,
bulk secret import, and
infisical run.All commands verified against existing CLI and API
reference docs. Sidebar entries added to
docs.json.Screenshots
Not applicable — docs-only change, no UI modifications.
Steps to verify the change
mintlify devfrom thedocs/directory)pages should appear between Introduction and Concepts
Automation should appear after Automated Bootstrapping
Type
Checklist
w.conventionalcommits.org/en/v1.0.0/#summary) format:
type(scope): short descriptionm/docs/contributing/getting-started/overview)