You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by ig...@apache.org on 2011/03/31 02:25:42 UTC
svn commit: r1087152 -
/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/
Author: igalic
Date: Thu Mar 31 00:25:42 2011
New Revision: 1087152
URL: http://svn.apache.org/viewvc?rev=1087152&view=rev
Log:
These are style fixes only
We need a CSS. And should give the Definition lists another thought.
I'm not sure they're working out right now.
Modified:
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/bypass.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/cache.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/congestion.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/hosting.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/icp.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/ip_allow.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/log_hosts.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/logs_xml.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/parent.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/partition.config.en.mdtext
trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/remap.config.en.mdtext
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/bypass.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/bypass.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/bypass.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/bypass.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -25,17 +25,21 @@ served by the origin server. The bypass.
[Dynamic Deny Bypass Rules](#DynamicDenyBypassRules).
You can configure three types of static bypass rules:
-- **Source bypass rules** configure Traffic Server to bypass a particular
+
+- **Source bypass rules** configure Traffic Server to bypass a particular
source IP address or range of IP addresses. For example: bypass
clients that do not want to use caching.
-- **Destination bypass rules** configure Traffic Server to bypass a
+
+- **Destination bypass rules** configure Traffic Server to bypass a
particular destination IP address or range of IP addresses. For
example: bypass origin servers that use IP authentication based on the
client's real IP address.
- **IMPORTANT:** Destination bypass rules prevent Traffic Server from
+
+ **IMPORTANT:** Destination bypass rules prevent Traffic Server from
caching an entire site. You will experience hit rate impacts if the
site you bypass is popular.
-- **Source/destination pair bypass rules** configure Traffic Server to
+
+- **Source/destination pair bypass rules** configure Traffic Server to
bypass requests that originate from the specified source to the
specified destination. For example: route around specific
client-server pairs that experience broken IP authentication or
@@ -56,37 +60,35 @@ Bypass rules follow the format below:
The following list describes the variables.
`src` *`ipaddress`*
-: Specifies the source (client) IP address in incoming requests Traffic
- Server must bypass.
+: Specifies the source (client) IP address in incoming requests Traffic Server must bypass.
- The variable ipaddress can be one of the following:
+ The variable ipaddress can be one of the following:
- - A simple IP address, such as 123.45.67.8
- - In CIDR (Classless Inter-Domain Routing) format, such as 1.1.1.0/24
- - A range separated by a dash, such as 1.1.1.1-2.2.2.2
- - Any combination of the above separated by commas, such as 1.1.1.0/24,
+ - A simple IP address, such as 123.45.67.8
+ - In CIDR (Classless Inter-Domain Routing) format, such as 1.1.1.0/24
+ - A range separated by a dash, such as 1.1.1.1-2.2.2.2
+ - Any combination of the above separated by commas, such as 1.1.1.0/24,
25.25.25.25, 123.1.23.1-123.1.23.123
-`dst` *`ipaddress`*
-: Specifies the destination (origin server) IP address in incoming
- requests Traffic Server must bypass.
- The variable ipaddress can be one of the following:
+`dst` *`ipaddress`*
+: Specifies the destination (origin server) IP address in incoming requests Traffic Server must bypass.
- - A simple IP address, such as 123.45.67.8
- - In CIDR (Classless Inter-Domain Routing) format, such as 1.1.1.0/24
- - A range separated by a dash, such as 1.1.1.1-2.2.2.2
- - Any combination of the above separated by commas, such as 1.1.1.0/24,
- 25.25.25.25, 123.1.23.1-123.1.23.123
+ The variable ipaddress can be one of the following:
+
+ - A simple IP address, such as 123.45.67.8
+ - In CIDR (Classless Inter-Domain Routing) format, such as 1.1.1.0/24
+ - A range separated by a dash, such as 1.1.1.1-2.2.2.2
+ - Any combination of the above separated by commas, such as 1.1.1.0/24,
+ 25.25.25.25, 123.1.23.1-123.1.23.123
`src` *`ipaddress`* `AND dst` *`ipaddress`*
-: Specifies the source and destination IP address pair Traffic Server must
- bypass.
-
-The variable ipaddress must be a single IP address, such as 123.45.67.8
+: Specifies the source and destination IP address pair Traffic Server must bypass.
+
+ The variable ipaddress must be a single IP address, such as 123.45.67.8
-### Dynamic Deny Bypass Rules ### {#DynamicDenyBypassRules)
+### Dynamic Deny Bypass Rules ### {#DynamicDenyBypassRules}
In addition to static bypass rules, the bypass.config file also accepts
dynamic deny bypass rules that prevent Traffic Server from bypassing
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/cache.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/cache.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/cache.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/cache.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -43,75 +43,79 @@ cannot repeat a secondary specifier.
The following list shows the possible primary destinations with allowed values.
*`dest_domain`*
-: A requested domain name. Traffic Server matches the domain name of the
- destination from the URL in the request.
+: A requested domain name. Traffic Server matches the domain name of the
+ destination from the URL in the request.
*`dest_host`*
-: A requested hostname. Traffic Server matches the hostname of the
- destination from the URL in the request.
+: A requested hostname. Traffic Server matches the hostname of the
+ destination from the URL in the request.
*`dest_ip`*
-: A requested IP address. Traffic Server matches the IP address of the
- destination in the request.
+: A requested IP address. Traffic Server matches the IP address of the
+ destination in the request.
*`url_regex`*
-: A regular expression (regex) to be found in a URL.
+: A regular expression (regex) to be found in a URL.
The secondary specifiers are optional in the cache.config file. The
following list shows possible secondary specifiers with allowed values.
*`port`*
-: A requested URL port.
+: A requested URL port.
*`scheme`*
-: A request URL protocol: http or https.
+: A request URL protocol: http or https.
*`prefix`*
-: A prefix in the path part of a URL.
+: A prefix in the path part of a URL.
*`suffix`*
-: A file suffix in the URL.
+: A file suffix in the URL.
*`method`*
-: A request URL method: get, put, post, trace.
+: A request URL method: get, put, post, trace.
*`time`*
-: A time range, such as 08:00-14:00.
+: A time range, such as 08:00-14:00.
*`src_ip`*
-: A client IP address.
+: A client IP address.
The following list shows possible actions and their allowed values.
*`action`*
-: One of the following values:
- * `never-cache` configures Traffic Server to never cache specified objects.
- * `ignore-no-cache` configures Traffic Server to ignore all
- `Cache-Control: no-cache` headers.
- * `ignore-client-no-cache` configures Traffic Server to ignore
- `Cache-Control: no-cache` headers from client requests.
- * `ignore-server-no-cache` configures Traffic Server to ignore
- `Cache-Control: no-cache` headers from origin server responses.
+: One of the following values:
+
+ * `never-cache` configures Traffic Server to never cache specified objects.
+ * `ignore-no-cache` configures Traffic Server to ignore all
+ `Cache-Control: no-cache` headers.
+ * `ignore-client-no-cache` configures Traffic Server to ignore
+ `Cache-Control: no-cache` headers from client requests.
+ * `ignore-server-no-cache` configures Traffic Server to ignore
+ `Cache-Control: no-cache` headers from origin server responses.
+
*`pin-in-cache`*
-: The amount of time you want to keep the object(s) in the cache. The
- following time formats are allowed:
- * `d` for days; for example: 2d
- * `h` for hours; for example: 10h
- * `m` for minutes; for example: 5m
- * `s` for seconds; for example: 20s
- * mixed units; for example: 1h15m20s
+: The amount of time you want to keep the object(s) in the cache. The
+ following time formats are allowed:
+
+ * `d` for days; for example: 2d
+ * `h` for hours; for example: 10h
+ * `m` for minutes; for example: 5m
+ * `s` for seconds; for example: 20s
+ * mixed units; for example: 1h15m20s
+
*`revalidate`*
-: The amount of time object(s) are to be considered fresh. Use the same
- time formats as `pin-in-cache`.
+: The amount of time object(s) are to be considered fresh. Use the same
+ time formats as `pin-in-cache`.
*`ttl-in-cache`*
-: The amount of time object(s) are to be kept in the cache, regardless of
- Cache-Control response headers. Use the same time formats as
- pin-in-cache and revalidate .
+: The amount of time object(s) are to be kept in the cache, regardless of
+ Cache-Control response headers. Use the same time formats as
+ pin-in-cache and revalidate .
### Examples ### {#Examples}
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/congestion.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/congestion.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/congestion.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/congestion.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -29,13 +29,14 @@ Traffic Server uses the `congestion.conf
[Congestion Control](http#UsingCongestionControl) option.
You can create rules in the congestion.config file to specify:
-- Which origin servers Traffic Server tracks for congestion.
-- The timeouts Traffic Server uses, depending on whether a server is
- congested.
-- The page Traffic Server sends to the client when a server becomes
- congested.
-- If Traffic Server tracks the origin servers per IP address or per
- hostname.
+
+- Which origin servers Traffic Server tracks for congestion.
+- The timeouts Traffic Server uses, depending on whether a server is
+ congested.
+- The page Traffic Server sends to the client when a server becomes
+ congested.
+- If Traffic Server tracks the origin servers per IP address or per
+ hostname.
## Format ## {#Format}
@@ -51,16 +52,16 @@ The following list shows possible primar
values.
*`dest_domain`*
-: A requested domain name.
+: A requested domain name.
*`dest_host`*
-: A requested hostname.
+: A requested hostname.
*`dest_ip`*
-: A requested IP address.
+: A requested IP address.
*`url_regex`*
-: A regular expression (regex) to be found in a URL.
+: A regular expression (regex) to be found in a URL.
The secondary specifiers are optional in the congestion.config file. The
following list shows possible secondary specifiers with allowed values.
@@ -68,77 +69,77 @@ You can use more than one secondary spec
cannot repeat a secondary specifier.
*`port`*
-: A requested URL port or range of ports.
+: A requested URL port or range of ports.
*`prefix`*
-: A prefix in the path part of a URL.
+: A prefix in the path part of a URL.
The following list shows the possible tags and their allowed values.
*`max_connection_failures`*
-: Default: `5`
-: The maximum number of connection failures allowed within the fail
- window described below before Traffic Server marks the origin server as
- congested.
+: Default: `5`
+: The maximum number of connection failures allowed within the fail
+ window described below before Traffic Server marks the origin server as
+ congested.
*`fail_window`*
-: Default: `120` seconds.
-: The time period during which the maximum number of connection failures
- can occur before Traffic Server marks the origin server as congested.
+: Default: `120` seconds.
+: The time period during which the maximum number of connection failures
+ can occur before Traffic Server marks the origin server as congested.
*`proxy_retry_interval`*
-: Default: `10` seconds.
-: The number of seconds that Traffic Server waits before contacting a
- congested origin server again.
+: Default: `10` seconds.
+: The number of seconds that Traffic Server waits before contacting a
+ congested origin server again.
*`client_wait_interval`*
-: Default: `300` seconds.
-: The number of seconds that the client is advised to wait before
- retrying the congested origin server.
+: Default: `300` seconds.
+: The number of seconds that the client is advised to wait before
+ retrying the congested origin server.
*`wait_interval_alpha`*
-: Default: `30` seconds
-: The upper limit for a random number that is added to the wait interval.
+: Default: `30` seconds
+: The upper limit for a random number that is added to the wait interval.
*`live_os_conn_timeout`*
-: Default: `60` seconds.
-: The connection timeout to the live (uncongested) origin server.
- If a client stops a request before the timeout occurs, then Traffic
- Server does not record a connection failure.
+: Default: `60` seconds.
+: The connection timeout to the live (uncongested) origin server.
+ If a client stops a request before the timeout occurs, then Traffic
+ Server does not record a connection failure.
*`live_os_conn_retries`*
-: Default: `2`
-: The maximum number of retries allowed to the live (uncongested) origin
- server.
+: Default: `2`
+: The maximum number of retries allowed to the live (uncongested) origin
+ server.
*`dead_os_conn_timeout`*
-: Default: `15` secondsj
-: The connection timeout to the congested origin server.
+: Default: `15` secondsj
+: The connection timeout to the congested origin server.
*`dead_os_conn_retries`*
-: Default: `1`
-: The maximum number of retries allowed to the congested origin server.
+: Default: `1`
+: The maximum number of retries allowed to the congested origin server.
*`max_connection`*
-: Default: `-1`
-: The maximum number of connections allowed from Traffic Server to the
- origin server.
+: Default: `-1`
+: The maximum number of connections allowed from Traffic Server to the
+ origin server.
*`error_page`*
-: Default: `"congestion#retryAfter"`
-: The error page sent to the client when a server is congested. You must
- enclose the value in quotes;
+: Default: `"congestion#retryAfter"`
+: The error page sent to the client when a server is congested. You must
+ enclose the value in quotes;
*`congestion_scheme`*
-: Default: `"per_ip"`
-: Specifies if Traffic Server applies the rule on a per-host (`"per_host"`)
- or per-IP basis (`"per_ip"`). You must enclose the value in quotes.
-
- For example: if the server `www.host1.com` has two IP addresses and you
- use the tag value `"per_ip"`, then each IP address has its own number of
- connection failures and is marked as congested independently. If you
- use the tag value `"per_host"` and the server `www.host1.com` is marked as
- congested, then both IP addresses are marked as congested.
+: Default: `"per_ip"`
+: Specifies if Traffic Server applies the rule on a per-host (`"per_host"`)
+ or per-IP basis (`"per_ip"`). You must enclose the value in quotes.
+
+ For example: if the server `www.host1.com` has two IP addresses and you
+ use the tag value `"per_ip"`, then each IP address has its own number of
+ connection failures and is marked as congested independently. If you
+ use the tag value `"per_host"` and the server `www.host1.com` is marked as
+ congested, then both IP addresses are marked as congested.
## Examples ## {#Examples}
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/hosting.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/hosting.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/hosting.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/hosting.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -22,13 +22,13 @@ The `hosting.config` file enables you to
origin servers and/or domains so that you can manage cache space
efficiently and restrict disk usage. For step-by-step instructions on
partitioning the cache according to origin servers and/or domains, refer
-to [Partitioning the Cache](cache) According to Origin Server or Domain.
+to [Partitioning the Cache](../configuring-cache#PartitoningCache) According to Origin Server or Domain.
Before you can assign cache partitions to specific origin servers and/or
domains, you must first partition your cache according to size and
-protocol in the [partition.config](#partition.config) file.
+protocol in the [partition.config](partition.config) file.
For step-by-step instructions about partitioning your cache, refer to
-[Partitioning the Cache](cache). For a description of the
-`partition.config` file, refer to [partition.config](#partition.config).
+[Partitioning the Cache](../configuring-cache#PartitioningCache). For a description of the
+`partition.config` file, refer to [partition.config](partition.config).
After you modify hosting.config, navigate to the Traffic Server bin
directory and run the `traffic_line -x` command to apply your changes. When
@@ -54,11 +54,11 @@ on a particular partition(for example, `
`partition_numbers` is a comma-separated list of the partitions on which you
want to store the content that belongs to the origin server or domain
listed. The partition numbers must be valid numbers listed in the
-[partition.config](#partition.config) file.
+[partition.config](partition.config) file.
**Note:** To allocate more than one partition to an origin server or domain,
you must enter the partitions in a comma-separated list on one line, as
-shown in the example below. The [hosting.config](#hosting.config) file
+shown in the example below. The [hosting.config](hosting.config) file
cannot contain multiple entries for the same origin server or domain.
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/icp.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/icp.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/icp.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/icp.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -31,33 +31,36 @@ automatically applies the changes to all
Each line in the icp.config file contains the name and configuration
information for a single ICP peer in the following format:
+ :::text
host : host_IP : peer_type : proxy_port : icp_port : MC_on : MC_IP : MC_TTL :
Each field is described in the following list.
`host`
-: The hostname of the ICP peer.
- This field is optional; if you do not specify the hostname of the ICP
- peer, you must specify the IP address.
+: The hostname of the ICP peer.
+
+ This field is optional; if you do not specify the hostname of the ICP
+ peer, you must specify the IP address.
`host _IP`
-: The IP address of the ICP peer.
- This field is optional; if you do not specify the IP address of the ICP
- peer, you must specify the hostname.
+: The IP address of the ICP peer.
+
+ This field is optional; if you do not specify the IP address of the ICP
+ peer, you must specify the hostname.
`ctype`
-: Use the following options:
+: Use the following options:
- 1 to indicate an ICP parent cache
- 2 to indicate an ICP sibling cache
+ * 1 to indicate an ICP parent cache
+ * 2 to indicate an ICP sibling cache
`proxy_port`
-: The port number of the TCP port used by the ICP peer for proxy
- communication.
+: The port number of the TCP port used by the ICP peer for proxy
+ communication.
`icp_port`
-: The port number of the UDP port used by the ICP peer for ICP
- communication.
+: The port number of the UDP port used by the ICP peer for ICP
+ communication.
## Examples ## {#Examples}
@@ -65,6 +68,7 @@ Each field is described in the following
The following example configuration is for three nodes: the local host,
one parent, and one sibling.
+ :::text
localhost:0.0.0.0:3:8080:3130:0:0.0.0.0:1
host1:123.12.1.23:1:8080:3131:0:0.0.0.0:1
host2:123.12.1.24:2:8080:3131:0:0.0.0.0:1
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/ip_allow.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/ip_allow.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/ip_allow.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/ip_allow.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -31,6 +31,7 @@ applies the changes to all other nodes i
Each line in the `ip_allow.config` file must have the following format:
+ :::text
src_ip=ipaddress action=ip_allow | ip_deny
where ipaddress is the IP address or range of IP addresses of the clients
@@ -43,6 +44,7 @@ By default, the `ip_allow.config` file c
allows all clients to access the Traffic Server proxy cache. To restrict
access, comment out or delete this line before adding rules:
+ :::text
src_ip=0.0.0.0-255.255.255.255 action=ip_allow
@@ -51,15 +53,18 @@ access, comment out or delete this line
The following example enables all clients to access the Traffic Server
proxy cache:
+ :::text
src_ip=0.0.0.0-255.255.255.255 action=ip_allow
The following example allows all clients on a specific subnet to access
the Traffic Server proxy cache:
+ :::text
src_ip=123.12.3.000-123.12.3.123 action=ip_allow
The following example denies all clients on a specific subnet to access
the Traffic Server proxy cache:
+ :::text
src_ip=123.45.6.0-123.45.6.123 action=ip_deny
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/log_hosts.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/log_hosts.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/log_hosts.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/log_hosts.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -50,6 +50,7 @@ The following example configures Traffic
log files containing all HTTP transactions for the origin servers
`webserver1`, `webserver2`, and `webserver3`.
+ :::text
webserver1
webserver2
webserver3
@@ -59,5 +60,6 @@ servers that contain `sports` in their n
`sports.yahoo.com` and `www.foxsports.com` in a log file called
`squid-sport.log` (the Squid format is enabled).
+ :::text
sports
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/logs_xml.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/logs_xml.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/logs_xml.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/logs_xml.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -46,42 +46,42 @@ The following list shows **`LogFormat`**
`<Name = "valid_format_name"/>`
-: Required. Valid format names include any name except `squid`,
- `common`, `extended`, or `extended2`, which are pre-defined
- formats. There is no default for this tag.
+: Required. Valid format names include any name except `squid`,
+ `common`, `extended`, or `extended2`, which are pre-defined
+ formats. There is no default for this tag.
`<Format = "valid_format_specification"/>`
-: Required. A valid format specification is a printf-style string
- describing each log entry when formatted for ASCII output. Use
- `%<` `*field*` `>` as a placeholder for valid field names. For
- more information, refer to
- [Custom Logging Fields](logfmts#custom-logging-fields).
-
- The specified field can be one of the following types:
-
- Simple. For example: `%<cqu>`
- A field within a container, such as an HTTP header or a statistic.
- Fields of this type have the syntax:
-
- %<{ field } containe>
-
- Aggregates, such as `COUNT`, `SUM`, `AVG`, `FIRST`, `LAST`. Fields
- of this type have the syntax: `%<operator (` *`field`* `)>`
- **Note:** You cannot create a format specification that contains
- both aggregate operators and regular fields.
+: Required. A valid format specification is a printf-style string
+ describing each log entry when formatted for ASCII output. Use
+ `%<` `*field*` `>` as a placeholder for valid field names. For
+ more information, refer to
+ [Custom Logging Fields](logfmts#custom-logging-fields).
+
+ The specified field can be one of the following types:
+
+ Simple. For example: `%<cqu>`
+ A field within a container, such as an HTTP header or a statistic.
+ Fields of this type have the syntax:
+
+ %<{ field } containe>
+
+ Aggregates, such as `COUNT`, `SUM`, `AVG`, `FIRST`, `LAST`. Fields
+ of this type have the syntax: `%<operator (` *`field`* `)>`
+ **Note:** You cannot create a format specification that contains
+ both aggregate operators and regular fields.
`<Interval = "aggregate_interval_secs"/>`
-: Use this tag when the format contains aggregate operators. The
- value "`aggregate_interval_secs`" represents the number of seconds
- between individual aggregate values being produced.
-
- The valid set of aggregate operators are:
-
- COUNT
- SUM
- AVG
- FIRST
- LAST
+: Use this tag when the format contains aggregate operators. The
+ value "`aggregate_interval_secs`" represents the number of seconds
+ between individual aggregate values being produced.
+
+ The valid set of aggregate operators are:
+
+ * COUNT
+ * SUM
+ * AVG
+ * FIRST
+ * LAST
## LogFilters ## {#LogFilters}
@@ -89,40 +89,40 @@ The following list shows **`LogFormat`**
The following list shows the `LogFilter` specifications.
`<Name = "valid_filter_name"/>`
-: Required. All filters must be uniquely named.
+: Required. All filters must be uniquely named.
`<Condition = "valid_log_field valid_operator valid_comparison_value"/>`
-: Required. This field contains the following elements:
+: Required. This field contains the following elements:
- **`valid\_log\_field`** - the field that will be compared against
- the given value. For more information, refer to
- [Logging Format Cross-Reference](logfmts#cross-reference).
-
- **`valid\_operator\_field`** - any one of the following: `MATCH`,
- `CASE_INSENSITIVE_MATCH`, `CONTAIN`, `CASE_INSENSITIVE_CONTAIN`.
-
- - `MATCH` is true if the field and value are identical
- (case-sensitive).
- - `CASE_INSENSITIVE_MATCH` is similar to `MATCH`, except that it
- is case-**insensitive**.
- - `CONTAIN` is true if the field contains the value (the value is
+ **`valid\_log\_field`** - the field that will be compared against
+ the given value. For more information, refer to
+ [Logging Format Cross-Reference](logfmts#cross-reference).
+
+ **`valid\_operator\_field`** - any one of the following: `MATCH`,
+ `CASE_INSENSITIVE_MATCH`, `CONTAIN`, `CASE_INSENSITIVE_CONTAIN`.
+
+ - `MATCH` is true if the field and value are identical
+ (case-sensitive).
+ - `CASE_INSENSITIVE_MATCH` is similar to `MATCH`, except that it
+ is case-**insensitive**.
+ - `CONTAIN` is true if the field contains the value (the value is
a substring of the field).
- - `CASE_INSENSITIVE_CONTAIN` is a case-insensitive version of
- `CONTAIN`.
+ - `CASE_INSENSITIVE_CONTAIN` is a case-insensitive version of
+ `CONTAIN`.
- **`valid\_comparison\_value`** - any string or integer matching
- the field type. For integer values, all of the operators are
- equivalent and mean that the field must be equal to the specified
- value.
-
- **Note:** There are no negative comparison operators. If you want to
- specify a negative condition, then use the `Action` field to
- `REJECT` the record.
+ **`valid\_comparison\_value`** - any string or integer matching
+ the field type. For integer values, all of the operators are
+ equivalent and mean that the field must be equal to the specified
+ value.
+
+ **Note:** There are no negative comparison operators. If you want to
+ specify a negative condition, then use the `Action` field to
+ `REJECT` the record.
`<Action = "valid_action_field"/>`
-: This instructs Traffic Server to either accept or reject records
- that satisfy the filter condition. `<br />`Required:`ACCEPT` or
- `REJECT` .
+: Required: `ACCEPT` or `REJECT` .
+: This instructs Traffic Server to either accept or reject records
+ that satisfy the filter condition.
## LogObject ## {#LogObject}
@@ -130,114 +130,115 @@ The following list shows the `LogFilter`
The following list shows the `LogObject` specifications.
`<Format = "valid_format_name"/>`
-: Required. Valid format names include the predefined logging
- formats: `squid`, `common`, `extended`, and `extended2`, as well as
- any previously-defined custom log formats. There is no default for
- this tag.
+: Required. Valid format names include the predefined logging
+ formats: `squid`, `common`, `extended`, and `extended2`, as well as
+ any previously-defined custom log formats. There is no default for
+ this tag.
`<Filename = "file_name"/>`
-: Required. The filename to which the given log file is written on
- the local file system or on a remote collation server. No local log
- file will be created if you fail to specify this tag. All filenames
- are relative to the default logging directory.
-
- If the name does not contain an extension (for example, `squid`),
- then the extension `.log` is automatically appended to it for ASCII
- logs and `.blog` for binary logs (refer to
- [Mode = "valid\_logging\_mode"](files#0_73225)).
+: Required. The filename to which the given log file is written on
+ the local file system or on a remote collation server. No local log
+ file will be created if you fail to specify this tag. All filenames
+ are relative to the default logging directory.
+
+ If the name does not contain an extension (for example, `squid`),
+ then the extension `.log` is automatically appended to it for ASCII
+ logs and `.blog` for binary logs (refer to
+ [Mode = "valid\_logging\_mode"](files#0_73225)).
- If you do not want an extension to be added, then end the filename with a
- single (.) dot (for example: `squid.` ).
+ If you do not want an extension to be added, then end the filename with a
+ single (.) dot (for example: `squid.` ).
`<Mode = "valid_logging_mode"/>`
-: Valid logging modes include `ascii` , `binary` , and `ascii_pipe` .
- The default is `ascii` .
+: Valid logging modes include `ascii` , `binary` , and `ascii_pipe` .
+ The default is `ascii` .
- - Use `ascii` to create event log files in human-readable form
- (plain ASCII).
- - Use `binary` to create event log files in binary format.
- Binary log files generate lower system overhead and occupy less
- space on the disk (depending on the information being logged). You
- must use the `logcat` utility to translate binary log files to
- ASCII format before you can read them.
- - Use `ascii_pipe` to write log entries to a UNIX named pipe (a
- buffer in memory). Other processes can then read the data using
- standard I/O functions. The advantage of using this option is that
- Traffic Server does not have to write to disk, which frees disk
- space and bandwidth for other tasks. In addition, writing to a pipe
- does not stop when logging space is exhausted because the pipe does
- not use disk space.
-
- If you are using a collation server, then the log is written to a
- pipe on the collation server. A local pipe is created even before a
- transaction is processed, so you can see the pipe right after
- Traffic Server starts. Pipes on a collation server, however, *are*
- created when Traffic Server starts.
+ - Use `ascii` to create event log files in human-readable form
+ (plain ASCII).
+ - Use `binary` to create event log files in binary format.
+ Binary log files generate lower system overhead and occupy less
+ space on the disk (depending on the information being logged). You
+ must use the `logcat` utility to translate binary log files to
+ ASCII format before you can read them.
+ - Use `ascii_pipe` to write log entries to a UNIX named pipe (a
+ buffer in memory). Other processes can then read the data using
+ standard I/O functions. The advantage of using this option is that
+ Traffic Server does not have to write to disk, which frees disk
+ space and bandwidth for other tasks. In addition, writing to a pipe
+ does not stop when logging space is exhausted because the pipe does
+ not use disk space.
+
+ If you are using a collation server, then the log is written to a
+ pipe on the collation server. A local pipe is created even before a
+ transaction is processed, so you can see the pipe right after
+ Traffic Server starts. Pipes on a collation server, however, *are*
+ created when Traffic Server starts.
`<Filters = "list_of_valid_filter_names"/>`
-: A comma-separated list of names of any previously-defined log
- filters. If more than one filter is specified, then all filters
- must accept a record for the record to be logged.
+: A comma-separated list of names of any previously-defined log
+ filters. If more than one filter is specified, then all filters
+ must accept a record for the record to be logged.
`<Protocols = "list_of_valid_protocols"/>`
-: A comma-separated list of the protocols this object should log.
- Valid protocol names for this release are `HTTP` (FTP is
- deprecated).
+: A comma-separated list of the protocols this object should log.
+ Valid protocol names for this release are `HTTP` (FTP is
+ deprecated).
`<ServerHosts = "list_of_valid_servers"/>`
-: A comma-separated list of valid hostnames.This tag indicates that
- only entries from the named servers will be included in the file.
+: A comma-separated list of valid hostnames.This tag indicates that
+ only entries from the named servers will be included in the file.
`<CollationHosts = "list_of_valid_hostnames"/>`
-: A comma-separated list of collation servers to which all log
- entries (for this object) are forwarded. Collation servers can be
- specified by name or IP address. Specify the collation port with a
- colon after the name; for example, `host:port` .
+: A comma-separated list of collation servers to which all log
+ entries (for this object) are forwarded. Collation servers can be
+ specified by name or IP address. Specify the collation port with a
+ colon after the name; for example, `host:port` .
`<Header = "header"/>`
-: The header text you want the log files to contain. The header text
- appears at the beginning of the log file, just before the first
- record.
+: The header text you want the log files to contain. The header text
+ appears at the beginning of the log file, just before the first
+ record.
`<RollingEnabled = "truth value"/>`
-: Enables or disables log file rolling for the `LogObject`. This
- setting overrides the value for the
- *`proxy.config.log.rolling_enabled`* variable in the
- `records.config` file. Set *`truth value`* to one of the
- following values:
-
- `0` to disable rolling for this particular `LogObject`.
- `1` to roll log files at specific intervals during the day (you
- specify time intervals with the `RollingIntervalSec` and
- `RollingOffsetHr` fields).
- `2` to roll log files when they reach a certain size (you specify
- the size with the`RollingSizeMb` field).
- `3` to roll log files at specific intervals during the day or when
- they reach a certain size (whichever occurs first).
- `4` to roll log files at specific intervals during the day when log
- files reach a specific size (at a specified time if the file is of
- the specified size).
+: Enables or disables log file rolling for the `LogObject`. This
+ setting overrides the value for the
+ *`proxy.config.log.rolling_enabled`* variable in the
+ `records.config` file. Set *`truth value`* to one of the
+ following values:
+
+ * `0` to disable rolling for this particular `LogObject`.
+ * `1` to roll log files at specific intervals during the day (you
+ specify time intervals with the `RollingIntervalSec` and
+ `RollingOffsetHr` fields).
+ * `2` to roll log files when they reach a certain size (you specify
+ the size with the`RollingSizeMb` field).
+ * `3` to roll log files at specific intervals during the day or when
+ they reach a certain size (whichever occurs first).
+ * `4` to roll log files at specific intervals during the day when log
+ files reach a specific size (at a specified time if the file is of
+ the specified size).
`<RollingIntervalSec = "seconds"/>`
-: The seconds between log file rolling for the `LogObject`; enables
- you to specify different rolling intervals for different
- `LogObjects`.
- This setting overrides the value for
- *`proxy.config.log.rolling_interval_sec`* in the
- `records.config` file.
+: The seconds between log file rolling for the `LogObject`; enables
+ you to specify different rolling intervals for different
+ `LogObjects`.
+
+ This setting overrides the value for
+ *`proxy.config.log.rolling_interval_sec`* in the
+ `records.config` file.
`<RollingOffsetHr = "hour"/>`
-: Specifies an hour (from 0 to 23) at which rolling is guaranteed to
- align. Rolling might start before then, but a rolled file will be
- produced only at that time. The impact of this setting is only
- noticeable if the rolling interval is larger than one hour.
- This setting overrides the configuration setting
- for *`proxy.config.log.rolling_offset_hr`* in the
- `records.config` file.
+: Specifies an hour (from 0 to 23) at which rolling is guaranteed to
+ align. Rolling might start before then, but a rolled file will be
+ produced only at that time. The impact of this setting is only
+ noticeable if the rolling interval is larger than one hour.
+ This setting overrides the configuration setting
+ for *`proxy.config.log.rolling_offset_hr`* in the
+ `records.config` file.
`<RollingSizeMb = "size_in_MB"/>`
-: The size at which log files are rolled.
+: The size at which log files are rolled.
## Examples ## {#Examples}
@@ -247,7 +248,7 @@ that collects information using three co
::::xml
<LogFormat>
- <Name = "minimal"/>
+ <Name="minimal"/>
<Format = "%<chi> : %<cqu> : %<pssc>"/>
</LogFormat>
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/parent.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/parent.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/parent.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/parent.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -48,74 +48,73 @@ The following list shows the possible pr
their allowed values.
*`dest_domain`*
-: A requested domain name.
+: A requested domain name.
*`dest_host`*
-: A requested hostname.
+: A requested hostname.
*`dest_ip`*
-: A requested IP address or range of IP addresses separated by a dash
- (-).
+: A requested IP address or range of IP addresses separated by a dash (-).
*`url_regex`*
-: A regular expression (regex) to be found in a URL
+: A regular expression (regex) to be found in a URL
The secondary specifiers are optional in the `parent.config` file.
The following list shows the possible secondary specifiers and
their allowed values.
*`port`*
-: A requested URL port.
+: A requested URL port.
*`scheme`*
-: A request URL protocol: `http` or `https`.
+: A request URL protocol: `http` or `https`.
*`prefix`*
-: A prefix in the path part of a URL.
+: A prefix in the path part of a URL.
*`suffix`*
-: A file suffix in the URL.
+: A file suffix in the URL.
*`method`*
-: A request URL method. It can be one of the following:
+: A request URL method. It can be one of the following:
- get
- post
- put
- trace
+ * get
+ * post
+ * put
+ * trace
*`time`*
-: A time range, such as 08:00-14:00, during which the parent cache is
- used to serve requests.
+: A time range, such as 08:00-14:00, during which the parent cache is
+ used to serve requests.
*`src_ip`*
-: A client IP address.
+: A client IP address.
The following list shows the possible actions and their allowed
values.
`parent`
-: An ordered list of parent servers. If the request cannot be handled
- by the last parent server in the list, then it will be routed to
- the origin server. You can specify either a hostname or an IP
- address, but; you must specify the port number.
+: An ordered list of parent servers. If the request cannot be handled
+ by the last parent server in the list, then it will be routed to
+ the origin server. You can specify either a hostname or an IP
+ address, but; you must specify the port number.
`round_robin`
-: One of the following values:
+: One of the following values:
- `true` - Traffic Server goes through the parent cache list in a
- round robin-based on client IP address.
- `strict` - Traffic Server machines serve requests strictly in turn.
- For example: machine `proxy1` serves the first request, `proxy2`
- serves the second request, and so on.
- `false` - Round robin selection does not occur.
+ * `true` - Traffic Server goes through the parent cache list in a
+ round robin-based on client IP address.
+ * `strict` - Traffic Server machines serve requests strictly in turn.
+ For example: machine `proxy1` serves the first request, `proxy2`
+ serves the second request, and so on.
+ * `false` - Round robin selection does not occur.
`go_direct`
-: One of the following values:
+: One of the following values:
- `true` - requests bypass parent hierarchies and go directly to the
- origin server.
- `false` - requests do not bypass parent hierarchies.
+ * `true` - requests bypass parent hierarchies and go directly to the
+ origin server.
+ * `false` - requests do not bypass parent hierarchies.
## Examples ## {#Examples}
@@ -126,6 +125,7 @@ and `p2.x.com`. Traffic Server forwards
serve to the parent servers `p1.x.com` and `p2.x.com` in a
round-robin fashion because:
+ :::text
round_robin=true
dest_domain=. method=get parent="p1.x.com:8080; p2.y.com:8080" round_robin=true
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/partition.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/partition.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/partition.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/partition.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -37,6 +37,7 @@ instructions about partitioning the cach
For each partition you want to create, enter a line with the
following format:
+ :::text
partition=partition_number scheme=protocol_type size=partition_size
where *`partition_number`* is a number between 1 and 255 (the
@@ -63,6 +64,7 @@ the existing partitions.
The following example partitions the cache evenly between HTTP and
HTTPS requests:
+ :::text
partition=1 scheme=http size=50%
partition=2 scheme=https size=50%
Modified: trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/remap.config.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/remap.config.en.mdtext?rev=1087152&r1=1087151&r2=1087152&view=diff
==============================================================================
--- trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/remap.config.en.mdtext (original)
+++ trafficserver/site/branches/ats-cms/content/docs/trunk/admin/configuration-files/remap.config.en.mdtext Thu Mar 31 00:25:42 2011
@@ -50,42 +50,44 @@ Traffic Server recognizes three space-de
format of each field.
`type`
-: Enter one of the following:
+: Enter one of the following:
- `map` --translates an incoming request URL to the appropriate
- origin server URL.
+ * `map` --translates an incoming request URL to the appropriate
+ origin server URL.
- `reverse_map` --translates the URL in origin server redirect
- responses to point to the Traffic Server.
+ * `reverse_map` --translates the URL in origin server redirect
+ responses to point to the Traffic Server.
- `redirect` --redirects HTTP requests permanently without having to
- contact the origin server. Permanent redirects notify the browser
- of the URL change (by returning an HTTP status code 301) so that
- the browser can update bookmarks.
-
- `redirect_temporary` --redirects HTTP requests temporarily without
- having to contact the origin server. Temporary redirects notify the
- browser of the URL change for the current request only (by
- returning an HTTP status code 307).
+ * `redirect` --redirects HTTP requests permanently without having to
+ contact the origin server. Permanent redirects notify the browser
+ of the URL change (by returning an HTTP status code 301) so that
+ the browser can update bookmarks.
+
+ * `redirect_temporary` --redirects HTTP requests temporarily without
+ having to contact the origin server. Temporary redirects notify the
+ browser of the URL change for the current request only (by
+ returning an HTTP status code 307).
- **Note:** use the `regex_` prefix to indicate that the line has a
- regular expression (regex).
+ **Note:** use the `regex_` prefix to indicate that the line has a
+ regular expression (regex).
`target`
-: Enter the origin ("from") URL. You can enter up to four
- components:
+: Enter the origin ("from") URL. You can enter up to four
+ components:
- scheme://host:port/path_prefix
+ :::text
+ scheme://host:port/path_prefix
-where *`scheme`* is `http`.
+ where *`scheme`* is `http`.
`replacement`
-: Enter the destination ("to") URL. You can enter up to four
- components:
+: Enter the origin ("from") URL. You can enter up to four
+ components:
- scheme://host:port/path_prefix
+ :::text
+ scheme://host:port/path_prefix
- where *`scheme`* can be `http` or `https`.
+ where *`scheme`* can be `http` or `https`.
## Examples ## {#Examples}
@@ -98,17 +100,20 @@ The following section shows example mapp
The following example shows a map rule that does not specify a path
prefix in the target or replacement:
+ :::text
map http://www.x.com/ http://server.hoster.com/
This rule results in the following translations:
-| Client Request | Translated Request |
-| `http://www.x.com/Widgets/index.html` | `http://server.hoster.com/Widgets/index.html` |
-| `http://www.x.com/cgi/form/submit.sh?arg=true` | `http://server.hoster.com/cgi/form/submit.sh?arg=true` |
+Client Request | Translated Request
+---------------|-------------------
+`http://www.x.com/Widgets/index.html` | `http://server.hoster.com/Widgets/index.html`
+`http://www.x.com/cgi/form/submit.sh?arg=true` | `http://server.hoster.com/cgi/form/submit.sh?arg=true`
The following example shows a map rule with path prefixes specified
in the target:
+ :::text
map http://www.intranet.y.com/marketing http://marketing.y.com/
map http://intranet.y.com/sales http://sales.y.com/
map http://intranet.y.com/engineering http://engineering.y.com/
@@ -116,20 +121,23 @@ in the target:
These rules result in the following translations:
-| Client Request | Translated Request |
-| `http://www.y.com/marketing/projects/manhattan/specs.html` | `http://marketing.y.com/projects/manhattan/specs.html` |
-| `http://www.y.com/stuff/marketing/projects/boston/specs.html` | `http://info.y.com/marketing/projects/boston/specs.html` |
-| `http://www.y.com/engineering/marketing/requirements.html` | `http://engineering.y.com/marketing/requirements.html` |
+Client Request | Translated Request
+---------------|-------------------
+`http://www.y.com/marketing/projects/manhattan/specs.html` | `http://marketing.y.com/projects/manhattan/specs.html`
+`http://www.y.com/stuff/marketing/projects/boston/specs.html` | `http://info.y.com/marketing/projects/boston/specs.html`
+`http://www.y.com/engineering/marketing/requirements.html` | `http://engineering.y.com/marketing/requirements.html`
The following example shows that the order of the rules matters:
+ :::text
map http://www.g.com/ http://external.g.com/
- map http://www.g.com/stuff http://stuff.g.com`
+ map http://www.g.com/stuff http://stuff.g.com
These rules result in the following translation.
-| Client Request | Translated Request |
-| `http://www.g.com/stuff/a.gif` | `http://external.g.com/stuff/a.gif` |
+Client Request | Translated Request
+---------------|-------------------
+`http://www.g.com/stuff/a.gif` | `http://external.g.com/stuff/a.gif`
In the above examples, the second rule is never applied because all
URLs that match the second rule also match the first rule. The
@@ -139,28 +147,33 @@ first rule takes precedence because it a
The following example shows a mapping with a path prefix specified
in the target and replacement:
+ :::text
map http://www.h.com/a/b http://server.h.com/customers/x/y
This rule results in the following translation.
-| Client Request | Translated Request |
-| `http://www.h.com/a/b/c/d/doc.html` | `http://server.h.com/customers/x/y/c/d/doc.html` |
-| `http://www.h.com/a/index.html` | `Translation fails` |
+Client Request | Translated Request
+---------------|-------------------
+`http://www.h.com/a/b/c/d/doc.html` | `http://server.h.com/customers/x/y/c/d/doc.html`
+`http://www.h.com/a/index.html` | `Translation fails`
The following example shows reverse-map rules:
+ :::text
map http://www.x.com/ http://server.hoster.com/x/
reverse_map http://server.hoster.com/x/ http://www.x.com/
These rules result in the following translations.
-| Client Request | Translated Request |
-| `http://www.x.com/Widgets` | `http://server.hoster.com/x/Widgets` |
+Client Request | Translated Request
+---------------|-------------------
+`http://www.x.com/Widgets` | `http://server.hoster.com/x/Widgets` |
Â
-| Client Request | Origin server Header | Translated Header |
-| `http://www.x.com/Widgets` | `http://server.hoster.com/x/Widgets/` | `http://www.x.com/Widgets/` |
+Client Request | Origin server Header | Translated Header
+---------------|----------------------|-------------------
+`http://www.x.com/Widgets` | `http://server.hoster.com/x/Widgets/` | `http://www.x.com/Widgets/`
When acting as a reverse proxy for multiple servers, Traffic Server
is unable to route to URLs from older browsers that do not send the
@@ -169,18 +182,22 @@ is unable to route to URLs from older br
`records.config` file to the URL to which Traffic Server will
redirect requests without host headers.
+
### Redirect Mapping Rules ### {#RedirectMappingRules}
The following rule permanently redirects all HTTP requests for
`www.company.com` to `www.company2.com`:
+ :::text
redirect http://www.company.com http://www.company2.com
The following rule *temporarily* redirects all HTTP requests for
`www.company1.com` to `www.company2.com`:
+ :::text
redirect_temporary http://www.company1.com http://www.company2.com
+
### Regular Expression (regex) Remap Support ### {#regexRemapSupport}
Regular expressions can be specified in remapping rules, with the
@@ -197,6 +214,7 @@ limitations below:
#### Examples #### {#regexExamples}
+ :::text
regex_map http://x ([0-9]+).z.com http://real-x$1.z.com
regex_redirect http://old.(.*).z.com http://new.$1.z.com
@@ -208,6 +226,7 @@ returns 0, then the "chain" is broken).
#### Examples #### {#PluginChainingExamples}
+ :::text
map http://url/path http://url/path @plugin=/etc/traffic_server/config/plugins/plugin1.so @pparam=1 @pparam=2 @plugin=/etc/traffic_server/config/plugins/plugin2.so @pparam=3
will pass "1" and "2" to plugin1.so and "3" to plugin2.so.