public/docs
6
0
Fork 0
Code Issues Pull requests Activity

docs: clarify public environment values and HTTP protection #38

Closed
caution-bot wants to merge 2 commits from docs/quickstart-config-clarity into main
pull from: docs/quickstart-config-clarity
merge into: public:main
Conversation 1 Commits 2 Files changed 5 +67 -8
caution-bot commented 2026-10-02 18:55:43 +00:00 (Migrated from codeberg.org)
Copy link

Summary

  • Recommend literal unit.env values for public runtime configuration consistently across the key-service guide, HCL reference, and managed/BYOC quickstarts.

  • Distinguish runtime values from optional image-level /etc/environment defaults and public Docker build-time inputs; keep secrets on the Locksmith path.

  • Add an explicit host-TLS HTTP example and warning to the primary quickstart, with links to STEVE and Attested TLS requirements. Explain the raw-TCP generated default and the fact that verification alone does not make transport end-to-end encrypted.

  • Clarify that caution init creates a template when needed and link to STEVE’s documented public endpoint exceptions.

Test plan

  • make build-prod — passed; Zensical reported No issues found.
  • git diff --check — passed.
  • Read-only smoke check of the built caution-docs image (via docker run --rm caution-docs tar c -C /usr/share/nginx/html .) — all 48 internal page/anchor links across the five changed pages resolve; rendered protection warning and public-env guidance are present.
  • Parsed the new public-env and HTTP snippets with the current platform caution-config parser — passed; neither enables Locksmith.

Scope / integration

No runtime defaults, deployments, or infrastructure changes. This is intentionally separate from the broader key-service v2 rewrite in #37; preserve these public-env recommendations when integrating that rewrite. Homepage wording and generated-template comments are handled in companion repository PRs.

Companion PRs

## Summary - Recommend literal `unit.env` values for public runtime configuration consistently across the key-service guide, HCL reference, and managed/BYOC quickstarts. - Distinguish runtime values from optional image-level `/etc/environment` defaults and public Docker build-time inputs; keep secrets on the Locksmith path. - Add an explicit host-TLS HTTP example and warning to the primary quickstart, with links to STEVE and Attested TLS requirements. Explain the raw-TCP generated default and the fact that verification alone does not make transport end-to-end encrypted. - Clarify that `caution init` creates a template when needed and link to STEVE’s documented public endpoint exceptions. ## Test plan - `make build-prod` — passed; Zensical reported `No issues found`. - `git diff --check` — passed. - Read-only smoke check of the built `caution-docs` image (via `docker run --rm caution-docs tar c -C /usr/share/nginx/html .`) — all 48 internal page/anchor links across the five changed pages resolve; rendered protection warning and public-env guidance are present. - Parsed the new public-env and HTTP snippets with the current platform `caution-config` parser — passed; neither enables Locksmith. ## Scope / integration No runtime defaults, deployments, or infrastructure changes. This is intentionally separate from the broader key-service v2 rewrite in #37; preserve these public-env recommendations when integrating that rewrite. Homepage wording and generated-template comments are handled in companion repository PRs. ## Companion PRs - https://codeberg.org/caution/website/pulls/15 - https://codeberg.org/caution/platform/pulls/463
anton commented 2026-10-19 20:11:01 +00:00
Owner
Copy link

Superseded by #43, the unified release documentation update. It consolidates this proposal with the other open docs updates and corrects the combined guidance against platform main 2dd613e3.

Closing this PR to keep one review/release path. The original branch is retained; the replacement is not merged.

Superseded by #43, the unified release documentation update. It consolidates this proposal with the other open docs updates and corrects the combined guidance against platform main `2dd613e3`. Closing this PR to keep one review/release path. The original branch is retained; the replacement is not merged.
anton closed this pull request 2026-10-19 20:11:02 +00:00

Pull request closed

Please reopen this pull request to perform a merge.
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
public/docs!38
No description provided.