Repository navigation
docs: README in the shared Zentinel format - #5
Merged
Merged
Conversation
Corrected claims (checked end to end with zentinel 0.6.50 and the agent built from main):
- URL rewriting does not rewrite the path; the result only goes upstream as an X-Original-Path header
- JSON body operations, convert, clear and replace are computed and discarded; body matching only runs in that phase
- Method override, status override and templates are not applied
- Response-only rules never fire (response phase needs a matched request rule)
- Header matcher key is `matches`, not `pattern` (the old key silently became a presence check)
- Body matcher is `body: {json: [...]}`, response matcher keys are `status_codes`/`content_types`, not `status`/`content_type`
- Header `add` overwrites like `set`; glob `*` also matches `/`; default path type is regex, default priority 50
- --socket is unreleased (main only); release 0.4.0 is gRPC-only, so the quick start uses gRPC
- Proxy KDL used `unix-socket path=` and had no filter; replaced with a validated agents/filters config
- No licence badge: the repository has no LICENSE file
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
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.
Rewrites the README to the org-wide standard in zentinelproxy/design#2 (
readme/STANDARD.md): the shared lockup header, flat badges in the brand colors, the standard section order and footer. Commands, config keys, features and links were checked against the code; the quick-start KDL passeszentinel test.Corrections:
Corrected claims (checked end to end with zentinel 0.6.50 and the agent built from main):
matches, notpattern(the old key silently became a presence check)body: {json: [...]}, response matcher keys arestatus_codes/content_types, notstatus/content_typeaddoverwrites likeset; glob*also matches/; default path type is regex, default priority 50unix-socket path=and had no filter; replaced with a validated agents/filters config