diff options
Diffstat (limited to 'spec/pt-spec/pluggable-transport-configuration-environment.md')
| -rw-r--r-- | spec/pt-spec/pluggable-transport-configuration-environment.md | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/spec/pt-spec/pluggable-transport-configuration-environment.md b/spec/pt-spec/pluggable-transport-configuration-environment.md index 61b6b01..3a201f8 100644 --- a/spec/pt-spec/pluggable-transport-configuration-environment.md +++ b/spec/pt-spec/pluggable-transport-configuration-environment.md @@ -124,7 +124,7 @@ Specifies an upstream proxy that the PT MUST use when making outgoing network connections. It is a URI [RFC3986] of the format: -<proxy_type>://[<user_name>[:<password>][@]<ip>:<port>. +`<proxy_type>://[<user_name>[:<password>][@]<ip>:<port>`. The "TOR_PT_PROXY" environment variable is OPTIONAL and MUST be omitted if there is no need to connect via an @@ -161,8 +161,8 @@ TOR_PT_SERVER_TRANSPORTS=obfs3,scramblesuit "TOR_PT_SERVER_TRANSPORT_OPTIONS" Specifies per-PT protocol configuration directives, as a -semicolon-separated list of <key>:<value> pairs, where <key> -is a PT name and <value> is a k=v string value with options +semicolon-separated list of `<key>:<value>` pairs, where `<key>` +is a PT name and `<value>` is a k=v string value with options that are to be passed to the transport. Colons, semicolons, and backslashes MUST be @@ -183,23 +183,23 @@ TOR_PT_SERVER_TRANSPORT_OPTIONS=scramblesuit:key=banana;automata:rule=110;automa "TOR_PT_SERVER_BINDADDR" ``` -A comma separated list of <key>-<value> pairs, where <key> is -a PT name and <value> is the <address>:<port> on which it +A comma separated list of `<key>-<value>` pairs, where `<key>` is +a PT name and `<value>` is the `<address>:<port>` on which it should listen for incoming client connections. The keys holding transport names MUST be in the same order as they appear in "TOR_PT_SERVER_TRANSPORTS". -The <address> MAY be a locally scoped address as long as port +The `<address>` MAY be a locally scoped address as long as port forwarding is done externally. -The <address>:<port> combination MUST be an IP address +The `<address>:<port>` combination MUST be an IP address supported by `bind()`, and MUST NOT be a host name. Applications MUST NOT set more than one <address>:<port> pair per PT name. -If there is no specific <address>:<port> combination to be +If there is no specific `<address>:<port>` combination to be configured for any transports, "TOR_PT_SERVER_BINDADDR" MAY be omitted. @@ -211,7 +211,7 @@ TOR_PT_SERVER_BINDADDR=obfs3-198.51.100.1:1984,scramblesuit-127.0.0.1:4891 Specifies the destination that the PT reverse proxy should forward traffic to after transforming it as appropriate, as an -<address>:<port>. +`<address>:<port>`. Connections to the destination specified via "TOR_PT_ORPORT" MUST only contain application payload. If the parent process @@ -227,7 +227,7 @@ TOR_PT_ORPORT=127.0.0.1:9001 Specifies the destination that the PT reverse proxy should forward traffic to, via the Extended ORPort protocol [EXTORPORT] -as an <address>:<port>. +as an `<address>:<port>`. The Extended ORPort protocol allows the PT reverse proxy to communicate per-connection metadata such as the PT name and |