aboutsummaryrefslogtreecommitdiff
path: root/spec/pt-spec
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2023-10-14 18:52:20 -0400
committerNick Mathewson <nickm@torproject.org>2023-10-14 18:53:18 -0400
commit3457b0720834c8347d8318c1080ebc9486d77300 (patch)
treeb486a3d03fdfae7d98c4e6cf510179cf907c443f /spec/pt-spec
parenta331e9f48790ad4beaba1ee443c5ad8b13d3afb4 (diff)
downloadtorspec-3457b0720834c8347d8318c1080ebc9486d77300.tar.gz
torspec-3457b0720834c8347d8318c1080ebc9486d77300.zip
Add short IDs for most long section names
I've left off sections that are headings for their whole document.
Diffstat (limited to 'spec/pt-spec')
-rw-r--r--spec/pt-spec/configuration-environment.md8
-rw-r--r--spec/pt-spec/ipc.md8
2 files changed, 8 insertions, 8 deletions
diff --git a/spec/pt-spec/configuration-environment.md b/spec/pt-spec/configuration-environment.md
index 79e9f67..767c37b 100644
--- a/spec/pt-spec/configuration-environment.md
+++ b/spec/pt-spec/configuration-environment.md
@@ -1,6 +1,6 @@
<a id="pt-spec.txt-3.2"></a>
-## Pluggable Transport Configuration Environment Variables
+## Pluggable Transport Configuration Environment Variables {#envvars}
All Pluggable Transport proxy instances are configured by their
parent process at launch time via a set of well defined
@@ -12,7 +12,7 @@ specification.
<a id="pt-spec.txt-3.2.1"></a>
-### Common Environment Variables
+### Common Environment Variables {#common}
When launching either a client or server Pluggable Transport proxy,
the following common environment variables MUST be set.
@@ -102,7 +102,7 @@ TOR_PT_OUTBOUND_BIND_ADDRESS_V6=\[2001:db8::4\]
<a id="pt-spec.txt-3.2.2"></a>
-### Pluggable Transport Client Environment Variables
+### Pluggable Transport Client Environment Variables {#client}
Client-side Pluggable Transport forward proxies are configured
via the following environment variables.
@@ -143,7 +143,7 @@ Examples:
<a id="pt-spec.txt-3.2.3"></a>
-### Pluggable Transport Server Environment Variables
+### Pluggable Transport Server Environment Variables {#server}
Server-side Pluggable Transport reverse proxies are configured
via the following environment variables.
diff --git a/spec/pt-spec/ipc.md b/spec/pt-spec/ipc.md
index 21fd18b..8c5d001 100644
--- a/spec/pt-spec/ipc.md
+++ b/spec/pt-spec/ipc.md
@@ -96,7 +96,7 @@ ENV-ERROR No TOR_PT_AUTH_COOKIE_FILE when TOR_PT_EXTENDED_SERVER_PORT set
<a id="pt-spec.txt-3.3.2"></a>
-### Pluggable Transport Client Messages
+### Pluggable Transport Client Messages {#client-messages}
After negotiating the Pluggable Transport Specification version,
PT client proxies MUST first validate "TOR_PT_PROXY" (3.2.2) if
@@ -178,7 +178,7 @@ Notes:
<a id="pt-spec.txt-3.3.3"></a>
-### Pluggable Transport Server Messages
+### Pluggable Transport Server Messages {#server-messages}
PT server reverse proxies iterate over the requested transports
in "TOR_PT_CLIENT_TRANSPORTS" and initialize the listeners.
@@ -245,7 +245,7 @@ initialization is complete.
<a id="pt-spec.txt-3.3.4"></a>
-### Pluggable Transport Log Message
+### Pluggable Transport Log Message {#log-messages}
This message is for a client or server PT to be able to signal back to the
parent process via stdout or stderr any log messages.
@@ -276,7 +276,7 @@ Example:
<a id="pt-spec.txt-3.3.5"></a>
-### Pluggable Transport Status Message
+### Pluggable Transport Status Message {#status-messages}
This message is for a client or server PT to be able to signal back to the
parent process via stdout or stderr any status messages.