Skip to content

docs: document built-in env variables and encryption#146

Merged
Leechael merged 1 commit intomainfrom
docs/environment-variables
Mar 2, 2026
Merged

docs: document built-in env variables and encryption#146
Leechael merged 1 commit intomainfrom
docs/environment-variables

Conversation

@Leechael
Copy link
Contributor

@Leechael Leechael commented Mar 2, 2026

Summary

  • Rewrite the "Secure Environment Variables" page → "Environment Variables" with two sections: Encrypted Secrets and Built-in Environment Variables
  • Add client-side encryption explanation (X25519 + AES-256-GCM, server never sees plaintext)
  • Document full-replacement update semantics (cannot update a single variable)
  • Document all built-in variables injected by the default pre-launch script: private registry auth (DSTACK_DOCKER_*), AWS ECR auth (DSTACK_AWS_*), root access (DSTACK_ROOT_*, DSTACK_AUTHORIZED_KEYS), and app metadata (DSTACK_APP_*)
  • Clarify that built-in variables depend on the default pre-launch script and won't be available if replaced via --pre-launch-script

Test plan

  • Verify page renders correctly in Mintlify preview
  • Check all internal links resolve (--pre-launch-script CLI reference link)
  • Verify external link to dstack-examples repo is valid

Rewrite the secure environment variables page to cover:
- Client-side encryption (X25519 + AES-256-GCM) before server transmission
- Full-replacement update semantics for encrypted secrets
- Built-in variables injected by the default pre-launch script:
  private registry auth, AWS ECR, root access, and app metadata
- Link to pre-launch script source repo and CLI reference
@Leechael Leechael merged commit 767d2e1 into main Mar 2, 2026
4 checks passed
@Leechael Leechael deleted the docs/environment-variables branch March 2, 2026 17:25
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