aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorLoïc Hoguin <[email protected]>2023-12-05 12:33:13 +0100
committerLoïc Hoguin <[email protected]>2023-12-05 12:33:13 +0100
commitcb75e10c99af8c5654d94b9dcae2f8c7879b4f87 (patch)
treec362cd4e541fe65b292992bcaa00a6c6090970ba /doc
parentbe7a7f46394443ed140ccdb1e9d0c0811ad64aa5 (diff)
downloadranch-cb75e10c99af8c5654d94b9dcae2f8c7879b4f87.tar.gz
ranch-cb75e10c99af8c5654d94b9dcae2f8c7879b4f87.tar.bz2
ranch-cb75e10c99af8c5654d94b9dcae2f8c7879b4f87.zip
Add support for the UNIQUE_ID proxy protocol header TLV
Diffstat (limited to 'doc')
-rw-r--r--doc/src/manual/ranch_proxy_header.asciidoc6
1 files changed, 6 insertions, 0 deletions
diff --git a/doc/src/manual/ranch_proxy_header.asciidoc b/doc/src/manual/ranch_proxy_header.asciidoc
index c194d98..c4ef150 100644
--- a/doc/src/manual/ranch_proxy_header.asciidoc
+++ b/doc/src/manual/ranch_proxy_header.asciidoc
@@ -37,6 +37,7 @@ proxy_info() = #{
%% Extra TLV-encoded data.
alpn => binary(), %% US-ASCII.
authority => binary(), %% UTF-8.
+ unique_id => binary(), %% Opaque byte sequence of up to 128 bytes.
netns => binary(), %% US-ASCII.
ssl => #{
client := [ssl | cert_conn | cert_sess],
@@ -105,6 +106,10 @@ authority::
The host name serving as authority for the connection.
This is typically passed using the SNI extension for TLS.
+unique_id::
+An opaque byte sequence of up to 128 bytes generated
+by the upstream proxy that uniquely identifies the connection.
+
netns::
The namespace's name for the original connection.
@@ -158,6 +163,7 @@ The non-standard TLVs that Ranch was not able to parse.
== Changelog
+* *2.2*: The `unique_id` TLV was added.
* *1.7*: Module introduced.
== See also