docs: add protocol configuration page - #57
Merged
Conversation
Documents the configuration surface of the core TLSNotary protocol crates: TlsClientConfig, VerifierConfig, ProveConfig, MpcTlsConfig (MPC mode) and ProxyTlsConfig (Proxy mode), plus sizing guidance and the online-vs-deferred decryption explanation.
Editorial pass over the protocol configuration page
heeckhau
force-pushed
the
docs/protocol-configuration
branch
from
May 19, 2026 09:23
bacdee5 to
8cd4e99
Compare
heeckhau
marked this pull request as ready for review
May 19, 2026 09:23
th4s
approved these changes
May 20, 2026
- Fix inaccurate claim that the session is rejected when max_recv_data_online != max_recv_data with defer_decryption_from_start=false (it actually aborts mid-stream at runtime). - Document ProverControl for toggling online decryption mid-session. - Tighten Network setting recommendation and minor prose cleanup.
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
2 participants
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.
Summary
TlsClientConfig,VerifierConfig,ProveConfig,MpcTlsConfig(MPC mode), andProxyTlsConfig(Proxy mode).sidebar_position: 7, after Server Identity Privacy.The page is structured so that mode-independent options come first, then the two mode-specific config sections side by side, reflecting the asymmetry between MPC (heavy preallocation) and Proxy (minimal).