docs: fix signature header template escaping, merge template field tables - #1024
Open
alexluong wants to merge 2 commits into
Open
docs: fix signature header template escaping, merge template field tables#1024alexluong wants to merge 2 commits into
alexluong wants to merge 2 commits into
Conversation
…bles The documented header template value carried shell/JSON escaping (`\"`) inline. Copied into a .env file, a Compose `environment:` entry, or a plain YAML scalar — none of which unescape — Go's template parser rejects the backslash and Outpost refuses to start. Give the template value once, unescaped, and treat quoting as a property of the transport: shell/JSON examples keep `\"`, with .env/Compose and YAML variants alongside. Same in the v0.12 upgrade guide. Also merge the content-template and header-template field lists into one table with per-template columns, so the exclusivity of `.Body` and `.Signatures` is structural rather than inferred from two lists. Closes #1023 Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The transport-matrix sentence claimed .env files pass backslashes through literally. Most .env readers (godotenv, Compose env_file) unescape double-quoted values, so the claim was wrong for Outpost's own config loading; only docker run --env-file is fully literal. Rather than correcting the matrix, drop it: the values are stated once as literals, escaping belongs to whatever format carries them, and the per-context examples show the right form for each. Failure wording updated to the startup rejection introduced by the signature-validation fix. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #1023
The documented header template value carried shell/JSON escaping (
\") inline. Copied into a.envfile, a Composeenvironment:entry, or a plain YAML scalar — none of which unescape — Go's template parser rejects the backslash and Outpost refuses to start.\", with.env/Compose and YAML variants alongside. Same in the v0.12 upgrade guide..Bodyand.Signaturesis structural instead of inferred from comparing two lists.Verified against
internal/destregistry/providers/destwebhook/signature.go:SignaturePayloadandHeaderPayloadare distinct structs, and a cross-used field passesParsebut failsExecuteat delivery time — so the doc says "every delivery that renders it fails", not "invalid config".Docs only, no code changes.
🤖 Generated with Claude Code