docs: add installer environment variables documentation#2114
Conversation
- Create docs/guide/installer-env-vars.md documenting env vars used by installers (vp-setup.exe, install.ps1, install.sh) - Add links from Getting Started, Environment, Install, Docker, and Upgrade - Cover install vars (VP_VERSION, VP_HOME, NPM_CONFIG_REGISTRY, VP_NODE_MANAGER, VP_PR_VERSION, etc.) - Cover runtime vars (VP_HOME, VP_NODE_DIST_MIRROR, VP_NODE_VERSION, VP_DEBUG_SHIM, etc.) - Cover TLS/CA config (SSL_CERT_FILE, NODE_EXTRA_CA_CERTS, VP_INSECURE_TLS) - Cover logging/debug vars (VITE_LOG, VITE_UPDATE_TASK_TYPES, etc.) - Document standard vars (CI, NO_COLOR, HOME) and precedence rules Closes voidzero-dev#1957
✅ Deploy Preview for viteplus-preview ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![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: 5719297066
ℹ️ About Codex in GitHub
Your team has set up Codex to 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 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
Got it, thanks for clarifying. I removed those extra hint/tip additions from unrelated pages and kept the changes focused on the new installer environment variables document. |
|
Thanks for letting me be a part of it, it was an awesome experience, thank you all |
|
@yukinoshi why close it? |
|
@yukinoshi can you fix the doc format check erros? Thanks. |
Clicked it by accident |
ok |
|
@fengmk2 Done. The formatting issue was caused by my outdated branch and should be fixed now. Could you please check it again? Thanks! |
|
@yukinoshi let me fix format issue before I merge. |
- Fix trailing whitespace in docker.md (vp fmt --check failure) - Merge the duplicate VP_HOME entries into one - Link the canonical sections for VP_PR_VERSION, VP_NODE_DIST_MIRROR, and VP_NODE_SKIP_SIGNATURE_VERIFY instead of restating them - Drop VITE_UPDATE_TASK_TYPES (test-time codegen switch; the documented vp update command does not exist), VP_TRAMPOLINE_PATH (test-only), VP_ENV_USE_EVAL_ENABLE and VITE_GLOBAL_CLI_JS_SCRIPTS_DIR (internal/dev) - Compress the internal-variable lists and dev-only installer vars to short notes; merge SSL_CERT_FILE / NODE_EXTRA_CA_CERTS - Register the page in the sidebar next to Environment and replace the Getting Started info box with a plain sentence
2 participants
Closes #1957