Author: amc
Date: Tue Jun 19 02:27:24 2012
New Revision: 1351558
URL: http://svn.apache.org/viewvc?rev=1351558&view=rev
Log:
Fixed documentation for server_ports
Modified:
trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
Modified:
trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
URL:
http://svn.apache.org/viewvc/trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext?rev=1351558&r1=1351557&r2=1351558&view=diff
==============================================================================
---
trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
(original)
+++
trafficserver/site/trunk/content/docs/trunk/admin/configuration-files/records.config.en.mdtext
Tue Jun 19 02:27:24 2012
@@ -175,15 +175,29 @@ the `records.config` file.
*`proxy.local.incoming_ip_to_bind`* {#proxy.local.incoming_ip_to_bind}
: `STRING`
-: Default:
-: This variable can be used to bind to a specific IPs in a multi-interface
setup. Multiple occurances of this variable mean multiple binds to *different*
IPs.
+: Default: ANY address (0.0.0.0 and ::)
+: This variable can be used to bind to a specific IP addresses in a
multi-interface setup. It sets a global default which is used for all ports
unless specifically overridden in a port configuration descriptor. To specify
addresses for both IPv4 and IPv6 list both addresses in this value. The
defaults for the IP addresses families are handled independently.
+
+ Specify the IPv4 address to use for the local address of client
(listening) connections.
- LOCAL proxy.local.incoming_ip_to_bind STRING 192.168.101.17
LOCAL proxy.local.incoming_ip_to_bind STRING 192.168.101.18
- In order to bind to both, the IPv4 and and IPv6 sockets, use the following
setup:
+
+ Specify the IPv4 and IPv6 addresses to use for the local address of client
(listening) connections.
LOCAL proxy.local.incoming_ip_to_bind STRING 192.168.101.17
fc07:192:168:101::17
- LOCAL proxy.local.incoming_ip_to_bind STRING 192.168.101.18
fc07:192:168:101::18
+
+*`proxy.local.outgoing_ip_to_bind`* {#proxy.local.outgoing_ip_to_bind}
+: `STRING`
+: Default: ANY address (0.0.0.0 and ::)
+: This sets the default IP address used for the local address when
connecting to an origin server. It is used unless specifically overridden in a
port configuration descriptor. To specify addresses for both IPv4 and IPv6 list
both addresses in this value. The defaults for the IP addresses families are
handled independently.
+
+ Specify the IPv4 address to use for the local address of origin server
connections.
+
+ LOCAL proxy.local.outgoing_ip_to_bind STRING 192.168.101.18
+
+ Specify the IPv4 and IPv6 addresses to use for the local address of origin
server connections.
+
+ LOCAL proxy.local.outgoing_ip_to_bind STRING 192.168.101.17
fc07:192:168:101::17
# Cluster # {#Cluster}
@@ -263,14 +277,53 @@ the `records.config` file.
# HTTP Engine # {#HTTPEngine}
+*`proxy.config.http.server_ports`* {#proxy.config.http.server_ports}
+: `STRING`
+: Default: `8080`
+: Ports used for proxying HTTP traffic. This is a list, separated by space
or comma, of port descriptors. Each descriptor is a sequence of keywords and
values separated by colons. Not all keywords have values, those that do are
specifically noted. Keywords with values can have an optional '=' character
separating the keyword and value.
+
+
<table><tr><td><strong>Keyword</strong></td><td><strong>Meaning</strong></td></tr>
+ <tr><td><em>number</em></td><td>IP port. Required.</td></tr>
+ <tr><td>ipv6</td><td>Use IPv6.</td></tr>
+ <tr><td>ipv4</td><td>Use IPv4. Default.</td></tr>
+ <tr><td>tr-in</td><td>Use inbound transparency (to client).</td></tr>
+ <tr><td>tr-out</td><td>Use outbound transparency (to server).</td></tr>
+ <tr><td>tr-full</td><td>Full transparency, both inbound and
outbound.</td></tr>
+ <tr><td>ssl</td><td>Use SSL termination.</td></tr>
+ <tr><td>blind</td><td>Use as a blind tunnel (for `CONNECT`).</td></tr>
+ <tr><td>ip-in</td><td>Use the keyword value as the local inbound
(listening) address. This will also set the address family if not explicitly
specified. If the IP address family is specified by `ipv4` or `ipv6` it must
agree with this address.</td></tr>
+ <tr><td>ip-out</td><td>Use the value as the local address when connecting
to a server. This may be specified twice, once for IPv4 and once for IPv6. The
actual address used will be determined by the family of the origin server
address.</td></tr>
+ </table>
+
+ Examples -
+
+ <tt>
+ 80 80:ipv6
+ </tt>
+
+ Listen on port 80 on any address for IPv4 and IPv6.
+
+ <tt>
+ 8080:ipv6:tr-full 443:ssl
80:ip-in=192.168.17.1:ip-out=[fc01:10:10:1::1]:ip-out=10.10.10.1
+ </tt>
+
+
+ Listen on port 8080 any address for IPv6, fully transparent. Set up an SSL
port on 443. Listen on IP address 192.168.17.1, port 80, IPv4, and connect to
origin servers using the local address 10.10.10.1 for IPv4 and fc01:10:10:1::1
for IPv6.
+
+ Note: For SSL you must still configure the certificates, this option
handles only the port configuration.
+
+ Note: old style configuration of ports should still work but support for
that will be removed at some point in the future.
+
*`proxy.config.http.server_port`* {#proxy.config.http.server_port}
: `INT`
: Default: `8080`
+: DEPRECATED: 3.2
: The port that Traffic Server uses when acting as a web proxy server for
web traffic.
*`proxy.config.http.server_port_attr`* {#proxy.config.http.server_port_attr}
: `STRING`
: Default: `X`
+: DEPRECATED: 3.2
: The server port options. You can specify one of the following:
* C=SERVER_PORT_COMPRESSED
@@ -280,6 +333,7 @@ the `records.config` file.
*`proxy.config.http.server_other_ports`*
{#proxy.config.http.server_other_ports}
: `STRING`
: Default: `NULL`
+: DEPRECATED: 3.2
: The ports other than the port specified by the variable
*`proxy.config.http.server_port`* to bind for incoming HTTP requests. Example:
CONFIG proxy.config.http.server_other_ports STRING 6060:X 9090:X
would listed to ports `6060`, `9090`, and the port specified by
*`proxy.config.http.server_port`*.
@@ -287,6 +341,7 @@ the `records.config` file.
*`proxy.config.http.ssl_ports`* {#proxy.config.http.ssl_ports}
: `STRING`
: Default: `443 563`
+: DEPRECATED: 3.2
: The range of ports used for tunneling. Traffic Server allows tunnels only
to the specified ports. For example: to retrieve an object using HTTPS via
Traffic Server, a tunnel must be established to an origin server via Traffic
Server.
*`proxy.config.http.insert_request_via_str`*
{#proxy.config.http.insert_request_via_str}
