You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by jp...@apache.org on 2013/08/01 02:05:05 UTC
[1/7] docs: split reference material into top-level pages
Updated Branches:
refs/heads/master 5d698d5f5 -> c2eb73635
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/sdk/man/TSHttpParserCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/man/TSHttpParserCreate.en.rst b/doc/sdk/man/TSHttpParserCreate.en.rst
deleted file mode 100644
index faa0a70..0000000
--- a/doc/sdk/man/TSHttpParserCreate.en.rst
+++ /dev/null
@@ -1,91 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
-.. default-domain:: c
-
-===================
-TSHttpParserCreate
-===================
-
-Library
-=======
-
-Apache Traffic Server plugin API
-
-Synopsis
-========
-
-`#include <ts/ts.h>`
-
-.. function:: TSHttpParser TSHttpParserCreate(void)
-.. function:: void TSHttpParserClear(TSHttpParser parser)
-.. function:: void TSHttpParserDestroy(TSHttpParser parser)
-.. function:: TSParseResult TSHttpHdrParseReq(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)
-.. function:: TSParseResult TSHttpHdrParseResp(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)
-
-Description
-===========
-
-:func:`TSHttpParserCreate` creates an HTTP parser object. The
-parser's data structure contains information about the header being
-parsed. A single HTTP parser can be used multiple times, though not
-simultaneously. Before being used again, the parser must be cleared
-by calling :func:`TSHttpParserClear`.
-
-:func:`TSHttpHdrParseReq` parses an HTTP request header. The HTTP
-header :data:`offset` must already be created, and must reside
-inside the marshal buffer :data:`bufp`. The :data:`start` argument
-points to the current position of the string buffer being parsed
-and the :data:`end` argument points to one byte after the end of
-the buffer to be parsed. On return, :data:`start` is modified to
-point past the last character parsed.
-
-It is possible to parse an HTTP request header a single byte at a
-time using repeated calls to :func:`TSHttpHdrParseReq`. As long as
-an error does not occur, the :func:`TSHttpHdrParseReq` function
-will consume that single byte and ask for more. :func:`TSHttpHdrParseReq`
-should be called after :data:`TS_HTTP_READ_REQUEST_HDR_HOOK`.
-
-:func:`TSHttpHdrParseResp` operates in the same manner as
-:func:`TSHttpHdrParseReq` except it parses an HTTP response header.
-It should be called after :data:`TS_HTTP_READ_RESPONSE_HDR_HOOK`.
-
-:func:`TSHttpParserClear` clears the specified HTTP parser so it
-may be used again.
-
-:func:`TSHttpParserDestroy` destroys the TSHttpParser object pointed
-to by :data:`parser`. The :data:`parser` pointer must not be NULL.
-
-Return values
-=============
-
-:func:`TSHttpHdrParseReq` and :func:`TSHttpHdrParseResp` both return
-a :type:`TSParseResult` value. :data:`TS_PARSE_ERROR` is returned
-on error, :data:`TS_PARSE_CONT` is returned if parsing of the header
-stopped because the end of the buffer was reached, and
-:data:`TS_PARSE_DONE` or :data:`TS_PARSE_OK` when a \\r\\n\\r\\n
-pattern is encountered, indicating the end of the header.
-
-Bugs
-====
-
-The distinction between the :data:`TS_PARSE_DONE` and :data:`TS_PARSE_OK`
-results is not well-defined. Plugins should expect both status codes and
-treat them equivalently.
-
-See also
-========
-:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/sdk/man/TSHttpTxnMilestoneGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/man/TSHttpTxnMilestoneGet.en.rst b/doc/sdk/man/TSHttpTxnMilestoneGet.en.rst
deleted file mode 100644
index 993d712..0000000
--- a/doc/sdk/man/TSHttpTxnMilestoneGet.en.rst
+++ /dev/null
@@ -1,76 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
-
-.. default-domain:: c
-
-=====================
-TSHttpTxnMilestoneGet
-=====================
-
-LIBRARY
-=======
-
-Apache Traffic Server plugin API
-
-SYNOPSIS
-========
-
-`#include <ts/ts.h>`
-
-.. function:: TSReturnCode TSHttpTxnMilestoneGet(TSHttpTxn txnp, TSMilestonesType milestone, TSHRTime * time)
-
-DESCRIPTION
-===========
-
-:func:`TSHttpTxnMilestoneGet` will fetch a specific milestone timer
-value for the current request. These timers are calculated during
-the lifetime of a transaction, and are all in :type:`TSHRTime` units
-(nanoseconds), measured from the beginning of the transaction. The
-:data:`time` argument is a pointer to a valid :type:`TSHRtime`
-storage, and is set upon success.
-
-The supported :type:`TSMilestonesType` milestone types are:
-
-|
-|
-| :data:`TS_MILESTONE_UA_BEGIN`
-| :data:`TS_MILESTONE_UA_READ_HEADER_DONE`
-| :data:`TS_MILESTONE_UA_BEGIN_WRITE`
-| :data:`TS_MILESTONE_UA_CLOSE`
-| :data:`TS_MILESTONE_SERVER_FIRST_CONNECT`
-| :data:`TS_MILESTONE_SERVER_CONNECT`
-| :data:`TS_MILESTONE_SERVER_CONNECT_END`
-| :data:`TS_MILESTONE_SERVER_BEGIN_WRITE`
-| :data:`TS_MILESTONE_SERVER_FIRST_READ`
-| :data:`TS_MILESTONE_SERVER_READ_HEADER_DONE`
-| :data:`TS_MILESTONE_SERVER_CLOSE`
-| :data:`TS_MILESTONE_CACHE_OPEN_READ_BEGIN`
-| :data:`TS_MILESTONE_CACHE_OPEN_READ_END`
-| :data:`TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN`
-| :data:`TS_MILESTONE_CACHE_OPEN_WRITE_END`
-| :data:`TS_MILESTONE_DNS_LOOKUP_BEGIN`
-| :data:`TS_MILESTONE_DNS_LOOKUP_END`
-| :data:`TS_MILESTONE_SM_START`
-| :data:`TS_MILESTONE_SM_FINISH`
-| :data:`TS_MILESTONE_LAST_ENTRY`
-
-RETURN VALUES
-=============
-
-:data:`TS_SUCCESS` or :data:`TS_ERROR`.
-
-SEE ALSO
-========
-:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/sdk/man/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/man/index.en.rst b/doc/sdk/man/index.en.rst
deleted file mode 100644
index dcd34b3..0000000
--- a/doc/sdk/man/index.en.rst
+++ /dev/null
@@ -1,28 +0,0 @@
-API Reference
-*************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-.. toctree::
- :maxdepth: 2
-
- TSAPI.en
- TSDebug.en
- TSHttpHookAdd.en
- TSHttpParserCreate.en
- TSHttpTxnMilestoneGet.en
[7/7] git commit: docs: split reference material into top-level pages
Posted by jp...@apache.org.
docs: split reference material into top-level pages
Split all the reference material into a reference subdirectory.
Link reference material from the front page, so it's easy to drop
down into the references without navigating through guide material.
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/c2eb7363
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/c2eb7363
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/c2eb7363
Branch: refs/heads/master
Commit: c2eb736352c52d8c186911c32ac2503457fcff4c
Parents: 5d698d5
Author: James Peach <jp...@apache.org>
Authored: Wed Jul 31 17:03:17 2013 -0700
Committer: James Peach <jp...@apache.org>
Committed: Wed Jul 31 17:03:17 2013 -0700
----------------------------------------------------------------------
doc/admin/commands/index.en.rst | 35 -
doc/admin/commands/traffic_cop.en.rst | 35 -
doc/admin/commands/traffic_line.en.rst | 63 -
doc/admin/commands/traffic_logcat.en.rst | 53 -
doc/admin/commands/traffic_logstats.en.rst | 68 -
doc/admin/commands/traffic_manager.en.rst | 50 -
doc/admin/commands/traffic_server.en.rst | 82 -
doc/admin/commands/traffic_shell.en.rst | 29 -
doc/admin/commands/tspush.en.rst | 36 -
doc/admin/commands/tstop.en.rst | 29 -
doc/admin/commands/tsxs.en.rst | 49 -
doc/admin/configuration-files.en.rst | 43 -
.../configuration-files/cache.config.en.rst | 135 --
.../congestion.config.en.rst | 197 --
.../configuration-files/hosting.config.en.rst | 98 -
doc/admin/configuration-files/icp.config.en.rst | 104 --
.../configuration-files/ip_allow.config.en.rst | 77 -
.../configuration-files/log_hosts.config.en.rst | 66 -
.../configuration-files/logs_xml.config.en.rst | 370 ----
.../configuration-files/parent.config.en.rst | 139 --
.../configuration-files/plugin.config.en.rst | 51 -
.../configuration-files/records.config.en.rst | 1758 ------------------
.../configuration-files/remap.config.en.rst | 277 ---
.../configuration-files/splitdns.config.en.rst | 125 --
.../ssl_multicert.config.en.rst | 81 -
.../configuration-files/storage.config.en.rst | 120 --
.../configuration-files/update.config.en.rst | 203 --
.../configuration-files/volume.config.en.rst | 72 -
doc/admin/index.en.rst | 11 +-
doc/index.rst | 6 +-
doc/plugins/balancer.en.rst | 92 -
doc/plugins/buffer_upload.en.rst | 89 -
doc/plugins/cacheurl.en.rst | 59 -
doc/plugins/combo_handler.en.rst | 84 -
doc/plugins/conf_remap.en.rst | 107 --
doc/plugins/esi.en.rst | 22 -
doc/plugins/geoip_acl.en.rst | 94 -
doc/plugins/gzip.en.rst | 91 -
doc/plugins/header_filter.en.rst | 133 --
doc/plugins/hipes.en.rst | 64 -
doc/plugins/index.en.rst | 75 -
doc/plugins/metafilter.en.rst | 110 --
doc/plugins/mysql_remap.en.rst | 83 -
doc/plugins/regex_remap.en.rst | 131 --
doc/plugins/stale_while_revalidate.en.rst | 21 -
doc/plugins/stats_over_http.en.rst | 50 -
doc/reference/api/TSAPI.en.rst | 143 ++
doc/reference/api/TSDebug.en.rst | 83 +
doc/reference/api/TSHttpHookAdd.en.rst | 120 ++
doc/reference/api/TSHttpParserCreate.en.rst | 91 +
doc/reference/api/TSHttpTxnMilestoneGet.en.rst | 76 +
doc/reference/api/index.en.rst | 28 +
doc/reference/commands/index.en.rst | 35 +
doc/reference/commands/traffic_cop.en.rst | 35 +
doc/reference/commands/traffic_line.en.rst | 63 +
doc/reference/commands/traffic_logcat.en.rst | 53 +
doc/reference/commands/traffic_logstats.en.rst | 68 +
doc/reference/commands/traffic_manager.en.rst | 50 +
doc/reference/commands/traffic_server.en.rst | 82 +
doc/reference/commands/traffic_shell.en.rst | 29 +
doc/reference/commands/tspush.en.rst | 36 +
doc/reference/commands/tstop.en.rst | 29 +
doc/reference/commands/tsxs.en.rst | 49 +
doc/reference/configuration/cache.config.en.rst | 135 ++
.../configuration/congestion.config.en.rst | 197 ++
.../configuration/hosting.config.en.rst | 98 +
doc/reference/configuration/icp.config.en.rst | 104 ++
doc/reference/configuration/index.en.rst | 39 +
.../configuration/ip_allow.config.en.rst | 77 +
.../configuration/log_hosts.config.en.rst | 66 +
.../configuration/logs_xml.config.en.rst | 370 ++++
.../configuration/parent.config.en.rst | 139 ++
.../configuration/plugin.config.en.rst | 51 +
.../configuration/records.config.en.rst | 1758 ++++++++++++++++++
doc/reference/configuration/remap.config.en.rst | 277 +++
.../configuration/splitdns.config.en.rst | 125 ++
.../configuration/ssl_multicert.config.en.rst | 81 +
.../configuration/storage.config.en.rst | 120 ++
.../configuration/update.config.en.rst | 203 ++
.../configuration/volume.config.en.rst | 72 +
doc/reference/plugins/balancer.en.rst | 92 +
doc/reference/plugins/buffer_upload.en.rst | 89 +
doc/reference/plugins/cacheurl.en.rst | 59 +
doc/reference/plugins/combo_handler.en.rst | 84 +
doc/reference/plugins/conf_remap.en.rst | 107 ++
doc/reference/plugins/esi.en.rst | 22 +
doc/reference/plugins/geoip_acl.en.rst | 94 +
doc/reference/plugins/gzip.en.rst | 91 +
doc/reference/plugins/header_filter.en.rst | 133 ++
doc/reference/plugins/hipes.en.rst | 64 +
doc/reference/plugins/index.en.rst | 75 +
doc/reference/plugins/metafilter.en.rst | 110 ++
doc/reference/plugins/mysql_remap.en.rst | 83 +
doc/reference/plugins/regex_remap.en.rst | 131 ++
.../plugins/stale_while_revalidate.en.rst | 21 +
doc/reference/plugins/stats_over_http.en.rst | 50 +
doc/sdk/index.en.rst | 8 -
doc/sdk/man/TSAPI.en.rst | 143 --
doc/sdk/man/TSDebug.en.rst | 83 -
doc/sdk/man/TSHttpHookAdd.en.rst | 120 --
doc/sdk/man/TSHttpParserCreate.en.rst | 91 -
doc/sdk/man/TSHttpTxnMilestoneGet.en.rst | 76 -
doc/sdk/man/index.en.rst | 28 -
103 files changed, 6292 insertions(+), 6311 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/index.en.rst b/doc/admin/commands/index.en.rst
deleted file mode 100644
index 2b5c653..0000000
--- a/doc/admin/commands/index.en.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-Command reference
-=================
-
-.. toctree::
- :maxdepth: 1
-
- traffic_cop.en
- traffic_line.en
- traffic_logcat.en
- traffic_logstats.en
- traffic_manager.en
- traffic_server.en
- traffic_shell.en
- tspush.en
- tstop.en
- tsxs.en
-
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/traffic_cop.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/traffic_cop.en.rst b/doc/admin/commands/traffic_cop.en.rst
deleted file mode 100644
index 366e292..0000000
--- a/doc/admin/commands/traffic_cop.en.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-===========
-traffic_cop
-===========
-
-.. program:: traffic_cop
-
-Description
-===========
-
-.. option:: -stop
-
- Kill children using ``SIGSTOP`` instead of ``SIGKILL``
-
-.. option:: -V
-
- Print version information and exit.
-
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/traffic_line.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/traffic_line.en.rst b/doc/admin/commands/traffic_line.en.rst
deleted file mode 100644
index 11ad134..0000000
--- a/doc/admin/commands/traffic_line.en.rst
+++ /dev/null
@@ -1,63 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-============
-traffic_line
-============
-
-.. program:: traffic_line
-
-Description
-===========
-
-.. option:: -q, --query_deadhosts
-
-.. option:: -r VAR, --read_var VAR
-
-.. option:: -s VAR, --set_var VAR
-
-.. option:: -v VALUE, --value VALUE
-
-.. option:: -x, --reread_config
-
-.. option:: -M, --restart_cluster
-
-.. option:: -L, --restart_local
-
-.. option:: -S, --shutdown
-
-.. option:: -U, --startup
-
-.. option:: -B, --bounce_cluster
-
-.. option:: -b, --bounce_local
-
-.. option:: -C, --clean_cluster
-
-.. option:: -c, --clear_node
-
-.. option:: -Z, --zero_cluster
-
-.. option:: -z, --zero_node
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-.. option:: -V, --version
-
- Print version information and exit.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/traffic_logcat.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/traffic_logcat.en.rst b/doc/admin/commands/traffic_logcat.en.rst
deleted file mode 100644
index 02f8575..0000000
--- a/doc/admin/commands/traffic_logcat.en.rst
+++ /dev/null
@@ -1,53 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-==============
-traffic_logcat
-==============
-
-.. program:: traffic_logcat
-
-Description
-===========
-
-.. option:: -o PATH, --output_file PATH
-
-.. option:: -a, --auto_filename
-
-.. option:: -f, --follow
-
-.. option:: -C, --clf
-
-.. option:: -E, --elf
-
-.. option:: -S, --squid
-
-.. option:: -2, --elf2
-
-.. option:: -T, --debug_tags
-
-.. option:: -w, --overwrite_output
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-.. option:: -V, --version
-
- Print version information and exit.
-
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/traffic_logstats.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/traffic_logstats.en.rst b/doc/admin/commands/traffic_logstats.en.rst
deleted file mode 100644
index 2f59825..0000000
--- a/doc/admin/commands/traffic_logstats.en.rst
+++ /dev/null
@@ -1,68 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-================
-traffic_logstats
-================
-
-.. program:: traffic_logstats
-
-Description
-===========
-
-.. option:: -f FILE, --log_file FILE
-
-.. option:: -o LIST, --origin_list LIST
-
-.. option:: -O FILE, --origin_file FILE
-
-.. option:: -M COUNT, --max_origins COUNT
-
-.. option:: -u COUNT, --urls COUNT
-
-.. option:: -U COUNT, --show_urls COUNT
-
-.. option:: --A, --as_object
-
-.. option:: -i, --incremental
-
-.. option:: -S FILE, --statetag FILE
-
-.. option:: -t, --tail
-
-.. option:: -s, --summary
-
-.. option:: -j, --json
-
-.. option:: -c, --cgi
-
-.. option:: -m, --min_hits
-
-.. option:: -a, --max_age
-
-.. option:: -l COUNT, --line_len COUNT
-
-.. option:: -T TAGS, --debug_tags TAGS
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-.. option:: -V, --version
-
- Print version information and exit.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/traffic_manager.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/traffic_manager.en.rst b/doc/admin/commands/traffic_manager.en.rst
deleted file mode 100644
index f602b2a..0000000
--- a/doc/admin/commands/traffic_manager.en.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-===============
-traffic_manager
-===============
-
-.. program:: traffic_manager
-
-Description
-===========
-
-.. option:: proxyOff
-.. option:: -nosyslog
-.. option:: -aconfPort PORT
-.. option:: -clusterMCPort PORT
-.. option:: -groupAddr ADDRESS
-.. option:: -clusterRSPort PORT
-.. option:: -debug TAGS
-.. option:: -action TAGS
-.. option:: -path FILE
-.. option:: -recordsConf FILE
-.. option:: -tsArgs ARGUMENTS
-.. option:: -proxyPort PORT
-.. option:: -proxyBackDoor PORT
-.. option:: -schema FILE
-.. option:: -version
-
-Environment
-===========
-
-.. envvar:: MGMT_ACONF_PORT
-.. envvar:: MGMT_CLUSTER_MC_PORT
-.. envvar:: MGMT_CLUSTER_RS_PORT
-.. envvar:: MGMT_GROUP_ADDR
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/traffic_server.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/traffic_server.en.rst b/doc/admin/commands/traffic_server.en.rst
deleted file mode 100644
index ad3aa73..0000000
--- a/doc/admin/commands/traffic_server.en.rst
+++ /dev/null
@@ -1,82 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-==============
-traffic_server
-==============
-
-.. program:: traffic_server
-
-Description
-===========
-
-.. option:: -n COUNT, --net_threads COUNT
-
-.. option:: -Z COUNT, --cluster_threads COUNT
-
-.. option:: -U COUNT, --udp_threads COUNT
-
-.. option:: -a, --accepts_thread
-
-.. option:: -b, --accept_till_done
-
-.. option:: -p PORT, --httpport PORT
-
-.. option:: -P PORT, --cluster_port PORT
-
-.. option:: -o LEVEL, --dprintf_level LEVEL
-
-.. option:: -R LEVEL, --regression LEVEL
-
-.. option:: -r TEST, --regression_rest TEST
-
-.. option:: -T TAGS, --debug_tags TAGS
-
-.. option:: -B TAGS, --action_tags TAGS
-
-.. option:: -i COUNT, --interval COUNT
-
-.. option:: -M, --remote_management
-
-.. option:: -d DIR, --management_dir DIR
-
-.. option:: -C CMD, --command CMD
-
-.. option:: -k, --clear_hostdb
-
-.. option:: -K, --clear_cache
-
-.. option:: -c CORE, --read_core CORE
-
-.. option:: --accept_mss MSS
-
-.. option:: -t SECS, --poll_timeout SECS
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-.. option:: -V, --version
-
- Print version information and exit.
-
-Environment
-===========
-
-.. envvar:: PROXY_REMOTE_MGMT
-
-.. envvar:: PROXY_AUTO_EXIT
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/traffic_shell.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/traffic_shell.en.rst b/doc/admin/commands/traffic_shell.en.rst
deleted file mode 100644
index 7a56fd0..0000000
--- a/doc/admin/commands/traffic_shell.en.rst
+++ /dev/null
@@ -1,29 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-=============
-traffic_shell
-=============
-
-.. program:: traffic_shell
-
-Description
-===========
-
-.. option:: -V, --version
-
- Print version information and exit.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/tspush.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/tspush.en.rst b/doc/admin/commands/tspush.en.rst
deleted file mode 100644
index e32c517..0000000
--- a/doc/admin/commands/tspush.en.rst
+++ /dev/null
@@ -1,36 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-======
-tspush
-======
-
-.. program:: tspush
-
-Description
-===========
-
-.. option:: -f FILE, --file FILE
-
-.. option:: -u URL, --url URL
-
-.. option:: -v, --verbose
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/tstop.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/tstop.en.rst b/doc/admin/commands/tstop.en.rst
deleted file mode 100644
index bf1237d..0000000
--- a/doc/admin/commands/tstop.en.rst
+++ /dev/null
@@ -1,29 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-=====
-tstop
-=====
-
-.. program:: tstop
-
-Description
-===========
-
-.. option:: -s COUNT
-
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/commands/tsxs.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/commands/tsxs.en.rst b/doc/admin/commands/tsxs.en.rst
deleted file mode 100644
index f274e64..0000000
--- a/doc/admin/commands/tsxs.en.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-====
-tsxs
-====
-
-.. program:: tsxs
-
-Description
-===========
-
-.. option:: -q VAR, --query VAR
-
-.. option:: -I PATH
-
-.. option:: -L PATH
-
-.. option:: -l LIB
-
-.. option:: -o FILE
-
-.. option:: -i
-
-.. option:: -c FILE [FILE ...]
-
-.. option:: -C FILE [FILE ...]
-
-.. option:: -v, --verbose
-
-.. option:: -h, --help
-
- Print usage information and exit.
-
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files.en.rst b/doc/admin/configuration-files.en.rst
deleted file mode 100644
index ad1ea81..0000000
--- a/doc/admin/configuration-files.en.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-Configuration Files
-*******************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-This section describes Traffic Server configuration files that you can
-edit.
-
-
-.. toctree::
- :maxdepth: 1
-
- configuration-files/records.config.en
- configuration-files/ip_allow.config.en
- configuration-files/update.config.en
- configuration-files/logs_xml.config.en
- configuration-files/remap.config.en
- configuration-files/cache.config.en
- configuration-files/volume.config.en
- configuration-files/parent.config.en
- configuration-files/storage.config.en
- configuration-files/splitdns.config.en
- configuration-files/icp.config.en
- configuration-files/congestion.config.en
- configuration-files/plugin.config.en
- configuration-files/log_hosts.config.en
- configuration-files/hosting.config.en
- configuration-files/ssl_multicert.config.en
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/cache.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/cache.config.en.rst b/doc/admin/configuration-files/cache.config.en.rst
deleted file mode 100644
index 042a048..0000000
--- a/doc/admin/configuration-files/cache.config.en.rst
+++ /dev/null
@@ -1,135 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-============
-cache.config
-============
-
-.. configfile:: cache.config
-
-The :file:`cache.config` file defines how Traffic Server caches web objects. You
-can add caching rules to specify the following: - Not to cache objects
-from specific IP addresses - How long to pin particular objects in the
-cache - How long to consider cached objects as fresh - Whether to ignore
-no-cache directives from the server
-
-.. important::
-
- After you modify the :file:`cache.config file`, navigate to
- the Traffic Server bin directory; then run the :option:`traffic_line -x`
- command to apply changes. When you apply the changes to a node in a
- cluster, Traffic Server automatically applies the changes to all other
- nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`cache.config` file contains a caching rule. Traffic
-Server recognizes three space-delimited tags::
-
- primary_destination=value secondary_specifier=value action=value
-
-You can use more than one secondary specifier in a rule. However, you
-cannot repeat a secondary specifier. The following list shows the
-possible primary destinations with allowed values.
-
-*``dest_domain``* {#dest_domain}
- A requested domain name. Traffic Server matches the domain name of
- the destination from the URL in the request.
-
-*``dest_host``* {#dest_host}
- A requested hostname. Traffic Server matches the hostname of the
- destination from the URL in the request.
-
-*``dest_ip``* {#dest_ip}
- A requested IP address. Traffic Server matches the IP address of the
- destination in the request.
-
-*``url_regex``* {#url_regex}
- A regular expression (regex) to be found in a URL.
-
-The secondary specifiers are optional in the :file:`cache.config` file. The
-following list shows possible secondary specifiers with allowed values.
-
-*``port``* {#port}
- A requested URL port.
-
-*``scheme``* {#scheme}
- A request URL protocol: http or https.
-
-*``prefix``* {#prefix}
- A prefix in the path part of a URL.
-
-*``suffix``* {#suffix}
- A file suffix in the URL.
-
-*``method``* {#method}
- A request URL method: get, put, post, trace.
-
-*``time``* {#time}
- A time range, such as 08:00-14:00.
-
-*``src_ip``* {#src_ip}
- A client IP address.
-
-The following list shows possible actions and their allowed values.
-
-*``action``* {#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.
-
-*``pin-in-cache``* {#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
-
-*``revalidate``* {#revalidate}
- The amount of time object(s) are to be considered fresh. Use the
- same time formats as ``pin-in-cache``.
-
-*``ttl-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 .
-
-Examples
-========
-
-The following example configures Traffic Server to revalidate ``gif``
-and ``jpeg`` objects in the domain ``mydomain.com`` every 6 hours, and
-all other objects in ``mydomain.com`` every hour. The rules are applied
-in the order listed.
-
-::
-
- dest_domain=mydomain.com suffix=gif revalidate=6h
- dest_domain=mydomain.com suffix=jpeg revalidate=6h
- dest_domain=mydomain.com revalidate=1h
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/congestion.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/congestion.config.en.rst b/doc/admin/configuration-files/congestion.config.en.rst
deleted file mode 100644
index 811e9ff..0000000
--- a/doc/admin/configuration-files/congestion.config.en.rst
+++ /dev/null
@@ -1,197 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-=================
-congestion.config
-=================
-
-.. configfile: congestion.config
-
-The :file:`congestion.config` file enables you to configure Traffic Server
-to stop forwarding HTTP requests to origin servers when they become
-congested, and then send the client a message to retry the congested
-origin server later. After you modify the :file:`congestion.config` file,
-navigate to the Traffic Server bin directory; then run the
-:option:`traffic_line -x` command to apply changes. When you apply the changes
-to a node in a cluster, Traffic Server automatically applies the changes
-to all other nodes in the cluster. Traffic Server uses the
-:file:`congestion.config` file only if you enable the `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.
-
-Format
-======
-
-Each line in :file:`congestion.config` must follow the format below. Traffic
-Server applies the rules in the order listed, starting at the top of the
-file. Traffic Server recognizes three space-delimited tags::
-
- primary_destination=value secondary_specifier=value action=value
-
-The following list shows possible primary destinations with allowed
-values.
-
-*``dest_domain``* {#dest_domain}
- A requested domain name.
-
-*``dest_host``* {#dest_host}
- A requested hostname.
-
-*``dest_ip``* {#dest_ip}
- A requested IP address.
-
-*``url_regex``* {#url_regex}
- 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.
-You can use more than one secondary specifier in a rule; however, you
-cannot repeat a secondary specifier.
-
-*``port``* {#port}
- A requested URL port or range of ports.
-
-*``prefix``* {#prefix}
- A prefix in the path part of a URL.
-
-The following list shows the possible tags and their allowed values.
-
-*``max_connection_failures``* {#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.
-
-*``fail_window``* {#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.
-
-*``proxy_retry_interval``* {#proxy_retry_interval}
- Default: ``10`` seconds.
- The number of seconds that Traffic Server waits before contacting a
- congested origin server again.
-
-*``client_wait_interval``* {#client_wait_interval}
- Default: ``300`` seconds.
- The number of seconds that the client is advised to wait before
- retrying the congested origin server.
-
-*``wait_interval_alpha``* {#wait_interval_alpha}
- Default: ``30`` seconds
- The upper limit for a random number that is added to the wait
- interval.
-
-*``live_os_conn_timeout``* {#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.
-
-*``live_os_conn_retries``* {#live_os_conn_retries}
- Default: ``2``
- The maximum number of retries allowed to the live (uncongested)
- origin server.
-
-*``dead_os_conn_timeout``* {#dead_os_conn_timeout}
- Default: ``15`` secondsj
- The connection timeout to the congested origin server.
-
-*``dead_os_conn_retries``* {#dead_os_conn_retries}
- Default: ``1``
- The maximum number of retries allowed to the congested origin
- server.
-
-*``max_connection``* {#max_connection}
- Default: ``-1``
- The maximum number of connections allowed from Traffic Server to the
- origin server.
-
-*``error_page``* {#error_page}
- Default: ``"congestion#retryAfter"``
- The error page sent to the client when a server is congested. You
- must enclose the value in quotes;
-
-*:file:`congestion.config`* {#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.
-
-Examples
-========
-
-The following :file:`congestion.config` rule configures Traffic Server to
-stop forwarding requests to the server ``www.host.com`` on port 80 (HTTP
-traffic) if the server is congested, according to the timeouts
-specified. Traffic Server uses the default tag values because no tag has
-been specified.
-
-::
-
- dest_host=www.host.com port=80
-
-You can use one or more tags in a rule, but each tag must have one value
-only. If you specify no tags in the rule, then Traffic Server uses the
-default values.
-
-You can override any of the default tag values by adding configuration
-variables at the end of :file:`records.config` as follows:
-
-::
-
- CONFIG proxy.config.http.congestion_control.default.tag INT|STRING value
-
-where tag is one of the tags described in the list under
-:file:`congestion.config` and value is the value you
-want to use.
-
-For example::
-
- CONFIG proxy.config.http.congestion_control.default.congestion_scheme STRING per_host
-
-.. important::
-
- Rules in the :file:`congestion.config` file override the
- following variables in the :file:`records.config` file:
-
-::
-
- proxy.config.http.connect_attempts_max_retries
- proxy.config.http.connect_attempts_max_retries_dead_server
- proxy.config.http.connect_attempts_rr_retries
- proxy.config.http.connect_attempts_timeout
- proxy.config.http.down_server.cache_time
- proxy.config.http.down_server.abort_threshold
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/hosting.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/hosting.config.en.rst b/doc/admin/configuration-files/hosting.config.en.rst
deleted file mode 100644
index 73cae87..0000000
--- a/doc/admin/configuration-files/hosting.config.en.rst
+++ /dev/null
@@ -1,98 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-==============
-hosting.config
-==============
-
-.. configfile:: hosting.config
-
-The :file:`hosting.config` file enables you to assign cache partitions to
-specific 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 <../configuring-cache#PartitoningCache>`_.
-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 :file:`volume.config`
-file. For step-by-step instructions about partitioning your cache, refer
-to `Partitioning the Cache <../configuring-cache#PartitioningCache>`_.
-
-After you modify hosting.config, navigate to the Traffic Server bin
-directory and run :option:`traffic_line -x` to apply your changes.
-
-When you apply the changes to a node in a cluster, Traffic Server
-automatically applies the changes to all other nodes in the cluster.
-
-.. important::
-
- The :file:`volume.config` configuration must be the same on all nodes in a cluster.
-
-Format
-======
-
-Each line in the :file:`hosting.config` file must have one of the following
-formats::
-
- hostname=HOST partition=NUMBERS
- domain=DOMAIN partition=NUMBERS
-
-where ``HOST`` is the fully-qualified hostname of the origin server
-whose content you want to store on a particular partition (for example,
-``www.myhost.com``); ``DOMAIN`` is the domain whose content you
-want to store on a particular partition(for example, ``mydomain.com``);
-and ``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
-file:`volume.config`.
-
-**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
-:file:`hosting.config` file cannot contain multiple entries
-for the same origin server or domain.
-
-Generic Partition
-=================
-
-When configuring the :file:`hosting.config` file, you must assign a generic
-partition to use for content that does not belong to any of the origin
-servers or domains listed. If all partitions for a particular origin
-server become corrupt, Traffic Server will also use the generic
-partition to store content for that origin server.
-
-The generic partition must have the following format::
-
- hostname=* partition=NUMBERS
-
-where ``NUMBERS`` is a comma-separated list of generic
-partitions.
-
-Examples
-========
-
-The following example configures Traffic Server to store content from
-the domain ``mydomain.com`` in partition 1 and content from
-``www.myhost.com`` in partition 2. Traffic Server stores content from
-all other origin servers in partitions 3 and 4.
-
-::
-
- domain=mydomain.com partition=1
- hostname=www.myhost.com partition=2
- hostname=* partition=3,4
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/icp.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/icp.config.en.rst b/doc/admin/configuration-files/icp.config.en.rst
deleted file mode 100644
index 877e459..0000000
--- a/doc/admin/configuration-files/icp.config.en.rst
+++ /dev/null
@@ -1,104 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-==========
-icp.config
-==========
-
-.. configfile:: icp.config
-
-.. warning::
-
- The Traffic Server ICP feature is not functional in this release.
-
-The :file:`icp.config` file defines ICP peers (parent and sibling caches).
-
-.. important::
-
- After you modify the icp.config file, navigate to the
- Traffic Server bin directory and run the :option:`traffic_line -x` command to
- apply the changes. When you apply the changes to a node in a cluster,
- Traffic Server automatically applies the changes to all other nodes in
- the cluster.
-
-Format
-======
-
-Each line in the icp.config file contains the name and configuration
-information for a single ICP peer in the following format::
-
- host : host_IP : peer_type : proxy_port : icp_port : MC_on : MC_IP : MC_TTL :
-
-Each field is described in the following list.
-
-*``host``* {#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.
-
-*``host_IP``* {#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.
-
-*``ctype``* {#ctype}
- Use the following options:
-
- - 1 to indicate an ICP parent cache
- - 2 to indicate an ICP sibling cache
-
-*``proxy_port``* {#proxy_port}
- The port number of the TCP port used by the ICP peer for proxy
- communication.
-
-*``icp_port``* {#icp_port}
- The port number of the UDP port used by the ICP peer for ICP
- communication.
-
-*``MC_on``* {#mc_on}
- Enable or disable MultiCast:
-
- - 0 if multicast is disabled
- - 1 if multicast is enabled
-
-*``MC_ip``* {#mc_ip}
- The MultiCast IP address.
-
-*``MC_ttl``* {#mc_ttl}
- The multicast time to live. Use the following options:
-
- - 1 if IP multicast datagrams will not be forwarded beyond a single
- subnetwork
- - 2 to allow delivery of IP multicast datagrams to more than one
- subnet (if there are one or more multicast routers attached to
- the first hop subnet).
-
-Examples
-========
-
-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
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/ip_allow.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/ip_allow.config.en.rst b/doc/admin/configuration-files/ip_allow.config.en.rst
deleted file mode 100644
index 49812a1..0000000
--- a/doc/admin/configuration-files/ip_allow.config.en.rst
+++ /dev/null
@@ -1,77 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-===============
-ip_allow.config
-===============
-
-.. configfile:: ip_allow.config
-
-The :file:`ip_allow.config` file controls client access to the Traffic
-Server proxy cache. You can specify ranges of IP addresses that are
-allowed to use the Traffic Server as a web proxy cache. After you modify
-the :file:`ip_allow.config` file, navigate to the Traffic Server bin
-directory and run the :option:`traffic_line -x` command to apply changes. When
-you apply the changes to a node in a cluster, Traffic Server
-automatically applies the changes to all other nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`ip_allow.config` file must have the following
-format::
-
- src_ip=<range of IP addresses> action=<action> [method=<list of methods separated by '|'>]
-
-where src_ip is the IP address or range of IP addresses of the
-client(s). The action ``ip_allow`` enables the specified client(s) to
-access the Traffic Server proxy cache, and ``ip_deny`` denies the
-specified client(s) to access the Traffic Server proxy cache. Multiple
-method keywords can be specified (method=GET method=HEAD), or multiple
-methods can be separated by an '\|' (method=GET\|HEAD). The method
-keyword is optional and it is defaulted to ALL. Available methods: ALL,
-GET, CONNECT, DELETE, HEAD, ICP_QUERY, OPTIONS, POST, PURGE, PUT,
-TRACE, PUSH
-
-By default, the :file:`ip_allow.config` file contains the following lines,
-which allows all methods to localhost to access the Traffic Server proxy
-cache and denies PUSH, PURGE and DELETE to all IPs (note this allows all
-other methods to all IPs)::
-
- src_ip=127.0.0.1 action=ip_allow method=ALL
- src_ip=::1 action=ip_allow method=ALL
- src_ip=0.0.0.0-255.255.255.255 action=ip_deny method=PUSH|PURGE|DELETE
- src_ip=::-ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff action=ip_deny method=PUSH|PURGE|DELETE
-
-Examples
-========
-
-The following example enables all clients to access the Traffic Server
-proxy cache::
-
- 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::
-
- 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::
-
- src_ip=123.45.6.0-123.45.6.123 action=ip_deny
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/log_hosts.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/log_hosts.config.en.rst b/doc/admin/configuration-files/log_hosts.config.en.rst
deleted file mode 100644
index dcb74e9..0000000
--- a/doc/admin/configuration-files/log_hosts.config.en.rst
+++ /dev/null
@@ -1,66 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-================
-log_hosts.config
-================
-
-.. configfile:: log_hosts.config
-
-To record HTTP transactions for different origin servers in separate log
-files, you must list each origin server hostname in the
-:file:`log_hosts.config` file. In addition, you must enable the `HTTP Host
-Log Splitting <../working-log-files#HTTPHostLogSplitting>`_ option. You
-should use the same :file:`log_hosts.config` file on every Traffic Server
-node in your cluster. After you modify the :file:`log_hosts.config` file,
-run the :option:`traffic_line -x` command to apply the changes.
-When you apply the changes to a node in a cluster, Traffic Server automatically applies the
-changes to all other nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`log_hosts.config` file has the following format::
-
- hostname
-
-where ``hostname`` is the hostname of the origin server.
-
-.. hint::
-
- You can specify keywords in the :file:`log_hosts.config` file to
- record all transactions from origin servers with the specified keyword
- in their names in a separate log file. See the example below.
-
-Examples
-========
-
-The following example configures Traffic Server to create separate log
-files containing all HTTP transactions for the origin servers
-``webserver1``, ``webserver2``, and ``webserver3``::
-
- webserver1
- webserver2
- webserver3
-
-The following example records all HTTP transactions from origin servers
-that contain ``sports`` in their names. For example:
-``sports.yahoo.com`` and ``www.foxsports.com`` in a log file called
-``squid-sport.log`` (the Squid format is enabled)::
-
- sports
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/logs_xml.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/logs_xml.config.en.rst b/doc/admin/configuration-files/logs_xml.config.en.rst
deleted file mode 100644
index e9ad379..0000000
--- a/doc/admin/configuration-files/logs_xml.config.en.rst
+++ /dev/null
@@ -1,370 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-===============
-logs_xml.config
-===============
-
-.. configfile:: logs_xml.config
-
-The :file:`logs_xml.config` file defines the custom log file formats,
-filters, and processing options. The format of this file is modeled
-after XML, the Extensible Markup Language.
-
-Format
-======
-
-The :file:`logs_xml.config` file contains the specifications below:
-
-- ``LogFormat`` specifies the fields to be gathered from each protocol
- event access.
-- ``LogFilter`` specifies the filters that are used to include or
- exclude certain entries being logged based on the value of a field
- within that entry.
-- ``LogObject`` specifies an object that contains a particular format,
- a local filename, filters, and collation servers.
-
-The :file:`logs_xml.config` file ignores extra white space, blank lines, and
-all comments.
-
-LogFormat
-=========
-
-The following list shows ``LogFormat`` specifications.
-
-*``<Name = "valid_format_name"/>``* {#LogsXMLFormatName}
- 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"/>``* {#LogsXMLFormat}
- 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 <../event-logging-formats#CustomLoggingFields>`_.
-
- 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 } container>
-
- 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"/>``* {#LogsXMLInterval}
- Optional
- 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
-==========
-
-The following list shows the ``LogFilter`` specifications.
-
-*``<Name = "valid_filter_name"/>``* {#LogsXMLFilterName}
- Required
- All filters must be uniquely named.
-
-*``<Condition = "valid_log_field valid_operator valid_comparison_value"/>``*
-{#LogsXMLFilterCondition}
- 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 <../event-logging-formats#LoggingFormatCrossReference>`_.
-
- ``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``.
-
- ``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"/>``* {#LogsXMLFilterAction}
- Required: ``ACCEPT`` or ``REJECT`` .
- This instructs Traffic Server to either accept or reject records
- that satisfy the filter condition.
-
-LogObject
-=========
-
-The following list shows the ``LogObject`` specifications.
-
-*``<Format = "valid_format_name"/>``* {#LogsXMLObjectFormat}
- 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"/>``* {#LogsXMLObjectFilename}
- 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" <#LogsXMLOjbectMode>`_).
-
- 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"/>``* {#LogsXMLOjbectMode}
- Optional
- 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.
-
-*``<Filters = "list_of_valid_filter_names"/>``*
-{#LogsXMLObjectFilters}
- Optional
- 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"/>``*
-{#LogsXMLObjectProtocols}
- Optional
- 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"/>``*
-{#LogsXMLObjectServerHosts}
- Optional
- 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"/>``*
-{#LogsXMLObjectCollationHosts}
- Optional
- 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"/>``* {#LogsXMLObjectHeader}
- Optional
- 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"/>``*
-{#LogsXMLObjectRollingEnabled}
- Optional
- Enables or disables log file rolling for the ``LogObject``. This
- setting overrides the value for the
- *``proxy.config.log.rolling_enabled``* variable in the
- :file:`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"/>``*
-{#LogsXMLObjectRollingIntervalSec}
- Optional
- 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
- :file:`records.config` file.
-
-*``<RollingOffsetHr = "hour"/>``* {#LogsXMLObjectRollingOffsetHr}
- Optional
- 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 :file:`records.config`
- file.
-
-*``<RollingSizeMb = "size_in_MB"/>``*
-{#LogsXMLObjectRollingSizeMb}
- Optional
- The size at which log files are rolled.
-
-Examples
-========
-
-The following is an example of a ``LogFormat`` specification that
-collects information using three common fields:
-
-::
-
- <LogFormat>
- <Name="minimal"/>
- <Format = "%<chi> : %<cqu> : %<pssc>"/>
- </LogFormat>
-
-The following is an example of a ``LogFormat`` specification that
-uses aggregate operators:
-
-::
-
- <LogFormat>
- <Name = "summary"/>
- <Format = "%<LAST(cqts)> : %<COUNT(*)> : %<SUM(psql)>"/>
- <Interval = "10"/>
- </LogFormat>
-
-The following is an example of a ``LogFilter`` that will cause only
-``REFRESH_HIT`` entries to be logged:
-
-::
-
- <LogFilter>
- <Name = "only_refresh_hits"/>
- <Action = "ACCEPT"/>
- <Condition = "%<pssc> MATCH REFRESH_HIT"/>
- </LogFilter>
-
-.. note:
-
- When specifying the field in the filter condition, you can
- omit the\ ``%<>``. This means that the filter below is equivalent to the
- example directly above:
-
-::
-
- <LogFilter>
- <Name = "only_refresh_hits"/>
- <Action = "ACCEPT"/>
- <Condition = "pssc MATCH REFRESH_HIT"/>
- </LogFilter>
-
-The following is an example of a ``LogObject`` specification that
-creates a local log file for the minimal format defined earlier. The log
-filename will be ``minimal.log`` because this is an ASCII log file (the
-default).
-
-::
-
- <LogObject>
- <Format = "minimal"/>
- <Filename = "minimal"/>
- </LogObject>
-
-The following is an example of a ``LogObject`` specification that
-includes only HTTP requests served by hosts in the domain
-``company.com`` or by the specific server ``server.somewhere.com``. Log
-entries are sent to port 4000 of the collation host ``logs.company.com``
-and to port 5000 of the collation host ``209.131.52.129.``
-
-::
-
- <LogObject>
- <Format = "minimal"/>
- <Filename = "minimal"/>
- <ServerHosts = "company.com,server.somewhere.com"/>
- <Protocols = "http"/>
- <CollationHosts = "logs.company.com:4000,209.131.52.129:5000"/>
- </LogObject>
-
-WELF
-====
-
-Traffic Server supports WELF (WebTrends Enhanced Log Format) so you can
-analyze Traffic Server log files with WebTrends reporting tools. A
-predefined ``<LogFormat>`` that is compatible with WELF is provided in
-the :file:`logs_xml.config` file (shown below). To create a WELF format log
-file, create a ``<LogObject>`` that uses this predefined format.
-
-::
-
- <LogFormat>
- <Name = "welf"/>
- <Format = "id=firewall time=\"%<cqtd> %<cqtt>\" fw=%<phn> pri=6
- proto=%<cqus> duration=%<ttmsf> sent=%<psql> rcvd=%<cqhl>
- src=%<chi> dst=%<shi> dstname=%<shn> user=%<caun> op=%<cqhm>
- arg=\"%<cqup>\" result=%<pssc> ref=\"%<{Referer}cqh>\"
- agent=\"%<{user-agent}cqh>\" cache=%<crc>"/>
- </LogFormat>
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/parent.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/parent.config.en.rst b/doc/admin/configuration-files/parent.config.en.rst
deleted file mode 100644
index 1391c7c..0000000
--- a/doc/admin/configuration-files/parent.config.en.rst
+++ /dev/null
@@ -1,139 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-=============
-parent.config
-=============
-
-.. configfile:: parent.config
-
-The :file:`parent.config` file identifies the parent proxies used in an
-cache hierarchy. Use this file to perform the following configuration:
-
-- Set up parent cache hierarchies, with multiple parents and parent
- failover
-- Configure selected URL requests to bypass parent proxies
-
-Traffic Server uses the :file:`parent.config` file only when the parent
-caching option is enabled (refer to `Configuring Traffic Server to Use a
-Parent Cache <../hierachical-caching>`_).
-
-After you modify the :file:`parent.config` file, run the :option:`traffic_line -x`
-command to apply your changes. When you apply the changes to one node in
-a cluster, Traffic Server automatically applies the changes to all other
-nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`parent.config` file must contain a parent caching
-rule. Traffic Server recognizes three space-delimited tags:
-
- primary_destination=value secondary_specifier=value action=value
-
-The following list shows the possible primary destinations and their
-allowed values.
-
-*``dest_domain``* {#dest_domain}
- A requested domain name.
-
-*``dest_host``* {#dest_host}
- A requested hostname.
-
-*``dest_ip``* {#dest_ip}
- A requested IP address or range of IP addresses separated by a dash
- (-).
-
-*``url_regex``* {#url_regex}
- A regular expression (regex) to be found in a URL
-
-The secondary specifiers are optional in the :file:`parent.config` file. The
-following list shows the possible secondary specifiers and their allowed
-values.
-
-*``port``* {#port}
- A requested URL port.
-
-*``scheme``* {#scheme}
- A request URL protocol: ``http`` or ``https``.
-
-*``prefix``* {#prefix}
- A prefix in the path part of a URL.
-
-*``suffix``* {#suffix}
- A file suffix in the URL.
-
-*``method``* {#method}
- A request URL method. It can be one of the following:
-
- - get
- - post
- - put
- - trace
-
-*``time``* {#time}
- A time range, such as 08:00-14:00, during which the parent cache is
- used to serve requests.
-
-*``src_ip``* {#src_ip}
- 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.
-
-``round_robin``
- 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.
-
-``go_direct``
- One of the following values:
-
- - ``true`` - requests bypass parent hierarchies and go directly to
- the origin server.
- - ``false`` - requests do not bypass parent hierarchies.
-
-Examples
-========
-
-The following rule configures a parent cache hierarchy consisting of
-Traffic Server (which is the child) and two parents, ``p1.x.com`` and
-``p2.x.com``. Traffic Server forwards the requests it cannot serve to
-the parent servers ``p1.x.com`` and ``p2.x.com`` in a round-robin
-fashion::
-
- round_robin=true
- dest_domain=. method=get parent="p1.x.com:8080; p2.y.com:8080" round_robin=true
-
-The following rule configures Traffic Server to route all requests
-containing the regular expression ``politics`` and the path
-``/viewpoint`` directly to the origin server (bypassing any parent
-hierarchies): ``url_regex=politics prefix=/viewpoint go_direct=true``
-
-Every line in the :file:`parent.config` file must contain either a
-``parent=`` or ``go_direct=`` directive.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/plugin.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/plugin.config.en.rst b/doc/admin/configuration-files/plugin.config.en.rst
deleted file mode 100644
index 9a5afa6..0000000
--- a/doc/admin/configuration-files/plugin.config.en.rst
+++ /dev/null
@@ -1,51 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-=============
-plugin.config
-=============
-
-.. configfile:: plugin.config
-
-The :file:`plugin.config` file controls run-time loadable plugins available
-to the Traffic Server, as well as their configuration.
-
-Example
-=======
-
-::
-
- # Comments start with a '#' and continue to the end of the line
- # Blank lines are ignored
- #
- # test-plugin.so arg1 arg2 arg3
- #
- plugins/iwx/iwx.so
- plugins/abuse/abuse.so etc/trafficserver/abuse.config
- plugins/icx/icx.so etc/trafficserver/icx.config
-
-Each configuration line consists of a path to an ``.so`` file. This path
-can either be absolute, or relative to the plugin-directory (usually
-``/usr/local/libexec/trafficserver``). Such a line tells Traffic Server
-to load said plugin.
-
-A plugin can have any number of configuration parameters listed. Please
-refer to our `plugins' documentation <../plugins>`_ for their reference.
-
-Plugins should only be listed *once*. The order in which the plugins are
-listed is also the order in which they are chained for the processing.
-
[3/7] docs: split reference material into top-level pages
Posted by jp...@apache.org.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/records.config.en.rst b/doc/reference/configuration/records.config.en.rst
new file mode 100644
index 0000000..a17fbbd
--- /dev/null
+++ b/doc/reference/configuration/records.config.en.rst
@@ -0,0 +1,1758 @@
+..
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+==============
+records.config
+==============
+
+.. configfile:: records.config
+
+The :file:`records.config` file is a list of configurable variables used by
+the Traffic Server software. Many of the variables in the
+:file:`records.config` file are set automatically when you set configuration
+options in Traffic Line or Traffic Shell. After you modify the
+:file:`records.config` file,
+run the command :option:`traffic_line -x` to apply the changes.
+When you apply changes to one node in a cluster, Traffic Server
+automatically applies the changes to all other nodes in the cluster.
+
+Format
+======
+
+Each variable has the following format::
+
+ SCOPE variable_name DATATYPE variable_value
+
+where
+
+``SCOPE`` is related to clustering and is either ``CONFIG`` (all members of the cluster) or ``LOCAL`` (only the local machine)
+
+``DATATYPE`` is one of ``INT`` (integer), ``STRING`` (string), ``FLOAT`` (floating point).
+
+A variable marked as ``Deprecated`` is still functional but should be avoided as it may be removed in a future release without warning.
+
+A variable marked as ``Reloadable`` can be updated via the command::
+
+ traffic_line -x
+
+Examples
+========
+
+In the following example, the variable `proxy.config.proxy_name`_ is
+a ``STRING`` datatype with the value ``my_server``. This means that the
+name of the Traffic Server proxy is ``my_server``. ::
+
+ CONFIG proxy.config.proxy_name STRING my_server
+
+If the server name should be ``that_server`` the line would be ::
+
+ CONFIG proxy.config.proxy_name STRING that_server
+
+In the following example, the variable ``proxy.config.arm.enabled`` is
+a yes/no flag. A value of ``0`` (zero) disables the option; a value of
+``1`` enables the option. ::
+
+ CONFIG proxy.config.arm.enabled INT 0
+
+In the following example, the variable sets the cluster startup timeout
+to 10 seconds. ::
+
+ CONFIG proxy.config.cluster.startup_timeout INT 10
+
+Environment Overrides
+=====================
+
+Every :file:`records.config` configuration variable can be overridden
+by a corresponding environment variable. This can be useful in
+situations where you need a static :file:`records.config` but still
+want to tweak one or two settings. The override variable is formed
+by converting the :file:`records.config` variable name to upper
+case, and replacing any dot separators with an underscore.
+
+Overriding a variable from the environment is permanent and will
+not be affected by future configuration changes made in
+:file:`records.config` or applied with :program:`traffic_line`.
+
+For example, we could override the `proxy.config.product_company`_ variable
+like this::
+
+ $ PROXY_CONFIG_PRODUCT_COMPANY=example traffic_cop &
+ $ traffic_line -r proxy.config.product_company
+
+Configuration Variables
+=======================
+
+The following list describes the configuration variables available in
+the :file:`records.config` file.
+
+System Variables
+----------------
+
+.. ts:confvar:: CONFIG proxy.config.product_company STRING Apache Software Foundation
+
+ The name of the organization developing Traffic Server.
+
+.. ts:confvar:: CONFIG proxy.config.product_vendor STRING Apache
+
+ The name of the vendor providing Traffic Server.
+
+.. ts:confvar:: CONFIG proxy.config.product_name STRING Traffic Server
+
+ The name of the product.
+
+.. ts:confvar:: CONFIG proxy.config.proxy_name STRING ``build_machine``
+ :reloadable:
+
+ The name of the Traffic Server node.
+
+.. ts:confvar:: CONFIG proxy.config.bin_path STRING bin
+
+ The location of the Traffic Server ``bin`` directory.
+
+.. ts:confvar:: CONFIG proxy.config.proxy_binary STRING traffic_server
+
+ The name of the executable that runs the ``traffic_server`` process.
+
+.. ts:confvar:: CONFIG proxy.config.proxy_binary_opts STRING -M
+
+ The command-line options for starting Traffic Server.
+
+.. ts:confvar:: CONFIG proxy.config.manager_binary STRING traffic_manager
+
+ The name of the executable that runs the ``traffic_manager`` process.
+
+.. ts:confvar:: CONFIG proxy.config.cli_binary STRING traffic_line
+
+ The name of the executable that runs the command-line interface :program:`traffic_line`.
+
+.. ts:confvar:: CONFIG proxy.config.watch_script STRING traffic_cop
+
+ The name of the executable that runs the ``traffic_cop`` process.
+
+.. ts:confvar:: CONFIG proxy.config.env_prep STRING
+
+ The script executed before the ``traffic_manager`` process spawns
+ the ``traffic_server`` process.
+
+.. ts:confvar:: CONFIG proxy.config.config_dir STRING config
+
+ The directory that contains Traffic Server configuration files.
+
+.. ts:confvar:: CONFIG proxy.config.temp_dir STRING /tmp
+
+ The directory used for Traffic Server temporary files.
+
+.. ts:confvar:: CONFIG proxy.config.alarm_email STRING
+ :reloadable:
+
+ The email address to which Traffic Server sends alarm messages.
+
+During a custom Traffic Server installation, you can specify the email address;
+otherwise, Traffic Server uses the Traffic Server user account name as the default value for this variable.
+
+.. ts:confvar:: CONFIG proxy.config.syslog_facility STRING LOG_DAEMON
+
+ The facility used to record system log files. Refer to
+ `Understanding Traffic Server Log Files <../working-log-files#UnderstandingTrafficServerLogFiles>`_.
+
+.. ts:confvar:: CONFIG proxy.config.cop.core_signal INT 0
+
+ The signal sent to ``traffic_cop``'s managed processes to stop them.
+
+A value of ``0`` means no signal will be sent.
+
+.. ts:confvar:: CONFIG proxy.config.cop.linux_min_swapfree_kb INT 10240
+
+ The minimum amount of free swap space allowed before Traffic Server stops the ``traffic_server`` and ``traffic_manager`` processes to
+ prevent the system from hanging. This configuration variable applies if swap is enabled in Linux 2.2 only.
+
+.. ts:confvar:: CONFIG proxy.config.output.logfile STRING traffic.out
+
+ The name and location of the file that contains warnings, status messages, and error messages produced by the Traffic Server
+ processes. If no path is specified, then Traffic Server creates the file in its logging directory.
+
+.. ts:confvar:: CONFIG proxy.config.snapshot_dir STRING snapshots
+
+ The directory in which Traffic Server stores configuration snapshots on the local system. Unless you specify an absolute path, this
+ directory is located in the Traffic Server ``config`` directory.
+
+.. ts:confvar:: CONFIG proxy.config.exec_thread.autoconfig INT 1
+
+ When enabled (the default, ``1``), Traffic Server scales threads according to the available CPU cores. See the config option below.
+
+.. ts:confvar:: CONFIG proxy.config.exec_thread.autoconfig.scale FLOAT 1.5
+
+ Factor by which Traffic Server scales the number of threads. The multiplier is usually the number of available CPU cores. By default
+ this is scaling factor is ``1.5``.
+
+.. ts:confvar:: CONFIG proxy.config.exec_thread.limit INT 2
+
+ *XXX* What does this do?
+
+.. ts:confvar:: CONFIG proxy.config.accept_threads INT 0
+
+ When enabled (``1``), runs a separate thread for accept processing. If disabled (``0``), then only 1 thread can be created.
+
+.. ts:confvar:: CONFIG proxy.config.thread.default.stacksize INT 1096908
+
+ The new default thread stack size, for all threads. The original default is set at 1 MB.
+
+Network
+=======
+
+.. ts:confvar:: LOCAL proxy.local.incoming_ip_to_bind STRING 0.0.0.0 ::
+
+ Controls the global default IP addresses to which to bind proxy server ports. The value is a space separated list of IP addresses, one per supported IP address family (currently IPv4 and IPv6).
+
+Unless explicitly specified in `proxy.config.http.server_ports`_ the server port will be bound to one of these addresses, selected by IP address family. The built in default is any address. This is used if no address for a family is specified. This setting is useful if most or all server ports should be bound to the same address.
+
+.. note:: This is ignored for inbound transparent server ports because they must be able to accept connections on arbitrary IP addresses.
+
+.. topic:: Example
+
+ Set the global default for IPv4 to ``192.168.101.18`` and leave the global default for IPv6 as any address.::
+
+ LOCAL proxy.local.incoming_ip_to_bind STRING 192.168.101.18
+
+.. topic:: Example
+
+ Set the global default for IPv4 to ``191.68.101.18`` and the global default for IPv6 to ``fc07:192:168:101::17``.::
+
+ LOCAL proxy.local.incoming_ip_to_bind STRING 192.168.101.18 fc07:192:168:101::17
+
+.. ts:confvar:: LOCAL proxy.local.outgoing_ip_to_bind STRING 0.0.0.0 ::
+
+ This controls the global default for the local IP address for outbound connections to origin servers. The value is a list of space separated IP addresses, one per supported IP address family (currently IPv4 and IPv6).
+
+ Unless explicitly specified in `proxy.config.http.server_ports`_ one of these addresses, selected by IP address family, will be used as the local address for outbound connections. This setting is useful if most or all of the server ports should use the same outbound IP addresses.
+
+.. note:: This is ignore for outbound transparent ports as the local outbound address will be the same as the client local address.
+
+.. topic:: Example
+
+ Set the default local outbound IP address for IPv4 connectionsn to ``192.168.101.18``.::
+
+ LOCAL proxy.local.outgoing_ip_to_bind STRING 192.168.101.18
+
+.. topic:: Example
+
+ Set the default local outbound IP address to ``192.168.101.17`` for IPv4 and ``fc07:192:168:101::17`` for IPv6.::
+
+ LOCAL proxy.local.outgoing_ip_to_bind STRING 192.168.101.17 fc07:192:168:101::17
+
+Cluster
+=======
+
+.. ts:confvar:: LOCAL proxy.local.cluster.type INT 3
+
+ Sets the clustering mode:
+
+===== ====================
+Value Effect
+===== ====================
+1 full-clustering mode
+2 management-only mode
+3 no clustering
+===== ====================
+
+.. ts:confvar:: CONFIG proxy.config.cluster.rsport INT 8088
+
+ The reliable service port. The reliable service port is used to send configuration information between the nodes in a cluster. All nodes
+ in a cluster must use the same reliable service port.
+
+.. ts:confvar:: CONFIG proxy.config.cluster.threads INT 1
+
+ The number of threads for cluster communication. On heavy cluster, the number should be adjusted. It is recommend that take the thread
+ CPU usage as a reference when adjusting.
+
+Local Manager
+=============
+
+.. ts:confvar:: CONFIG proxy.config.lm.sem_id INT 11452
+
+ The semaphore ID for the local manager.
+
+.. ts:confvar:: CONFIG proxy.config.admin.autoconf_port INT 8083
+
+ The autoconfiguration port.
+
+.. ts:confvar:: CONFIG proxy.config.admin.number_config_bak INT 3
+
+ The maximum number of copies of rolled configuration files to keep.
+
+.. ts:confvar:: CONFIG proxy.config.admin.user_id STRING nobody
+
+ Option used to specify who to run the ``traffic_server`` process as; also used to specify ownership of config and log files.
+
+The nonprivileged user account designated to Traffic Server.
+
+As of version 2.1.1 if the user_id is prefixed with pound character (#) the remaining of the string is considered to be
+``numeric user identifier <http://en.wikipedia.org/wiki/User_identifier>``_.
+If the value is set to ``#-1`` Traffic Server will not change the user during startup.
+
+Setting ``user_id`` to ``root`` or ``#0`` is now forbidden to
+increase security. Trying to do so, will cause the
+``traffic_server`` fatal failure. However there are two ways to
+bypass that restriction: Specify ``-DBIG_SECURITY_HOLE`` in
+``CXXFLAGS`` during compilation. Set the ``user_id=#-1`` and start
+trafficserver as root.
+
+Process Manager
+===============
+
+.. ts:confvar:: CONFIOG proxy.config.process_manager.mgmt_port INT 8084
+
+ The port used for internal communication between the ``traffic_manager`` and ``traffic_server`` processes.
+
+Alarm Configuration
+===================
+
+.. ts:confvar:: CONFIG proxy.config.alarm.bin STRING example_alarm_bin.sh
+
+ Name of the script file that can execute certain actions when an alarm is signaled. The default file is a sample script named
+ ``example_alarm_bin.sh`` located in the ``bin`` directory. You must dit the script to suit your needs.
+
+.. ts:confvar:: CONFIG proxy.config.alarm.abs_path STRING NULL
+
+ The full path to the script file that sends email to alert someone bout Traffic Server problems.
+
+HTTP Engine
+===========
+
+.. ts:confvar:: CONFIG proxy.config.http.server_ports STRING 8080
+
+ Ports used for proxying HTTP traffic.
+
+This is a list, separated by space or comma, of :index:`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. The case of keywords is ignored. The order of keywords is irrelevant but unspecified results may occur if incompatible options are used (noted below). Options without values are idempotent. Options with values use the last (right most) value specified, except for ``ip-out`` as detailed later.
+
+Quick reference chart.
+
+=========== =============== ========================================
+Name Note Definition
+=========== =============== ========================================
+*number* **Required** The local port.
+ipv4 **Default** Bind to IPv4 address family.
+ipv6 Bind to IPv6 address family.
+tr-in Inbound transparent.
+tr-out Outbound transparent.
+tr-full Fully transparent (inbound and outbound)
+tr-pass Pass through enabled.
+ssl SSL terminated.
+ip-in **Value** Local inbound IP address.
+ip-out **Value** Local outbound IP address.
+ip-resolve **Value** IP address resolution style.
+blind Blind (``CONNECT``) port.
+compress **N/I** Compressed. Not implemented.
+=========== =============== ========================================
+
+*number*
+ Local IP port to bind. This is the port to which ATS clients will connect.
+
+ipv4
+ Use IPv4. This is the default and is included primarily for completeness. This forced if the ``ip-in`` option is used with an IPv4 address.
+
+ipv6
+ Use IPv6. This is forced if the ``ip-in`` option is used with an IPv6 address.
+
+tr-in
+ Inbound transparent. The proxy port will accept connections to any IP address on the port. To have IPv6 inbound transparent you must use this and the ``ipv6`` option. This overrides `proxy.local.incoming_ip_to_bind`_.
+
+ Not compatible with: ``ip-in``, ``ssl``, ``blind``
+
+tr-out
+ Outbound transparent. If ATS connects to an origin server for a transaction on this port, it will use the client's address as its local address. This overrides `proxy.local.outgoing_ip_to_bind`_.
+
+ Not compatible with: ``ip-out``, ``ssl``
+
+tr-full
+ Fully transparent. This is a convenience option and is identical to specifying both ``tr-in`` and ``tr-out``.
+
+ Not compatible with: Any option not compatible with ``tr-in`` or ``tr-out``.
+
+tr-pass
+ Transparent pass through. This option is useful only for inbound transparent proxy ports. If the parsing of the expected HTTP header fails, then the transaction is switched to a blind tunnel instead of generating an error response to the client. It effectively enables `proxy.config.http.use_client_target_addr`_ for the transaction as there is no other place to obtain the origin server address.
+
+ip-in
+ Set the local IP address for the port. This is the address to which clients will connect. This forces the IP address family for the port. The ``ipv4`` or ``ipv6`` can be used but it is optional and is an error for it to disagree with the IP address family of this value. An IPv6 address **must** be enclosed in square brackets. If this is omitted `proxy.local.incoming_ip_to_bind`_ is used.
+
+ Not compatible with: ``tr-in``.
+
+ip-out
+ Set the local IP address for outbound connections. This is the address used by ATS locally when it connects to an origin server for transactions on this port. If this is omitted `proxy.local.outgoing_ip_to_bind`_ is used.
+
+ This option can used multiple times, once for each IP address family. The address used is selected by the IP address family of the origin server address.
+
+ Not compatible with: ``tr-out``.
+
+ip-resolve
+ Set the IP address resolution style for the origin server for transactions on this proxy port.
+
+ssl
+ Require SSL termination for inbound connections. SSL must be configured for this option to provide a functional server port.
+
+ Not compatible with: ``tr-in``, ``tr-out``, ``blind``.
+
+blind
+ Accept only ``CONNECT`` transactions on this port.
+
+ Not compatible with: ``tr-in``, ``ssl``.
+
+compress
+ Compress the connection. Retained only by inertia, should be considered "not implemented".
+
+.. topic:: Example
+
+ Listen on port 80 on any address for IPv4 and IPv6.::
+
+ 80 80:ipv6
+
+.. topic:: Example
+
+ Listen transparently on any IPv4 address on port 8080, and
+ transparently on port 8080 on local address ``fc01:10:10:1::1``
+ (which implies ``ipv6``).::
+
+ IPv4:tr-FULL:8080 TR-full:IP-in=[fc02:10:10:1::1]:8080
+
+.. topic:: Example
+
+ Listen on port 8080 for IPv6, fully transparent. Set up an SSL port on 443. These ports will use the IP address from `proxy.local.incoming_ip_to_bind`_. 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.::
+
+ 8080:ipv6:tr-full 443:ssl ip-in=192.168.17.1:80:ip-out=[fc01:10:10:1::1]:ip-out=10.10.10.1
+
+.. ts:confvar:: CONFIG proxy.config.http.connect_ports STRING 443 563
+
+ The range of origin server ports that can be used for tunneling via ``CONNECT``.
+
+Traffic Server allows tunnels only to the specified ports.
+Supports both wildcards ('\*') and ranges ("0-1023").
+
+.. note:: These are the ports on the *origin server*, not `server ports <#proxy-config-http-server-ports>`_.
+
+.. ts:confvar:: CONFIG proxy.config.http.insert_request_via_str INT 1
+ :reloadable:
+
+ Set how the ``Via`` field is handled on a request to the origin server.
+
+===== ============================================
+Value Effect
+===== ============================================
+0 no extra information is added to the string.
+1 all extra information is added.
+2 some extra information is added.
+===== ============================================
+
+.. note:: the ``Via`` header string interpretation can be `decoded here. </tools/via>`_
+
+.. ts:confvar:: CONFIG proxy.config.http.insert_response_via_str INT 1
+ :reloadable:
+
+ Set how the ``Via`` field is handled on the response to the client.
+
+===== ======================
+Value Effect
+===== ======================
+0 no extra information is added to the string.
+1 all extra information is added.
+2 some extra information is added.
+===== ======================
+
+.. ts:confvar:: CONFIG proxy.config.http.response_server_enabled INT 1
+ :reloadable:
+
+ You can specify one of the following:
+
+ - ``0`` no Server: header is added to the response.
+ - ``1`` the Server: header is added (see string below).
+ - ``2`` the Server: header is added only if the response from rigin does not have one already.
+
+.. ts:confvar:: CONFIG proxy.config.http.insert_age_in_response INT 1
+ :reloadable:
+
+ This option specifies whether Traffic Server should insert an ``Age`` header in the response. The Age field value is the cache's
+ estimate of the amount of time since the response was generated or revalidated by the origin server.
+
+ - ``0`` no ``Age`` header is added
+ - ``1`` the ``Age`` header is added
+
+.. ts:confvar:: CONFIG proxy.config.http.response_server_str STRING ATS/
+ :reloadable:
+
+ The Server: string that ATS will insert in a response header (if requested, see above). Note that the current version number is
+ always appended to this string.
+
+.. ts:confvar:: CONFIG proxy.config.http.enable_url_expandomatic INT 1
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) ``.com`` domain expansion. This configures the Traffic Server to resolve unqualified hostnames by
+ prepending with ``www.`` and appending with ``.com`` before redirecting to the expanded address. For example: if a client makes
+ a request to ``host``, then Traffic Server redirects the request to ``www.host.com``.
+
+.. ts:confvar:: CONFIG proxy.config.http.chunking_enabled INT 1
+ :reloadable:
+
+ Specifies whether Traffic Sever can generate a chunked response:
+
+ - ``0`` Never
+ - ``1`` Always
+ - ``2`` Generate a chunked response if the server has returned HTTP/1.1 before
+ - ``3`` = Generate a chunked response if the client request is HTTP/1.1 and the origin server has returned HTTP/1.1 before
+
+ **Note:** If HTTP/1.1 is used, then Traffic Server can use
+ keep-alive connections with pipelining to origin servers. If
+ HTTP/0.9 is used, then Traffic Server does not use ``keep-alive``
+ connections to origin servers. If HTTP/1.0 is used, then Traffic
+ Server can use ``keep-alive`` connections without pipelining to
+ origin servers.
+
+.. ts:confvar:: CONFIG proxy.config.http.share_server_sessions INT 1
+
+ Enables (``1``) or disables (``0``) the reuse of server sessions.
+
+.. ts:confvar:: CONFIG proxy.config.http.record_heartbeat INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) ``traffic_cop`` heartbeat ogging.
+
+.. ts:confvar:: CONFIG proxy.config.http.use_client_target_addr INT 0
+
+ For fully transparent ports use the same origin server address as the client.
+
+This option causes Traffic Server to avoid where possible doing DNS
+lookups in forward transparent proxy mode. The option is only
+effective if the following three conditions are true -
+
+* Traffic Server is in forward proxy mode.
+* The proxy port is inbound transparent.
+* The target URL has not been modified by either remapping or a plugin.
+
+If any of these conditions are not true, then normal DNS processing
+is done for the connection.
+
+If all of these conditions are met, then the origin server IP
+address is retrieved from the original client connection, rather
+than through HostDB or DNS lookup. In effect, client DNS resolution
+is used instead of Traffic Server DNS.
+
+This can be used to be a little more efficient (looking up the
+target once by the client rather than by both the client and Traffic
+Server) but the primary use is when client DNS resolution can differ
+from that of Traffic Server. Two known uses cases are:
+
+#. Embedded IP addresses in a protocol with DNS load sharing. In
+ this case, even though Traffic Server and the client both make
+ the same request to the same DNS resolver chain, they may get
+ different origin server addresses. If the address is embedded in
+ the protocol then the overall exchange will fail. One current
+ example is Microsoft Windows update, which presumably embeds the
+ address as a security measure.
+
+#. The client has access to local DNS zone information which is not
+ available to Traffic Server. There are corporate nets with local
+ DNS information for internal servers which, by design, is not
+ propagated outside the core corporate network. Depending a
+ network topology it can be the case that Traffic Server can
+ access the servers by IP address but cannot resolve such
+ addresses by name. In such as case the client supplied target
+ address must be used.
+
+This solution must be considered interim. In the longer term, it
+should be possible to arrange for much finer grained control of DNS
+lookup so that wildcard domain can be set to use Traffic Server or
+client resolution. In both known use cases, marking specific domains
+as client determined (rather than a single global switch) would
+suffice. It is possible to do this crudely with this flag by
+enabling it and then use identity URL mappings to re-disable it for
+specific domains.
+
+Parent Proxy Configuration
+==========================
+
+.. ts:confvar:: CONFIG proxy.config.http.parent_proxy_routing_enable INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) the parent caching option. Refer to Hierarchical Caching <../hierachical-caching>_.
+
+.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.retry_time INT 300
+ :reloadable:
+
+ The amount of time allowed between connection retries to a parent cache that is unavailable.
+
+.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.fail_threshold INT 10
+ :reloadable:
+
+ The number of times the connection to the parent cache can fail before Traffic Server considers the parent unavailable.
+
+.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.total_connect_attempts INT 4
+ :reloadable:
+
+ The total number of connection attempts allowed to a parent cache before Traffic Server bypasses the parent or fails the request
+ (depending on the ``go_direct`` option in the :file:`bypass.config` file).
+
+.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.per_parent_connect_attempts INT 2
+ :reloadable:
+
+ The total number of connection attempts allowed per parent, if multiple parents are used.
+
+.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.connect_attempts_timeout INT 30
+ :reloadable:
+
+ The timeout value (in seconds) for parent cache connection attempts.
+
+.. ts:confvar:: CONFIG proxy.config.http.forward.proxy_auth_to_parent INT 0
+ :reloadable:
+
+ Configures Traffic Server to send proxy authentication headers on to the parent cache.
+
+HTTP Connection Timeouts
+========================
+
+.. ts:confvar:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_in INT 10
+ :reloadable:
+
+ Specifies how long Traffic Server keeps connections to clients open for a subsequent request after a transaction ends.
+
+.. ts:confvar:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_out INT 10
+ :reloadable:
+
+ Specifies how long Traffic Server keeps connections to origin servers open for a subsequent transfer of data after a transaction ends.
+
+.. ts:confvar:: CONFIG proxy.config.http.transaction_no_activity_timeout_in INT 120
+ :reloadable:
+
+ Specifies how long Traffic Server keeps connections to clients open if a transaction stalls.
+
+.. ts:confvar:: CONFIG proxy.config.http.transaction_no_activity_timeout_out INT 120
+ :reloadable:
+
+ Specifies how long Traffic Server keeps connections to origin servers open if the transaction stalls.
+
+.. ts:confvar:: CONFIG proxy.config.http.transaction_active_timeout_in INT 0
+ :reloadable:
+
+ The maximum amount of time Traffic Server can remain connected to a client. If the transfer to the client is not complete before this
+ timeout expires, then Traffic Server closes the connection.
+
+The default value of ``0`` specifies that there is no timeout.
+
+.. ts:confvar:: CONFIG proxy.config.http.transaction_active_timeout_out INT 0
+ :reloadable:
+
+ The maximum amount of time Traffic Server waits for fulfillment of a connection request to an origin server. If Traffic Server does not
+ complete the transfer to the origin server before this timeout expires, then Traffic Server terminates the connection request.
+
+The default value of ``0`` specifies that there is no timeout.
+
+.. ts:confvar:: CONFIG proxy.config.http.accept_no_activity_timeout INT 120
+ :reloadable:
+
+ The timeout interval in seconds before Traffic Server closes a connection that has no activity.
+
+.. ts:confvar:: CONFIG proxy.config.http.background_fill_active_timeout INT 60
+ :reloadable:
+
+ Specifies how long Traffic Server continues a background fill before giving up and dropping the origin server connection.
+
+.. ts:confvar:: CONFIG proxy.config.http.background_fill_completed_threshold FLOAT 0.50000
+ :reloadable:
+
+ The proportion of total document size already transferred when a client aborts at which the proxy continues fetching the document
+ from the origin server to get it into the cache (a **background fill**).
+
+Origin Server Connect Attempts
+==============================
+
+.. ts:confvar:: CONFIG proxy.config.http.connect_attempts_max_retries INT 6
+ :reloadable:
+
+ The maximum number of connection retries Traffic Server can make when the origin server is not responding.
+
+.. ts:confvar:: CONFIG proxy.config.http.connect_attempts_max_retries_dead_server INT 2
+ :reloadable:
+
+ The maximum number of connection retries Traffic Server can make when the origin server is unavailable.
+
+.. ts:confvar:: CONFIG proxy.config.http.server_max_connections INT 0
+ :reloadable:
+
+ Limits the number of socket connections across all origin servers to the value specified. To disable, set to zero (``0``).
+
+.. ts:confvar:: CONFIG proxy.config.http.origin_max_connections INT 0
+ :reloadable:
+
+ Limits the number of socket connections per origin server to the value specified. To enable, set to one (``1``).
+
+.. ts:confvar:: CONFIG proxy.config.http.origin_min_keep_alive_connections INT 0
+ :reloadable:
+
+ As connection to an origin server are opened, keep at least 'n' number of connections open to that origin, even if the connection
+ isn't used for a long time period. Useful when the origin supports keep-alive, removing the time needed to set up a new connection from
+ the next request at the expense of added (inactive) connections. To enable, set to one (``1``).
+
+.. ts:confvar:: CONFIG proxy.config.http.connect_attempts_rr_retries INT 2
+ :reloadable:
+
+ The maximum number of failed connection attempts allowed before a round-robin entry is marked as 'down' if a server has round-robin DNS entries.
+
+.. ts:confvar:: CONFIG proxy.config.http.connect_attempts_timeout INT 30
+ :reloadable:
+
+ The timeout value (in seconds) for an origin server connection.
+
+.. ts:confvar:: CONFIG proxy.config.http.post_connect_attempts_timeout INT 1800
+ :reloadable:
+
+ The timeout value (in seconds) for an origin server connection when the client request is a ``POST`` or ``PUT`` request.
+
+.. ts:confvar:: CONFIG proxy.config.http.down_server.cache_time INT 900
+ :reloadable:
+
+ Specifies how long (in seconds) Traffic Server remembers that an origin server was unreachable.
+
+.. ts:confvar:: CONFIG proxy.config.http.down_server.abort_threshold INT 10
+ :reloadable:
+
+ The number of seconds before Traffic Server marks an origin server as unavailable after a client abandons a request because the origin
+ server was too slow in sending the response header.
+
+Congestion Control
+==================
+
+.. ts:confvar:: CONFIG proxy.config.http.congestion_control.enabled INT 0
+
+ Enables (``1``) or disables (``0``) the Congestion Control option, which configures Traffic Server to stop forwarding HTTP requests to
+ origin servers when they become congested. Traffic Server sends the client a message to retry the congested origin server later. Refer
+ to `Using Congestion Control <../http-proxy-caching#UsingCongestionControl>`_.
+
+Negative Response Caching
+=========================
+
+.. ts:confvar:: CONFIG proxy.config.http.negative_caching_enabled INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server caches negative responses (such as ``404 Not Found``) when a requested page does not exist. The next
+ time a client requests the same page, Traffic Server serves the negative response directly from cache.
+
+ **Note**: ``Cache-Control`` directives from the server forbidding ache are ignored for the following HTTP response codes, regardless
+ of the value specified for the `proxy.config.http.negative_caching_enabled`_ variable. The
+ following negative responses are cached by Traffic Server:::
+
+ 204 No Content
+ 305 Use Proxy
+ 400 Bad Request
+ 403 Forbidden
+ 404 Not Found
+ 405 Method Not Allowed
+ 500 Internal Server Error
+ 501 Not Implemented
+ 502 Bad Gateway
+ 503 Service Unavailable
+ 504 Gateway Timeout
+
+Proxy User Variables
+====================
+
+.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_from INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server removes the ``From`` header to protect the privacy of your users.
+
+.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_referer INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server removes the ``Referrer`` header to protect the privacy of your site and users.
+
+.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_user_agent INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server removes the ``User-agent`` header to protect the privacy of your site and users.
+
+.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_cookie INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server removes the ``Cookie`` header to protect the privacy of your site and users.
+
+.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_client_ip INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server removes ``Client-IP`` headers for more privacy.
+
+.. ts:confvar:: CONFIG proxy.config.http.anonymize_insert_client_ip INT 1
+ :reloadable:
+
+ When enabled (``1``), Traffic Server inserts ``Client-IP`` headers to retain the client IP address.
+
+.. ts:confvar:: CONFIG proxy.config.http.append_xforwards_header INT 0
+
+ When enabled (``1``), Traffic Server appends ``X-Forwards`` headers to outgoing requests.
+
+.. ts:confvar:: CONFIG proxy.config.http.anonymize_other_header_list STRING NULL
+ :reloadable:
+
+ The headers Traffic Server should remove from outgoing requests.
+
+.. ts:confvar:: CONFIG proxy.config.http.insert_squid_x_forwarded_for INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server adds the client IP address to the ``X-Forwarded-For`` header.
+
+.. ts:confvar:: CONFIG proxy.config.http.normalize_ae_gzip INT 0
+ :reloadable:
+
+ Enable (``1``) to normalize all ``Accept-Encoding:`` headers to one of the following:
+
+ - ``Accept-Encoding: gzip`` (if the header has ``gzip`` or ``x-gzip`` with any ``q``) **OR**
+ - *blank* (for any header that does not include ``gzip``)
+
+ This is useful for minimizing cached alternates of documents (e.g. ``gzip, deflate`` vs. ``deflate, gzip``). Enabling this option is
+ recommended if your origin servers use no encodings other than ``gzip``.
+
+Security
+========
+
+.. ts:confvar:: CONFIG proxy.config.http.push_method_enabled INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) the HTTP ``PUSH`` option, which allows you to deliver content directly to the cache without a user
+ request.
+
+ **Important:** If you enable this option, then you must also specify
+ a filtering rule in the ip_allow.config file to allow only certain
+ machines to push content into the cache.
+
+Cache Control
+=============
+
+.. ts:confvar:: CONFIG proxy.config.cache.enable_read_while_writer INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) ability to a read cached object while the another connection is completing the write to cache for
+ the same object.
+
+.. ts:confvar:: CONFIG proxy.config.cache.force_sector_size INT 512
+ :reloadable:
+
+ Forces the use of a specific hardware sector size (512 - 8192 bytes).
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.http INT 1
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) caching of HTTP requests.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_client_no_cache INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server ignores client requests to bypass the cache.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.ims_on_client_no_cache INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server issues a conditional request to the origin server if an incoming request has a ``No-Cache`` header.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_server_no_cache INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server ignores origin server requests to bypass the cache.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.cache_responses_to_cookies INT 3
+ :reloadable:
+
+ Specifies how cookies are cached:
+
+ - ``0`` = do not cache any responses to cookies
+ - ``1`` = cache for any content-type
+ - ``2`` = cache only for image types
+ - ``3`` = cache for all but text content-types
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_authentication INT 0
+
+ When enabled (``1``), Traffic Server ignores ``WWW-Authentication`` headers in responses ``WWW-Authentication`` headers are removed and
+ not cached.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.cache_urls_that_look_dynamic INT 1
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in *``.asp``* or contain a question
+ mark (*``?``*), a semicolon (*``;``*), or *``cgi``*. For a full list, please refer to
+ `HttpTransact::url_looks_dynamic </link/to/doxygen>`_
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.enable_default_vary_headers INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) caching of alternate versions of HTTP objects that do not contain the ``Vary`` header.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.when_to_revalidate INT 0
+ :reloadable:
+
+ Specifies when to revalidate content:
+
+ - ``0`` = use cache directives or heuristic (the default value)
+ - ``1`` = stale if heuristic
+ - ``2`` = always stale (always revalidate)
+ - ``3`` = never stale
+ - ``4`` = use cache directives or heuristic (0) unless the request
+ has an ``If-Modified-Since`` header
+
+ If the request contains the ``If-Modified-Since`` header, then
+ Traffic Server always revalidates the cached content and uses the
+ client's ``If-Modified-Since`` header for the proxy request.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.when_to_add_no_cache_to_msie_requests INT 0
+ :reloadable:
+
+ Specifies when to add ``no-cache`` directives to Microsoft Internet Explorer requests. You can specify the following:
+
+ - ``0`` = ``no-cache`` is *not* added to MSIE requests
+ - ``1`` = ``no-cache`` is added to IMS MSIE requests
+ - ``2`` = ``no-cache`` is added to all MSIE requests
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.required_headers INT 0
+ :reloadable:
+
+ The type of headers required in a request for the request to be cacheable.
+
+ - ``0`` = no headers required to make document cacheable
+ - ``1`` = either the ``Last-Modified`` header, or an explicit lifetime header, ``Expires`` or ``Cache-Control: max-age``, is required
+ - ``2`` = explicit lifetime is required, ``Expires`` or ``Cache-Control: max-age``
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.max_stale_age INT 604800
+ :reloadable:
+
+ The maximum age allowed for a stale response before it cannot be cached.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.range.lookup INT 1
+
+ When enabled (``1``), Traffic Server looks up range requests in the cache.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.enable_read_while_writer INT 0
+
+ Enables (``1``) or disables (``0``) the ability to read a cached object while another connection is completing a write to cache
+ for the same object.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.fuzz.min_time INT 0
+ :reloadable:
+
+ Sets a minimum fuzz time; the default value is ``0``. **Effective fuzz time** is a calculation in the range
+ (``fuzz.min_time`` - ``fuzz.min_time``).
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_accept_mismatch INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server serves documents from cache with a ``Content-Type:`` header that does not match the ``Accept:``
+ header of the request.
+
+ **Note:** This option should only be enabled if you're having
+ problems with caching *and* one of the following is true:
+
+ - Your origin server sets ``Vary: Accept`` when doing content negotiation with ``Accept`` *OR*
+ - The server does not send a ``406 (Not Acceptable)`` response for types that it cannot serve.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_accept_language_mismatch INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server serves documents from cache with a ``Content-Language:`` header that does not match the
+ ``Accept-Language:`` header of the request.
+
+ **Note:** This option should only be enabled if you're having
+ problems with caching and your origin server is guaranteed to set
+ ``Vary: Accept-Language`` when doing content negotiation with
+ ``Accept-Language``.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_accept_charset_mismatch INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server serves documents from cache with a ``Content-Type:`` header that does not match the
+ ``Accept-Charset:`` header of the request.
+
+ **Note:** This option should only be enabled if you're having
+ problems with caching and your origin server is guaranteed to set
+ ``Vary: Accept-Charset`` when doing content negotiation with
+ ``Accept-Charset``.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_client_cc_max_age INT 1
+ :reloadable:
+
+ When enabled (``1``), Traffic Server ignores any ``Cache-Control: max-age`` headers from the client.
+
+.. ts:confvar:: CONFIG proxy.config.cache.permit.pinning INT 0
+ :reloadable:
+
+ When enabled (``1``), Traffic Server will keep certain HTTP objects in the cache for a certain time as specified in cache.config.
+
+Heuristic Expiration
+====================
+
+.. ts::confvar:: proxy.config.http.cache.heuristic_min_lifetime INT 3600
+ :reloadable:
+
+ The minimum amount of time an HTTP object without an expiration date can remain fresh in the cache before is considered to be stale.
+
+.. ts::confvar:: proxy.config.http.cache.heuristic_max_lifetime INT 86400
+ :reloadable:
+
+ The maximum amount of time an HTTP object without an expiration date can remain fresh in the cache before is considered to be stale.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.heuristic_lm_factor FLOAT 0.10000
+ :reloadable:
+
+ The aging factor for freshness computations. Traffic Server stores an object for this percentage of the time that elapsed since it last
+ changed.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.fuzz.time INT 240
+ :reloadable:
+
+ How often Traffic Server checks for an early refresh, during the period before the document stale time. The interval specified must
+ be in seconds.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.fuzz.probability FLOAT 0.00500
+ :reloadable:
+
+ The probability that a refresh is made on a document during the specified fuzz time.
+
+Dynamic Content & Content Negotiation
+=====================================
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.vary_default_text STRING NULL
+ :reloadable:
+
+ The header on which Traffic Server varies for text documents.
+
+For example: if you specify ``User-agent``, then Traffic Server caches
+all the different user-agent versions of documents it encounters.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.vary_default_images STRING NULL
+ :reloadable:
+
+ The header on which Traffic Server varies for images.
+
+.. ts:confvar:: CONFIG proxy.config.http.cache.vary_default_other STRING NULL
+ :reloadable:
+
+ The header on which Traffic Server varies for anything other than text and images.
+
+Customizable User Response Pages
+================================
+
+.. ts:confvar:: CONFIG proxy.config.body_factory.enable_customizations INT 0
+ Specifies whether customizable response pages are enabled or
+ disabled and which response pages are used:
+
+ - ``0`` = disable customizable user response pages
+ - ``1`` = enable customizable user response pages in the default directory only
+ - ``2`` = enable language-targeted user response pages
+
+.. ts:confvar:: CONFIG proxy.config.body_factory.enable_logging INT 1
+
+ Enables (``1``) or disables (``0``) logging for customizable response pages. When enabled, Traffic Server records a message in
+ the error log each time a customized response page is used or modified.
+
+.. ts:confvar:: CONFIG proxy.config.body_factory.template_sets_dir STRING config/body_factory
+
+ The customizable response page default directory.
+
+.. ts:confvar:: CONFIG proxy.config.body_factory.response_suppression_mode INT 0
+
+ Specifies when Traffic Server suppresses generated response pages:
+
+ - ``0`` = never suppress generated response pages
+ - ``1`` = always suppress generated response pages
+ - ``2`` = suppress response pages only for intercepted traffic
+
+DNS
+===
+
+.. ts:confvar:: CONFIG proxy.config.dns.search_default_domains INT 1
+ :Reloadable:
+
+ Enables (``1``) or disables (``0``) local domain expansion.
+
+Traffic Server can attempt to resolve unqualified hostnames by
+expanding to the local domain. For example if a client makes a
+request to an unqualified host (``host_x``) and the Traffic Server
+local domain is ``y.com`` , then Traffic Server will expand the
+hostname to ``host_x.y.com``.
+
+.. ts:confvar:: CONFIG proxy.config.dns.splitDNS.enabled INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) DNS server selection. When enabled, Traffic Server refers to the :file:`splitdns.config` file for
+ the selection specification. Refer to `Configuring DNS Server Selection (Split DNS) <../security-options#ConfiguringDNSServerSelectionSplit>`_.
+
+.. ts:confvar:: CONFIG proxy.config.dns.url_expansions STRING NULL
+
+ Specifies a list of hostname extensions that are automatically added to the hostname after a failed lookup. For example: if you want
+ Traffic Server to add the hostname extension .org, then specify ``org`` as the value for this variable (Traffic Server automatically
+ adds the dot (.)).
+
+ **Note:** If the variable
+ `proxy.config.http.enable_url_expandomatic`_ is set to ``1`` (the default value), then you do not have to add *``www.``* and
+ *``.com``* to this list because Traffic Server automatically tries www. and .com after trying the values you've specified.
+
+.. ts:confvar:: CONFIG proxy.config.dns.resolv_conf STRING /etc/resolv.conf
+
+ Allows to specify which ``resolv.conf`` file to use for finding resolvers. While the format of this file must be the same as the
+ standard ``resolv.conf`` file, this option allows an administrator to manage the set of resolvers in an external configuration file,
+ without affecting how the rest of the operating system uses DNS.
+
+.. ts:confvar:: CONFIG proxy.config.dns.round_robin_nameservers INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) DNS server round-robin.
+
+.. ts:confvar:: CONFIG proxy.config.dns.nameservers STRING NULL
+ :reloadable:
+
+ The DNS servers.
+
+.. ts:confvar:: CONFIG proxy.config.srv_enabled INT 0
+ :reloadable:
+
+ Indicates whether to use SRV records for orgin server lookup.
+
+HostDB
+======
+
+.. ts:confvar:: CONFIG proxy.config.hostdb.serve_stale_for INT
+
+ The number of seconds for which to use a stale NS record while initiating a background fetch for the new data.
+
+.. ts:confvar:: CONFIG proxy.config.hostdb.storage_size INT 33554432
+
+ The amount of space (in bytes) used to store ``hostdb``.
+ The value of this variable must be increased if you increase the size of the
+ `proxy.config.hostdb.size`_ variable.
+
+.. ts:confvar:: CONFIG proxy.config.hostdb.size INT 200000
+
+ The maximum number of entries that can be stored in the database.
+
+.. note::
+
+ For values above ``200000``, you must increase the value of the `proxy.config.hostdb.storage_size`_ variable by at least 44 bytes per entry.
+
+.. ts:confvar:: CONFIG proxy.config.hostdb.ttl_mode INT 0
+ :reloadable:
+
+ The host database time to live mode. You can specify one of the
+ following:
+
+ - ``0`` = obey
+ - ``1`` = ignore
+ - ``2`` = min(X,ttl)
+ - ``3`` = max(X,ttl)
+
+.. ts:confvar:: CONFIG proxy.config.hostdb.timeout INT 1440
+ :reloadable:
+
+ The foreground timeout (in minutes).
+
+.. ts:confvar:: CONFIG proxy.config.hostdb.strict_round_robin INT 0
+ :reloadable:
+
+ When disabled (``0``), Traffic Server always uses the same origin
+ server for the same client, for as long as the origin server is
+ available.
+
+Logging Configuration
+=====================
+
+.. ts:confvar:: CONFIG proxy.config.log.logging_enabled INT 3
+ :reloadable:
+
+ Enables and disables event logging:
+
+ - ``0`` = logging disabled
+ - ``1`` = log errors only
+ - ``2`` = log transactions only
+ - ``3`` = full logging (errors + transactions)
+
+ Refer to `Working with Log Files <../working-log-files>`_.
+
+.. ts:confvar:: CONFIG proxy.config.log.max_secs_per_buffer INT 5
+ :reloadable:
+
+ The maximum amount of time before data in the buffer is flushed to disk.
+
+.. ts:confvar:: CONFIG proxy.config.log.max_space_mb_for_logs INT 2000
+ :reloadable:
+
+ The amount of space allocated to the logging directory (in MB).
+ **Note:** All files in the logging directory contribute to the space used, even if they are not log files. In collation client mode, if
+ there is no local disk logging, or max_space_mb_for_orphan_logs is set to a higher value than max_space_mb_for_logs, TS will
+ take proxy.config.log.max_space_mb_for_orphan_logs for maximum allowed log space.
+
+.. ts:confvar:: CONFIG proxy.config.log.max_space_mb_for_orphan_logs INT 25
+ :reloadable:
+
+ The amount of space allocated to the logging directory (in MB) if this node is acting as a collation client.
+
+ **Note:** When max_space_mb_for_orphan_logs is take as the maximum allowedlog space in the logging system, the same rule apply to
+ proxy.config.log.max_space_mb_for_logs also apply to proxy.config.log.max_space_mb_for_orphan_logs, ie: All files in
+ the logging directory contribute to the space used, even if they are not log files. you may need to consider this when you enable full
+ remote logging, and bump to the same size as proxy.config.log.max_space_mb_for_logs.
+
+.. ts:confvar:: CONFIG proxy.config.log.max_space_mb_headroom INT 10
+ :reloadable:
+
+ The tolerance for the log space limit (in bytes). If the variable `proxy.config.log.auto_delete_rolled_files`_ is set to ``1``
+ (enabled), then autodeletion of log files is triggered when the amount of free space available in the logging directory is less than
+ the value specified here.
+
+.. ts:confvar:: CONFIG proxy.config.log.hostname STRING localhost
+ :reloadable:
+
+ The hostname of the machine running Traffic Server.
+
+.. ts:confvar:: CONFIG proxy.config.log.logfile_dir STRING install_dir\ ``/logs``
+ :reloadable:
+
+ The full path to the logging directory. This can be an absolute path or a path relative to the directory in which Traffic Server is installed.
+
+ **Note:** The directory you specify must already exist.
+
+.. ts:confvar:: CONFIG proxy.config.log.logfile_perm STRING rw-r--r--
+ :reloadable:
+
+ The log file permissions. The standard UNIX file permissions are used (owner, group, other). Permissible values are:
+
+ ``-`` no permission ``r`` read permission ``w`` write permission ``x`` execute permission
+
+ Permissions are subject to the umask settings for the Traffic Server process. This means that a umask setting of\ ``002`` will not allow
+ write permission for others, even if specified in the configuration file. Permissions for existing log files are not changed when the
+ configuration is changed.
+
+.. ts:confvar:: CONFIG proxy.config.log.custom_logs_enabled INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) custom logging.
+
+.. ts:confvar:: CONFIG proxy.config.log.squid_log_enabled INT 1
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) the `squid log file format <../working-log-files/log-formats#SquidFormat>`_.
+
+.. ts:confvar:: CONFIG proxy.config.log.squid_log_is_ascii INT 1
+ :reloadable:
+
+ The squid log file type:
+
+ - ``1`` = ASCII
+ - ``0`` = binary
+
+.. ts:confvar:: CONFIG proxy.config.log.squid_log_name STRING squid
+ :reloadable:
+
+ The `squid log <../working-log-files/log-formats#SquidFormat>`_ filename.
+
+.. ts:confvar:: CONFIG proxy.config.log.squid_log_header STRING NULL
+
+ The `squid log <../working-log-files/log-formats#SquidFormat>`_ file header text.
+
+.. ts:confvar:: CONFIG proxy.config.log.common_log_enabled INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) the `Netscape common log file format <../working-log-files/log-formats#NetscapeFormats>`_.
+
+.. ts:confvar:: CONFIG proxy.config.log.common_log_is_ascii INT 1
+ :reloadable:
+
+ The `Netscape common log <../working-log-files/log-formats#NetscapeFormats>`_ file type:
+
+ - ``1`` = ASCII
+ - ``0`` = binary
+
+.. ts:confvar:: CONFIG proxy.config.log.common_log_name STRING common
+ :reloadable:
+
+ The `Netscape common log <../working-log-files/log-formats#NetscapeFormats>`_ filename.
+
+.. ts:confvar:: CONFIG proxy.config.log.common_log_header STRING NULL
+ :reloadable:
+
+ The `Netscape common log <../working-log-files/log-formats#NetscapeFormats>`_ file header text.
+
+.. ts:confvar:: CONFIG proxy.config.log.extended_log_enabled INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) the `Netscape extended log file format <../working-log-files/log-formats#NetscapeFormats>`_.
+
+.. ts:confvar:: CONFIG proxy.confg.log.extended_log_is_ascii INT 1
+
+ The `Netscape extended log <../working-log-files/log-formats#NetscapeFormats>`_ file type:
+
+ - ``1`` = ASCII
+ - ``0`` = binary
+
+.. ts:confvar:: CONFIG proxy.config.log.extended_log_name STRING extended
+
+ The `Netscape extended log <../working-log-files/log-formats#NetscapeFormats>`_ filename.
+
+.. ts:confvar:: CONFIG proxy.config.log.extended_log_header STRING NULL
+ :reloadable:
+
+ The `Netscape extended log <../working-log-files/log-formats#NetscapeFormats>`_ file header text.
+
+.. ts:confvar:: CONFIG proxy.config.log.extended2_log_enabled INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) the `Netscape Extended-2 log file format <../working-log-files/log-formats#NetscapeFormats>`_.
+
+.. ts:confvar:: CONFIG proxy.config.log.extended2_log_is_ascii INT 1
+ :reloadable:
+
+ The `Netscape Extended-2 log <../working-log-files/log-formats#NetscapeFormats>`_ file type:
+
+ - ``1`` = ASCII
+ - ``0`` = binary
+
+.. ts:confvar:: CONFIG proxy.config.log.extended2_log_name STRING extended2
+ :reloadable:
+
+ The `Netscape Extended-2 log <../working-log-files/log-formats#NetscapeFormats>`_ filename.
+
+.. ts:confvar:: CONFIG proxy.config.log.extended2_log_header STRING NULL
+ :reloadable:
+
+ The `Netscape Extended-2 log <../working-log-files/log-formats#NetscapeFormats>`_ file header text.
+
+.. ts:confvar:: CONFIG proxy.config.log.separate_icp_logs INT 0
+ :reloadable:
+
+ When enabled (``1``), configures Traffic Server to store ICP transactions in a separate log file.
+
+ - ``0`` = separation is disabled, all ICP transactions are recorded in the same file as HTTP transactions
+ - ``1`` = all ICP transactions are recorded in a separate log file.
+ - ``-1`` = filter all ICP transactions from the default log files; ICP transactions are not logged anywhere.
+
+.. ts:confvar:: CONFIG proxy.config.log.separate_host_logs INT 0
+ :reloadable:
+
+ When enabled (``1``), configures Traffic Server to create a separate log file for HTTP transactions for each origin server listed in the
+ :file:`log_hosts.config` file. Refer to `HTTP Host Log Splitting <../working-log-files#HTTPHostLogSplitting>`_.
+
+.. ts:confvar:: LOCAL proxy.local.log.collation_mode INT 0
+ :reloadable:
+
+ Set the log collation mode.
+
+===== ======
+Value Effect
+===== ======
+0 collation is disabled
+1 this host is a log collation server
+2 this host is a collation client and sends entries using standard formats to the collation server
+3 this host is a collation client and sends entries using the traditional custom formats to the collation server
+4 this host is a collation client and sends entries that use both the standard and traditional custom formats to the collation server
+===== ======
+
+For information on sending XML-based custom formats to the collation
+server, refer to `logs_xml.config <logs_xml.config>`_.
+
+.. note:: Although Traffic Server supports traditional custom logging, you should use the more versatile XML-based custom formats.
+
+.. ts:confvar:: proxy.confg.log.collation_host STRING NULL
+
+ The hostname of the log collation server.
+
+.. ts:confvar:: CONFIG proxy.config.log.collation_port INT 8085
+ :reloadable:
+
+ The port used for communication between the collation server and client.
+
+.. ts:confvar:: CONFIG proxy.config.log.collation_secret STRING foobar
+ :reloadable:
+
+ The password used to validate logging data and prevent the exchange of unauthorized information when a collation server is being used.
+
+.. ts:confvar:: CONFIG proxy.config.log.collation_host_tagged INT 0
+ :reloadable:
+
+ When enabled (``1``), configures Traffic Server to include the hostname of the collation client that generated the log entry in each entry.
+
+.. ts:confvar:: CONFIG proxy.config.log.collation_retry_sec INT 5
+ :reloadable:
+
+ The number of seconds between collation server connection retries.
+
+.. ts:confvar:: CONFIG proxy.config.log.rolling_enabled INT 1
+ :reloadable:
+
+ Specifies how log files are rolled. You can specify the following values:
+
+ - ``0`` = disables log file rolling
+ - ``1`` = enables log file rolling at specific intervals during the day (specified with the
+ `proxy.config.log.rolling_interval_sec`_ and `proxy.config.log.rolling_offset_hr`_ variables)
+ - ``2`` = enables log file rolling when log files reach a specific size (specified with the `proxy.config.log.rolling_size_mb`_ variable)
+ - ``3`` = enables log file rolling at specific intervals during the day or when log files reach a specific size (whichever occurs first)
+ - ``4`` = enables log file rolling at specific intervals during the day when log files reach a specific size (i.e., at a specified
+ time if the file is of the specified size)
+
+.. ts:confvar:: CONFIG proxy.config.log.rolling_interval_sec INT 86400
+ :reloadable:
+
+ The log file rolling interval, in seconds. The minimum value is ``300`` (5 minutes). The maximum, and default, value is 86400 seconds (one day).
+
+ **Note:** If you start Traffic Server within a few minutes of the next rolling time, then rolling might not occur until the next rolling time.
+
+.. ts:confvar:: CONFIG proxy.config.log.rolling_offset_hr INT 0
+ :reloadable:
+
+ The file rolling offset hour. The hour of the day that starts the log rolling period.
+
+.. ts:confvar:: CONFIG proxy.config.log.rolling_size_mb INT 10
+ :reloadable:
+
+ The size that log files must reach before rolling takes place.
+
+.. ts:confvar:: CONFIG proxy.config.log.auto_delete_rolled_files INT 1
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) automatic deletion of rolled files.
+
+.. ts:confvar:: CONFIG proxy.config.log.sampling_frequency INT 1
+ :reloadable:
+
+ Configures Traffic Server to log only a sample of transactions rather than every transaction. You can specify the following values:
+
+ - ``1`` = log every transaction
+ - ``2`` = log every second transaction
+ - ``3`` = log every third transaction and so on...
+
+.. ts:confvar:: CONFIG proxy.config.http.slow.log.threshold INT 0
+ :reloadable:
+
+ The number of milliseconds before a slow connection's debugging stats are dumped. Specify ``1`` to enable or ``0`` to disable.
+
+Diagnostic Logging Configuration
+================================
+
+.. ts:confvar:: CONFIG proxy.config.diags.output.status STRING
+.. ts:confvar:: CONFIG proxy.config.diags.output.warning STRING
+.. ts:confvar:: CONFIG proxy.config.diags.output.emergency STRING
+
+ control where Traffic Server should log diagnostic output. Messages at diagnostic level can be directed to any combination of diagnostic
+ destinations. Valid diagnostic message destinations are:::
+
+ * 'O' = Log to standard output
+ * 'E' = Log to standard error
+ * 'S' = Log to syslog
+ * 'L' = Log to diags.log
+
+.. topic:: Example
+
+ To log debug diagnostics to both syslog and diags.log:::
+
+ proxy.config.diags.output.debug STRING SL
+
+Reverse Proxy
+=============
+
+.. ts:confvar:: CONFIG proxy.config.reverse_proxy.enabled INT 1
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) HTTP reverse proxy.
+
+.. ts:confvar:: CONFIG proxy.config.header.parse.no_host_url_redirect STRING NULL
+ :reloadable:
+
+ The URL to which to redirect requests with no host headers (reverse
+ proxy).
+
+URL Remap Rules
+===============
+
+.. ts:confvar:: CONFIG proxy.config.url_remap.default_to_server_pac INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) requests for a PAC file on the proxy service port (8080 by default) to be redirected to the PAC
+ port. For this type of redirection to work, the variable `proxy.config.reverse_proxy.enabled`_ must be set to ``1``.
+
+.. ts:confvar:: CONFIG proxy.config.url_remap.default_to_server_pac_port INT -1
+ :reloadable:
+
+ Sets the PAC port so that PAC requests made to the Traffic Server
+ proxy service port are redirected this port. ``-1`` is the default
+ setting that sets the PAC port to the autoconfiguration port (the
+ default autoconfiguration port is 8083). This variable can be used
+ together with the `proxy.config.url_remap.default_to_server_pac`_
+ variable to get a PAC file from a different port. You must create
+ and run a process that serves a PAC file on this port. For example:
+ if you create a Perl script that listens on port 9000 and writes a
+ PAC file in response to any request, then you can set this variable
+ to ``9000``. Browsers that request the PAC file from a proxy server
+ on port 8080 will get the PAC file served by the Perl script.
+
+.. ts:confvar:: CONFIG proxy.config.url_remap.remap_required INT 1
+ :reloadable:
+
+ Set this variable to ``1`` if you want Traffic Server to serve
+ requests only from origin servers listed in the mapping rules of the
+ :file:`remap.config` file. If a request does not match, then the browser
+ will receive an error.
+
+.. ts:confvar:: CONFIG proxy.config.url_remap.pristine_host_hdr INT 1
+ :reloadable:
+
+ Set this variable to ``1`` if you want to retain the client host
+ header in a request during remapping.
+
+SSL Termination
+===============
+
+.. ts:confvar:: CONFIG proxy.config.ssl.SSLv2 INT 0
+
+ Enables (``1``) or disables (``0``) SSLv2. Please don't enable it.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.SSLv3 INT 1
+
+ Enables (``1``) or disables (``0``) SSLv3.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.TLSv1 INT 1
+
+ Enables (``1``) or disables (``0``) TLSv1.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.client.certification_level INT 0
+
+ Sets the client certification level:
+
+ - ``0`` = no client certificates are required. Traffic Server does
+ not verify client certificates during the SSL handshake. Access
+ to Traffic Server depends on Traffic Server configuration options
+ (such as access control lists).
+
+ - ``1`` = client certificates are optional. If a client has a
+ certificate, then the certificate is validated. If the client
+ does not have a certificate, then the client is still allowed
+ access to Traffic Server unless access is denied through other
+ Traffic Server configuration options.
+
+ - ``2`` = client certificates are required. The client must be
+ authenticated during the SSL handshake. Clients without a
+ certificate are not allowed to access Traffic Server.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.server.cert.path STRING /config
+
+ The location of the SSL certificates and chains used for accepting
+ and validation new SSL sessions. If this is a relative path,
+ it is appended to the Traffic Server installation PREFIX. All
+ certificates and certificate chains listed in
+ :file:`ssl_multicert.config` will be loaded relative to this path.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.server.private_key.path STRING NULL
+
+ The location of the SSL certificate private keys. Change this
+ variable only if the private key is not located in the SSL
+ certificate file. All private keys listed in
+ :file:`ssl_multicert.config` will be loaded relative to this
+ path.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.server.cert_chain.filename STRING NULL
+
+ The name of a file containing a global certificate chain that
+ should be used with every server certificate. This file is only
+ used if there are certificates defined in :file:`ssl_multicert.conf`.
+ Unless this is an absolute path, it is loaded relative to the
+ path specified by `proxy.config.ssl.server.cert.path`_.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.CA.cert.path STRING NULL
+
+ The location of the certificate authority file that client
+ certificates will be verified against.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.CA.cert.filename STRING NULL
+
+ The filename of the certificate authority that client certificates
+ will be verified against.
+
+Client-Related Configuration
+----------------------------
+
+.. ts:confvar:: CONFIG proxy.config.ssl.client.verify.server INT 0
+
+ Configures Traffic Server to verify the origin server certificate
+ with the Certificate Authority (CA).
+
+.. ts:confvar:: CONFIG proxy.config.ssl.client.cert.filename STRING NULL
+
+ The filename of SSL client certificate installed on Traffic Server.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.client.cert.path STRING /config
+
+ The location of the SSL client certificate installed on Traffic
+ Server.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.client.private_key.filename STRING NULL
+
+ The filename of the Traffic Server private key. Change this variable
+ only if the private key is not located in the Traffic Server SSL
+ client certificate file.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.client.private_key.path STRING NULL
+
+ The location of the Traffic Server private key. Change this variable
+ only if the private key is not located in the SSL client certificate
+ file.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.client.CA.cert.filename STRING NULL
+
+ The filename of the certificate authority against which the origin
+ server will be verified.
+
+.. ts:confvar:: CONFIG proxy.config.ssl.client.CA.cert.path STRING NULL
+
+ Specifies the location of the certificate authority file against
+ which the origin server will be verified.
+
+ICP Configuration
+=================
+
+.. ts:confvar:: CONFIG proxy.config.icp.enabled INT 0
+
+ Sets ICP mode for hierarchical caching:
+
+ - ``0`` = disables ICP
+ - ``1`` = allows Traffic Server to receive ICP queries only
+ - ``2`` = allows Traffic Server to send and receive ICP queries
+
+ Refer to `ICP Peering <../hierachical-caching#ICPPeering>`_.
+
+.. ts:confvar:: CONFIG proxy.config.icp.icp_interface STRING your_interface
+
+ Specifies the network interface used for ICP traffic.
+
+ **Note:** The Traffic Server installation script detects your
+ network interface and sets this variable appropriately. If your
+ system has multiple network interfaces, check that this variable
+ specifies the correct interface.
+
+.. ts:confvar:: CONFIG proxy.config.icp.icp_port INT 3130
+ :reloadable:
+
+ Specifies the UDP port that you want to use for ICP messages.
+
+.. ts:confvar:: CONFIG proxy.config.icp.query_timeout INT 2
+ :reloadable:
+
+ Specifies the timeout used for ICP queries.
+
+Scheduled Update Configuration
+==============================
+
+.. XXX this is missing something:
+
+ ``INT``
+ ``0``
+ Enables (``1``) or disables (``0``) the Scheduled Update option.
+
+.. ts:confvar:: CONFIG proxy.config.update.force INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) a force immediate update. When
+ enabled, Traffic Server overrides the scheduling expiration time for
+ all scheduled update entries and initiates updates until this option
+ is disabled.
+
+.. ts:confvar:: CONFIG proxy.config.update.retry_count INT 10
+ :reloadable:
+
+ Specifies the number of times Traffic Server can retry the scheduled
+ update of a URL in the event of failure.
+
+.. ts:confvar:: CONFIG proxy.config.update.retry_interval INT 2
+ :reloadable:
+
+ Specifies the delay (in seconds) between each scheduled update retry
+ for a URL in the event of failure.
+
+.. ts:confvar:: CONFIG proxy.config.update.concurrent_updates INT 100
+ :reloadable:
+
+ Specifies the maximum simultaneous update requests allowed at any
+ time. This option prevents the scheduled update process from
+ overburdening the host.
+
+Remap Plugin Processor
+======================
+
+.. ts:confvar:: CONFIG proxy.config.remap.use_remap_processor INT 0
+
+ Enables (``1``) or disables (``0``) the ability to run separate threads for remap plugin processing.
+
+.. ts:confvar:: CONFIG proxy.config.remap.num_remap_threads INT 1
+
+ Specifies the number of threads that will be used for remap plugin rocessing.
+
+Plug-in Configuration
+=====================
+
+.. ts:confvar:: CONFIG proxy.config.plugin.plugin_dir STRING config/plugins
+
+ Specifies the location of Traffic Server plugins.
+
+Sockets
+=======
+
+.. ts:confvar:: CONFIG proxy.config.net.defer_accept INT `1`
+
+ default: ``1`` meaning ``on`` all Platforms except Linux: ``45`` seconds
+
+ This directive enables operating system specific optimizations for a listening socket. ``defer_accept`` holds a call to ``accept(2)``
+ back until data has arrived. In Linux' special case this is up to a maximum of 45 seconds.
+
+.. ts:confvar:: CONFIG proxy.config.net.sock_send_buffer_size_in INT 0
+
+ Sets the send buffer size for connections from the client to Traffic Server.
+
+.. ts:confvar:: CONFIG proxy.config.net.sock_recv_buffer_size_in INT 0
+
+ Sets the receive buffer size for connections from the client to Traffic Server.
+
+.. ts:confvar:: CONFIG proxy.config.net.sock_option_flag_in INT 0
+
+ Turns different options "on" for the socket handling client connections:::
+
+ TCP_NODELAY (1)
+ SO_KEEPALIVE (2)
+
+ **Note:** This is a flag and you look at the bits set. Therefore,
+ you must set the value to ``3`` if you want to enable both options
+ above.
+
+.. ts:confvar:: CONFIG proxy.config.net.sock_send_buffer_size_out INT 0
+
+ Sets the send buffer size for connections from Traffic Server to the origin server.
+
+.. ts:confvar:: CONFIG proxy.config.net.sock_recv_buffer_size_out INT 0
+
+ Sets the receive buffer size for connections from Traffic Server to
+ the origin server.
+
+.. ts:confvar:: CONFIG proxy.config.net.sock_option_flag_out INT 0
+
+ Turns different options "on" for the origin server socket:::
+
+ TCP_NODELAY (1)
+ SO_KEEPALIVE (2)
+
+ **Note:** This is a flag and you look at the bits set. Therefore,
+ you must set the value to ``3`` if you want to enable both options
+ above.
+
+.. ts:confvar:: CONFIG proxy.config.net.sock_mss_in INT 0
+
+ Same as the command line option ``--accept_mss`` that sets the MSS for all incoming requests.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/remap.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/remap.config.en.rst b/doc/reference/configuration/remap.config.en.rst
new file mode 100644
index 0000000..5122e60
--- /dev/null
+++ b/doc/reference/configuration/remap.config.en.rst
@@ -0,0 +1,277 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+============
+remap.config
+============
+
+.. configfile:: remap.config
+
+.. toctree::
+ :maxdepth: 2
+
+
+The :file:`remap.config` file contains mapping rules that Traffic Server
+uses to perform the following actions:
+
+- Map URL requests for a specific origin server to the appropriate
+ location on Traffic Server when Traffic Server acts as a reverse
+ proxy for that particular origin server
+- Reverse-map server location headers so that when origin servers
+ respond to a request with a location header that redirects the client
+ to another location, the clients do not bypass Traffic Server
+- Redirect HTTP requests permanently or temporarily without Traffic
+ Server having to contact any origin servers
+
+Refer to `Reverse Proxy and HTTP
+Redirects <../reverse-proxy-http-redirects>`_, for information about
+redirecting HTTP requests and using reverse proxy.
+
+After you modify the :file:`remap.config` run the
+:option:`traffic_line -x` to apply the changes. When you apply the
+changes to one node in a cluster, Traffic Server automatically applies
+the changes to all other nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`remap.config` file must contain a mapping rule.
+Traffic Server recognizes three space-delimited fields: ``type``,
+``target``, and ``replacement``. The following list describes the format
+of each field.
+
+*``type``* {#type}
+ Enter one of the following:
+
+ - ``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.
+
+ - ``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).
+
+*``target``* {#target}
+ Enter the origin ("from") URL. You can enter up to four components:
+
+ ::
+
+ scheme://host:port/path_prefix
+
+ where *``scheme``* is ``http``.
+
+*``replacement``* {#replacement}
+ Enter the origin ("from") URL. You can enter up to four components:
+
+ ::
+
+ scheme://host:port/path_prefix
+
+ where *``scheme``* can be ``http`` or ``https``.
+
+Precedence
+==========
+
+Remap rules are not processed top-down, but based on an internal
+priority
+
+1. ``map`` and ``reverse_map``
+2. ``redirect`` and ``redirect_temporary``
+3. ``regex_remap``
+4. ``regex_redirect`` and ``regex_redirect_temporary``
+
+Examples
+========
+
+The following section shows example mapping rules in the
+:file:`remap.config` file.
+
+Reverse Proxy Mapping Rules
+===========================
+
+The following example shows a map rule that does not specify a path
+prefix in the target or replacement:
+
+::
+
+ map http://www.x.com/ http://server.hoster.com/
+ reverse_map http://server.hoster.com/ http://www.x.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``
+
+The following example shows a map rule with path prefixes specified in
+the target:
+
+::
+
+ map http://www.y.com/marketing/ http://marketing.y.com/
+ reverse_map http://marketing.y.com/ http://www.y.com/marketing/
+ map http://www.y.com/sales/ http://sales.y.com/
+ reverse_map http://sales.y.com/ http://www.y.com/sales/
+ map http://www.y.com/engineering/ http://engineering.y.com/
+ reverse_map http://engineering.y.com/ http://www.y.com/engineering/
+ map http://www.y.com/stuff/ http://info.y.com/
+ reverse_map http://info.y.com/ http://www.y.com/stuff/
+
+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``
+
+The following example shows that the order of the rules matters:
+
+::
+
+ map http://www.g.com/ http://external.g.com/
+ reverse_map http://external.g.com/ http://www.g.com/
+ map http://www.g.com/stuff/ http://stuff.g.com/
+ reverse_map http://stuff.g.com/ http://www.g.com/stuff/
+
+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``
+
+In the above examples, the second rule is never applied because all URLs
+that match the second rule also match the first rule. The first rule
+takes precedence because it appears earlier in the :file:`remap.config`
+file.
+
+The following example shows a mapping with a path prefix specified in
+the target and replacement::
+
+ map http://www.h.com/a/b/ http://server.h.com/customers/x/y
+ reverse_map http://server.h.com/customers/x/y/ http://www.h.com/a/b/
+
+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``
+
+The following example shows reverse-map rules::
+
+ 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 \| 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
+``Host:`` header. As a solution, set the variable
+*``proxy.config.header.parse.no_host_url_redirect``* in the
+:file:`records.config` file to the URL to which Traffic Server will redirect
+requests without host headers.
+
+Redirect Mapping Rules
+======================
+
+The following rule permanently redirects all HTTP requests for
+``www.company.com`` to ``www.company2.com``:
+
+::
+
+ 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``:
+
+::
+
+ redirect_temporary http://www.company1.com/ http://www.company2.com/
+
+Regular Expression (regex) Remap Support
+========================================
+
+Regular expressions can be specified in remapping rules, with the
+limitations below:
+
+- Only the ``host`` field can contain a regex; the ``scheme``,
+ ``port``, and other fields cannot. For path manipulation via regexes,
+ use the ``regex_remap`` plugin.
+- The number of capturing subpatterns is limited to 9. This means that
+ ``$0`` through ``$9`` can be used as subtraction placeholders (``$0``
+ will be the entire input string).
+- The number of substitutions in the expansion string is limited to 10.
+- There is no ``regex_`` equivalent to ``reverse_remap``, so when using
+ ``regex_remap`` you should make sure the reverse path is clear by
+ setting
+ (`*``proxy.config.url_remap.pristine_host_hdr``* <../configuration-files/records.config#proxy.config.url_remap.pristine_host_hdr>`_)
+
+Examples
+--------
+
+::
+
+ 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
+
+Plugin Chaining
+===============
+
+Plugins can be configured to be evaluated in a specific order, passing
+the results from one in to the next (unless a plugin returns 0, then the
+"chain" is broken).
+
+Examples
+--------
+
+::
+
+ 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.
+
+This will pass "1" and "2" to plugin1.so and "3" to plugin2.so
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/splitdns.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/splitdns.config.en.rst b/doc/reference/configuration/splitdns.config.en.rst
new file mode 100644
index 0000000..4298a45
--- /dev/null
+++ b/doc/reference/configuration/splitdns.config.en.rst
@@ -0,0 +1,125 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+===============
+splitdns.config
+===============
+
+
+The :file:`splitdns.config` file enables you to specify the DNS server that
+Traffic Server should use for resolving hosts under specific conditions.
+For more information, refer to `Configuring DNS Server Selection (Split
+DNS) <../security-options#SplitDNS>`_.
+
+To specify a DNS server, you must supply the following information in
+each active line within the file:
+
+- A primary destination specifier in the form of a destination domain,
+ a destination host, or a URL regular expression
+- A set of server directives, listing one or more DNS servers with
+ corresponding port numbers
+
+You can also include the following optional information with each DNS
+server specification:
+
+- A default domain for resolving hosts
+- A search list specifying the domain search order when multiple
+ domains are specified
+
+After you modify the :file:`splitdns.config` file,
+run the :option:`traffic_line -x`
+command to apply the changes. When you apply changes to a node in a
+cluster, Traffic Server automatically applies the changes to all other
+nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`splitdns.config` file uses one of the following
+formats:
+
+::
+
+ dest_domain=dest_domain | dest_host | url_regex named=dns_server def_domain=def_domain search_list=search_list
+
+The following list describes each field.
+
+*``dest_domain``* {#dest_domain}
+ A valid domain name. This specifies that DNS server selection will
+ be based on the destination domain. You can prefix the domain with
+ an exclamation mark (``!``) to indicate the NOT logical operator.
+
+*``dest_host``* {#dest_host}
+ A valid hostname. This specifies that DNS server selection will be
+ based on the destination host. You can prefix the host with an
+ exclamation mark (``!``) to indicate the ``NOT`` logical operator.
+
+*``url_regex``* {#url_regex}
+ A valid URL regular expression. This specifies that DNS server
+ selection will be based on a regular expression.
+
+*``dns_server``* {#dns_server}
+ This is a required directive. It identifies the DNS server that
+ Traffic Server should use with the given destination specifier. You
+ can specify a port using a colon (``:``). If you do not specify a
+ port, then 53 is used. Specify multiple DNS servers with spaces or
+ semicolons (``;``) as separators.
+
+ You must specify the domains with IP addresses in CIDR ("dot")
+ notation.
+
+*``def_domain``* {#def_domain}
+ A valid domain name. This optional directive specifies the default
+ domain name to use for resolving hosts. Only one entry is allowed.
+ If you do not provide the default domain, the system determines its
+ value from ``/etc/resolv.conf``
+
+*``search_list``* {#search_list}
+ A list of domains separated by spaces or semicolons (;). This
+ specifies the domain search order. If you do not provide the search
+ list, the system determines the value from ``/etc/resolv.conf``
+
+Examples
+========
+
+Consider the following DNS server selection specifications:
+
+::
+
+ dest_domain=internal.company.com named=255.255.255.255:212 255.255.255.254 def_domain=company.com search_list=company.com company1.com
+ dest_domain=!internal.company.com named=255.255.255.253
+
+Now consider the following two requests:
+
+::
+
+ http://minstar.internal.company.com
+
+This request matches the first line and therefore selects DNS server
+``255.255.255.255`` on port ``212``. All resolver requests use
+``company.com`` as the default domain, and ``company.com`` and
+``company1.com`` as the set of domains to search first.
+
+::
+
+ http://www.microsoft.com
+
+This request matches the second line. Therefore, Traffic Server selects
+DNS server ``255.255.255.253``. Because no ``def_domain`` or
+``search_list`` was supplied, Traffic Server retrieves this information
+from ``/etc/resolv.conf``
+
[2/7] docs: split reference material into top-level pages
Posted by jp...@apache.org.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/ssl_multicert.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/ssl_multicert.config.en.rst b/doc/reference/configuration/ssl_multicert.config.en.rst
new file mode 100644
index 0000000..8a11e9b
--- /dev/null
+++ b/doc/reference/configuration/ssl_multicert.config.en.rst
@@ -0,0 +1,81 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+====================
+ssl_multicert.config
+====================
+
+.. configfile:: ssl_multicert.config
+
+The :file:`ssl_multicert.config` file lets you configure Traffic Server to
+use multiple SSL server certificates with the SSL termination option. If
+you have a Traffic Server system with more than one IP address assigned
+to it, then you can assign a different SSL certificate to be served when
+a client requests a particular IP address.
+
+Format
+======
+
+The format of the :file:`ssl_multicert.config` file is:
+
+::
+
+ dest_ip=ipaddress ssl_cert_name=cert_name ssl_key_name=key_name
+
+where ``ipaddress`` is an IP address assigned to Traffic Server ,
+``ssl_cert_name`` is the filename of the Traffic Server SSL server
+certificate, ``ssl_key_name`` is the filename of the Traffic Server
+SSL private key. If the private key is located in the certificate file,
+then you do not need to specify the name of the private key.
+Additionally ``ssl_ca_name`` can be used to specify the location of a
+Certification Authorithy change in case that differs from what is
+specified under the :file:`records.config`
+``proxy.config.ssl.CA.cert.filename`` value.
+
+Traffic Server will try to find the files specified in
+*``ssl_cert_name``* relative to
+```proxy.config.ssl.server.cert.path`` <../records.config#proxy.config.ssl.server.cert.path>`_,
+*``ssl_key_name``* relative to
+```proxy.config.ssl.server.private_key.path`` <../records.config#proxy.config.ssl.server.private_key.path>`_,
+and *``ssl_ca_name``* relative to
+```proxy.config.ssl.CA.cert.path`` <../records.config#proxy.config.ssl.CA.cert.path>`_.
+
+Examples
+========
+
+The following example configures Traffic Server to use the SSL
+certificate ``server.pem`` for all requests to the IP address
+111.11.11.1 and the SSL certificate ``server1.pem`` for all requests to
+the IP address 11.1.1.1. Since the private key *is* included in the
+certificate files, no private key name is specified.
+
+::
+
+ dest_ip=111.11.11.1 ssl_cert_name=server.pem
+ dest_ip=11.1.1.1 ssl_cert_name=server1.pem
+
+The following example configures Traffic Server to use the SSL
+certificate ``server.pem`` and the private key ``serverKey.pem`` for all
+requests to the IP address 111.11.11.1. Traffic Server uses the SSL
+certificate ``server1.pem`` and the private key ``serverKey1.pem`` for
+all requests to the IP address 11.1.1.1.
+
+::
+
+ dest_ip=111.11.11.1 ssl_cert_name=server.pem ssl_key_name=serverKey.pem
+ dest_ip=11.1.1.1 ssl_cert_name=server1.pem ssl_key_name=serverKey1.pem
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/storage.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/storage.config.en.rst b/doc/reference/configuration/storage.config.en.rst
new file mode 100644
index 0000000..aa5a953
--- /dev/null
+++ b/doc/reference/configuration/storage.config.en.rst
@@ -0,0 +1,120 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+==============
+storage.config
+==============
+
+.. configfile:: storage.config
+
+The :file:`storage.config` file lists all the files, directories, and/or
+hard disk partitions that make up the Traffic Server cache. After you
+modify the :file:`storage.config` file, you must restart Traffic Server.
+
+Format
+======
+
+The format of the :file:`storage.config` file is::
+
+ pathname size volume=volume_number
+
+where ``pathname`` is the name of a partition, directory or file, ``size``
+is the size of the named partition, directory or file (in bytes), and
+``volume`` is the volume number that is used in :file:`volume.config`
+and :file:`hosting.config`. You must specify a size for directories or
+files; size is optional for raw partitions. ``volume`` is optional.
+
+You can use any partition of any size. For best performance:
+
+- Use raw disk partitions.
+- For each disk, make all partitions the same size.
+- For each node, use the same number of partitions on all disks.
+- Group similar kinds of storage into different volumes. For example
+ split out SSD's or RAM drives into their own volume.
+
+Specify pathnames according to your operating system requirements. See
+the following examples. In the :file:`storage.config` file, a formatted or
+raw disk must be at least 128 MB.
+
+When using raw disk or partitions, you should make sure the admin user,
+which is the traffic_server running at, have the read&write privileges.
+The admin user_id is set in
+```proxy.config.admin.user_id`` <records.config#proxy.config.admin.user_id>`_.
+One good practice is if the disk set with g+rw, put the admin user into
+the group which have the privileges.
+
+Examples
+========
+
+The following basic example shows 64 MB of cache storage in the
+``/big_dir`` directory::
+
+ /big_dir 67108864
+
+You can use the ``.`` symbol for the current directory. Here is an
+example for 64 MB of cache storage in the current directory::
+
+ . 67108864
+
+Solaris Example
+---------------
+
+The following example is for the Solaris operating system::
+
+ /dev/rdsk/c0t0d0s5
+ /dev/rdsk/c0t0d1s5
+
+
+.. note:: Size is optional. If not specified, the entire partition is used.
+
+Linux Example
+-------------
+
+The following example will use an entire raw disk in the Linux operating
+system:::
+
+ /dev/sde volume=1
+ /dev/sdf volume=2
+
+In order to make sure ``traffic_server`` will have access to this disk
+you can use ``udev`` to persistently set the right permissions. The
+following rules are targeted for an Ubuntu system, and stored in
+``/etc/udev/rules.d/51-cache-disk.rules``::
+
+ # Assign /dev/sde and /dev/sdf to the www group
+ # make the assignment final, no later changes allowed to the group!
+ SUBSYSTEM=="block", KERNEL=="sd[ef]", GROUP:="www"
+
+FreeBSD Example ## {#LinuxExample}
+----------------------------------
+
+Starting with 5.1 FreeBSD dropped support for explicit raw devices. All
+devices on FreeBSD can be accessed raw now.
+
+The following example will use an entire raw disk in the FreeBSD
+operating system::
+
+ /dev/ada1
+ /dev/ada2
+
+In order to make sure ``traffic_server`` will have access to this disk
+you can use ``devfs`` to persistently set the right permissions. The
+following rules are stored in ``/etc/devfs.conf``::
+
+ # Assign /dev/ada1 and /dev/ada2 to the tserver user
+ own ada[12] tserver:tserver
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/update.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/update.config.en.rst b/doc/reference/configuration/update.config.en.rst
new file mode 100644
index 0000000..0b7659e
--- /dev/null
+++ b/doc/reference/configuration/update.config.en.rst
@@ -0,0 +1,203 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+=============
+update.config
+=============
+
+.. configfile:: update.config
+
+The :file:`update.config` file controls how Traffic Server performs a
+scheduled update of specific local cache content. The file contains a
+list of URLs specifying objects that you want to schedule for update.
+
+A scheduled update performs a local HTTP ``GET`` on the objects at the
+specific time or interval. You can control the following parameters for
+each specified object:
+
+- The URL
+- URL-specific request headers, which overrides the default
+- The update time and interval
+- The recursion depth
+
+After you modify the :file:`update.config` file,
+run the :option:`traffic_line -x`
+command to apply changes. When you apply changes to one node in a
+cluster, Traffic Server automatically applies the changes to all other
+nodes in the cluster.
+
+Supported Tag/Attribute Pairs
+=============================
+
+Scheduled update supports the following tag/attribute pairs when
+performing recursive URL updates:
+
+- ``<a href=" ">``
+- ``<img src=" ">``
+- ``<img href=" ">``
+- ``<body background=" ">``
+- ``<frame src=" ">``
+- ``<iframe src=" ">``
+- ``<fig src=" ">``
+- ``<overlay src=" ">``
+- ``<applet code=" ">``
+- ``<script src=" ">``
+- ``<embed src=" ">``
+- ``<bgsound src=" ">``
+- ``<area href=" ">``
+- ``<base href=" ">``
+- ``<meta content=" ">``
+
+Scheduled update is designed to operate on URL sets consisting of
+hundreds of input URLs (expanded to thousands when recursive URLs are
+included); it is *not* intended to operate on extremely large URL sets,
+such as those used by Internet crawlers.
+
+Format
+======
+
+Each line in the :file:`update.config` file uses the following format:
+
+::
+
+ URL\request_headers\offset_hour\interval\recursion_depth\
+
+The following list describes each field.
+
+*``URL``* {#URL}
+ HTTP-based URLs.
+
+*``request_headers``* {#request_headers}
+ Optional. A list of headers, separated by semicolons, passed in each
+ ``GET`` request. You can define any request header that conforms to
+ the HTTP specification; the default is no request header.
+
+*``offset_hour``* {#offset_hour}
+ The base hour used to derive the update periods. The range is 00-23
+ hours.
+
+*``interval``* {#interval}
+ The interval (in seconds) at which updates should occur, starting at
+ the offset hour.
+
+*``recursion_depth``* {#recursion_depth}
+ The depth to which referenced URLs are recursively updated, starting
+ at the given URL. This field applies only to HTTP.
+
+Examples
+========
+
+An example HTTP scheduled update is provided below:
+
+::
+
+ http://www.company.com\User-Agent: noname user agent\13\3600\5\
+
+The example specifies the URL and request headers, an offset hour of 13
+(1 pm), an interval of one hour, and a recursion depth of 5. This would
+result in updates at 13:00, 14:00, 15:00, and so on. To schedule an
+update that occurs only once a day, use an interval value 86400 (i.e.,
+24 hours x 60 minutes x 60 seconds = 86400).
+
+Specifying URL Regular Expressions (``url_regex``)
+==================================================
+
+This section describes how to specify a ``url_regex``. Entries of type
+``url_regex`` within the configuration files use regular expressions to
+perform a match.
+
+The following list provides examples to show how to create a valid
+``url_regex``.
+
+``x``
+ Matches the character ``x``
+
+``.``
+ Match any character
+
+``^``
+ Specifies beginning of line
+
+``$``
+ Specifies end of line
+
+``[xyz]``
+ A **character class**. In this case, the pattern matches either
+ ``x``, ``y``, or\ ``z``
+
+``[abj-oZ]``
+ A **character class** with a range. This pattern matches ``a``,
+ ``b``, any letter from ``j`` through ``o``, or ``Z``
+
+``[^A-Z]``
+ A **negated character class**. For example, this pattern matches any
+ character except those in the class.
+
+``r*``
+ Zero or more ``r``, where ``r`` is any regular expression.
+
+``r+``
+ One or more ``r``, where ``r`` is any regular expression.
+
+``r?``
+ Zero or one ``r``, where ``r`` is any regular expression.
+
+``r{2,5}``
+ From two to five ``r``, where ``r`` is any regular expression.
+
+``r{2,}``
+ Two or more ``r``, where ``r`` is any regular expression.
+
+``r{4}``
+ Exactly four ``r``, where ``r`` is any regular expression.
+
+``"[xyz]\"images"``
+ The literal string ``[xyz]"images"``
+
+``\X``
+ If ``X`` is ``a, b, f, n, r, t,`` or ``v``, then the ``ANSI-C``
+ interpretation of ``\x``; otherwise, a literal ``X``. This is used
+ to escape operators such as ``*``
+
+``\0``
+ A ``NULL`` character
+
+``\123``
+ The character with octal value ``123``
+
+``\x2a``
+ The character with hexadecimal value ``2a``
+
+``(r)``
+ Matches an ``r``, where ``r`` is any regular expression. You can use
+ parentheses to override precedence.
+
+``rs``
+ The regular expression ``r``, followed by the regular expression
+ ``s``
+
+``r|s``
+ Either an ``r`` or an ``s``
+
+``#<n>#``
+ Inserts an **end node**, which causes regular expression matching to
+ stop when reached. The value ``n`` is returned.
+
+You can specify ``dest_domain=mydomain.com`` to match any host in
+``mydomain.com``. Likewise, you can specify ``dest_domain=.`` to match
+any request.
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/volume.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/volume.config.en.rst b/doc/reference/configuration/volume.config.en.rst
new file mode 100644
index 0000000..51f239f
--- /dev/null
+++ b/doc/reference/configuration/volume.config.en.rst
@@ -0,0 +1,72 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+=============
+volume.config
+=============
+
+.. configfile:: volume.config
+
+The :file:`volume.config` file enables you to manage your cache space more
+efficiently and restrict disk usage by creating cache volumes of
+different sizes for specific protocols. You can further configure these
+volumes to store data from certain origin servers and/or domains in the
+:file:`hosting.config` file.
+
+.. important::
+
+ The volume configuration must be the same on all nodes in
+ a cluster. You must stop Traffic Server before you change the cache
+ volume size and protocol assignment. For step-by-step instructions about
+ partitioning the cache, refer to `Partitioning the
+ Cache <../configuring-cache#PartitioningCache>`_.
+
+Format
+======
+
+For each volume you want to create, enter a line with the following
+format:
+
+::
+
+ volume=volume_number scheme=protocol_type size=volume_size
+
+where *``volume_number``* is a number between 1 and 255 (the maximum
+number of volumes is 255) and *``protocol_type``* is ``http``. Traffic
+Server supports ``http`` for HTTP volume types; *``volume_size``* is the
+amount of cache space allocated to the volume. This value can be either
+a percentage of the total cache space or an absolute value. The absolute
+value must be a multiple of 128 MB, where 128 MB is the smallest value.
+If you specify a percentage, then the size is rounded down to the
+closest multiple of 128 MB.
+
+Each volume is striped across several disks to achieve parallel I/O. For
+example: if there are four disks, then a 1-GB volume will have 256 MB on
+each disk (assuming each disk has enough free space available). If you
+do not allocate all the disk space in the cache, then the extra disk
+space is not used. You can use the extra space later to create new
+volumes without deleting and clearing the existing volumes.
+
+Examples
+========
+
+The following example partitions the cache evenly between HTTP and HTTPS
+requests::
+
+ volume=1 scheme=http size=50%
+ volume=2 scheme=https size=50%
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/balancer.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/balancer.en.rst b/doc/reference/plugins/balancer.en.rst
new file mode 100644
index 0000000..9d54d91
--- /dev/null
+++ b/doc/reference/plugins/balancer.en.rst
@@ -0,0 +1,92 @@
+Balancer Plugin
+***************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+This is a plugin for Traffic Server, that allows you to configure
+mapping rules.
+
+To use this plugin, configure a remap.config rule like
+
+::
+ map http://foo.com http://bar.com @plugin=balancer.so @pparam=rotation:news
+
+The "To-Url" in the remap.config rule is generally not used, unless the
+lookup completely fails (i.e. this is a backup URL for extreme error
+cases).
+
+This is a list of all available options (set via @pparam):
+
+::
+ rotation The name of the rotation (e.g. news) [to-host in remap]
+ hash What to hash on, url, path, cookie, ip, header (primary)
+ hash2 Optional, secondary hash, to hash within a multi-host bucket
+ bucketw Width of each hash bucket [1]
+
+The rotation parameter specifies which rotation to do the lookup on. If
+not specified, we will default to the same name as used in the To URL in
+the remap rule.
+
+The bucket width specifies how many hosts a particular hash bucket
+should contain, for example:
+
+::
+ @pparam=bucketw:2
+
+The hash parameter can be used zero or more times, without it, no
+hashing is done at all. If you have more than one hash keys, they are
+concatenated in the order specified. For example:
+
+::
+ @pparam=hash:ip @pparam=hash:cookie/B
+
+The "header" hash key takes a required extra value, for example:
+
+::
+ @pparam=hash:header/Host
+
+For "cookie" hash keys, you can optionally specify an identifier for
+which cookie to use (without it, the entire cookie header is used). For
+example:
+
+::
+ @pparam=hash:cookie/B
+
+The secondary hash ("hash2") is used to provide "stickiness" within a
+bucket that's larger than one host (i.e. bucketw > 1). This allows you
+to (for example) have a primary hash on the URL, where each URL is
+served by some number of servers. A secondary hash on B-cookie would
+then provide user stickiness, so that for a particular URL, a particular
+user will always hit the same server.
+
+If the hashes you've requested (either "hash" or "hash2") can not be
+generated, we default to using the URL instead for the primary hash. For
+the secondary hash, if set, we'll default to the src-IP. If these
+defaults are not desirable, make sure that you have at least one hash
+key that is guaranteed to exist (e.g. @pparam=hash:ip).
+
+If no "hash" parameters are specified, no hashing is done. This is the
+default behavior, obviously. In this cash, the "hash2" directive has no
+effect as well.
+
+Finally, a couple of "flag" options (parameters) are available, to
+control some of the lookup mechanisms:
+
+- @pparam=hostip will use the IP returned by the lookup
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/buffer_upload.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/buffer_upload.en.rst b/doc/reference/plugins/buffer_upload.en.rst
new file mode 100644
index 0000000..ab5f209
--- /dev/null
+++ b/doc/reference/plugins/buffer_upload.en.rst
@@ -0,0 +1,89 @@
+Buffer Upload Plugin
+********************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+.. XXX Discribe what the heck this plugin actually does.
+
+Upload proxy specs for phase I:
+
+1. Memory buffering (buffer the entire POST data in IOBuffer before
+ connecting to OS) 1.1. Memory buffer size is configured with
+ "mem_buffer_size" in config file. Default and minimum value is 32K
+ You can increase it in the config file. If the size of a request is
+ larger than the "mem_buffer_size" value specifiied in the config
+ file, then the upload proxy feature will be disabled for this
+ particular request
+
+2. Disk buffering (buffer the entire POST data on disk before connecting
+ to OS) 2.1. Use disk async IO. This involved some changes in ATS core
+ . new APIs wrapping around ink_aio_read() and ink_aio_write() .
+ change to distinguish between api call's AIO and cache's AIO .
+ guarantee api call's AIO only involves certain amount of threads .
+ the number of threads is configurable in plugin's config file
+ (default is 4)
+
+3.
+
+ 2. Directories and files generated on disk . base directory:
+ FOOBAR/var/buffer_upload_tmp/ (configurable in config file) .
+ number of subdirectories: 64 (configurable in config file) .
+ filename are randomly generated . files will be removed when the
+ entire data have been sent out to OS . remove dangling files (left
+ on disk due to transaction interruption or traffic server crash)
+ at startup time
+
+4.
+
+ 3. Default chunk size when reading from disk: 16K, configurable in
+ config file
+
+5. Default buffering mode: disk aio buffering mode 3.1. to turn off disk
+ buffering, add a "use_disk_buffer 0" line in config file
+
+6. Trigger POST buffering on certain URLs 4.1. certain URLs will be
+ provided in a plain text file (one URL each line) 4.2. specify
+ filename in config file by "url_list_file" 4.3. max length of each
+ URL: 4096 (configurable in config file) 4.4. use exact match, don't
+ support regex for now
+
+7. URL conversion for Mail's specific URL format 5.1. for now check if
+ the "host" part in the URL is same as the proxy server name, then
+ will do this conversion 5.2. To turn on URL conversion feature, set
+ "convert_url 1" in config file
+
+8. All request headers inlcuding cookies plus the entire POST data will
+ be buffered (either in memory or on disk)
+
+9. Config file can be explicitly sepcified as a parameter in command
+ line (in plugin.config file)
+
+a sample config file:
+
+use_disk_buffer 1 convert_url 1 chunk_size 1024 url_list_file
+/tmp/url_list.conf max_url_length 10000 base_dir /tmp/test1
+subdir_num 100 thread_num 10 mem_buffer_size 40000
+
+default config file: FOOBAR/etc/upload.conf
+
+default config values: use_disk_buffer 1 convert_url 0 chunk_size
+16384 url_list_file none max_url_length 4096 base_dir
+FOOBAR/var/buffer_upload_tmp subdir_num 64 thread_num 4
+mem_buffer_size 32768
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/cacheurl.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/cacheurl.en.rst b/doc/reference/plugins/cacheurl.en.rst
new file mode 100644
index 0000000..093beac
--- /dev/null
+++ b/doc/reference/plugins/cacheurl.en.rst
@@ -0,0 +1,59 @@
+CacheURL Plugin
+***************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+
+This plugin allows you to change the key that is used for caching a
+request. It is designed so that multiple requests that have different
+URLs but the same content (for example, site mirrors) need be cached
+only once.
+
+Installation
+============
+
+This plugin is only built if the configure option ::
+
+ --enable-experimental-plugins
+
+is given at build time.
+
+Configuration
+=============
+
+Create a ``cacheurl.config`` file in the plugin directory with the url
+patterns to match. See the ``cacheurl.config.example`` file for what to
+put in this file.
+
+Add the plugin to your
+```plugins.config`` <../../configuration-files/plugins.config>`_ file::
+
+ cacheurl.so
+
+Start traffic server. Any rewritten URLs will be written to
+``cacheurl.log`` in the log directory by default.
+
+More docs
+=============
+
+There are some docs on cacheurl in Chinese, please find them in the following:
+
+```http://people.apache.org/~zym/trafficserver/cacheurl.html`` <http://people.apache.org/~zym/trafficserver/cacheurl.html>`_
+
+```https://blog.zymlinux.net/index.php/archives/195`` <https://blog.zymlinux.net/index.php/archives/195>`_
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/combo_handler.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/combo_handler.en.rst b/doc/reference/plugins/combo_handler.en.rst
new file mode 100644
index 0000000..260d3f3
--- /dev/null
+++ b/doc/reference/plugins/combo_handler.en.rst
@@ -0,0 +1,84 @@
+Combohandler Plugin
+*******************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+This plugin provides an intelligent way to combine multiple URLs into a single
+URL, and have Apache Traffic Server combine the components into one
+response. This is useful for example to create URLs that combine multiple CSS
+or Javascript files into one.
+
+Installation
+============
+
+This plugin is only built if the configure option ::
+
+ --enable-experimental-plugins
+
+is given at build time. Note that this plugin is built and installed in
+combination with the ESI module, since they share common code.
+
+Configuration
+=============
+
+The arguments in the
+```plugin.config`` <../../configuration-files/plugin.config>`_ line in
+order represent
+
+1. The path that should triggers combo handler (defaults to
+ "admin/v1/combo")
+
+2. The name of the key used for signature verification (disabled by
+ default)
+
+A "-" can be supplied as a value for any of these arguments to request
+default value be applied.
+
+Also, just like the original combohandler, this plugin generates URLs of
+the form ``http://localhost/<dir>/<file-path>``. ``<dir>`` here defaults
+to ``l`` unless specified by the file path in the query parameter using
+a colon. For example::
+
+ http://combo.com/admin/v1/combo?filepath1&dir1:filepath2&filepath3
+
+Will result in these three pages being fetched::
+
+ http://localhost/l/filepath1
+ http://localhost/dir1/filepath2
+ http://localhost/l/filepath3
+
+Remap rules have to be specified to map the above URLs to desired
+content servers.
+
+The plugin also supports a prefix parameter. Common parts of successive
+file paths can be extracted and specified separately using a 'p' query
+parameter. Successive file path parameters are appended to this prefix
+to create complete file paths. The prefix will remain active until
+changed or cleared (set to an empty string). For example, the query ::
+ "/file1&p=/path1/&file2&file3&p=&/file4&p=/dir:path2/&file5&file6"
+
+results in these file paths being "reconstructed"::
+
+ /file1
+ /path1/file2
+ /path1/file3
+ /file4
+ /dir:path2/file5
+ /dir:path2/file6
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/conf_remap.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/conf_remap.en.rst b/doc/reference/plugins/conf_remap.en.rst
new file mode 100644
index 0000000..2f90e1c
--- /dev/null
+++ b/doc/reference/plugins/conf_remap.en.rst
@@ -0,0 +1,107 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information regarding
+ copyright ownership. The ASF licenses this file to you under
+ the Apache License, Version 2.0 (the "License"); you may not use
+ this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an "AS
+ IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ express or implied. See the License for the specific language
+ governing permissions and limitations under the License.
+
+conf_remap Plugin
+=================
+
+The `conf_remap` plugin allows you to override configuration
+directives dependent on actual remapping rules. The plugin is built
+and installed as part of the normal Apache Traffic Server installation
+process.
+
+If you want to achieve this behaviour now, configure a remap rule
+like this::
+
+ map http://cdn.example.com/ http://some-server.example.com @plugin=conf_remap.so @pparam=/etc/trafficserver/cdn.conf
+
+where `cdn.conf` would look like :file:`records.config`. For example::
+
+ CONFIG proxy.config.url_remap.pristine_host_hdr INT 1
+
+Doing this, you will override your global default configuration on
+a per mapping rule. For now, those options may be overridden through
+the `conf_remap` plugin:
+
+|
+|
+| proxy.config.url_remap.pristine_host_hdr
+| proxy.config.http.chunking_enabled
+| proxy.config.http.negative_caching_enabled
+| proxy.config.http.negative_caching_lifetime
+| proxy.config.http.cache.when_to_revalidate
+| proxy.config.http.keep_alive_enabled_in
+| proxy.config.http.keep_alive_enabled_out
+| proxy.config.http.keep_alive_post_out
+| proxy.config.http.share_server_sessions
+| proxy.config.net.sock_recv_buffer_size_out
+| proxy.config.net.sock_send_buffer_size_out
+| proxy.config.net.sock_option_flag_out
+| proxy.config.http.forward.proxy_auth_to_parent
+| proxy.config.http.anonymize_remove_from
+| proxy.config.http.anonymize_remove_referer
+| proxy.config.http.anonymize_remove_user_agent
+| proxy.config.http.anonymize_remove_cookie
+| proxy.config.http.anonymize_remove_client_ip
+| proxy.config.http.anonymize_insert_client_ip
+| proxy.config.http.response_server_enabled
+| proxy.config.http.insert_squid_x_forwarded_for
+| proxy.config.http.server_tcp_init_cwnd
+| proxy.config.http.send_http11_requests
+| proxy.config.http.cache.http
+| proxy.config.http.cache.cluster_cache_local
+| proxy.config.http.cache.ignore_client_no_cache
+| proxy.config.http.cache.ignore_client_cc_max_age
+| proxy.config.http.cache.ims_on_client_no_cache
+| proxy.config.http.cache.ignore_server_no_cache
+| proxy.config.http.cache.cache_responses_to_cookies
+| proxy.config.http.cache.ignore_authentication
+| proxy.config.http.cache.cache_urls_that_look_dynamic
+| proxy.config.http.cache.required_headers
+| proxy.config.http.insert_request_via_str
+| proxy.config.http.insert_response_via_str
+| proxy.config.http.cache.heuristic_min_lifetime
+| proxy.config.http.cache.heuristic_max_lifetime
+| proxy.config.http.cache.guaranteed_min_lifetime
+| proxy.config.http.cache.guaranteed_max_lifetime
+| proxy.config.http.cache.max_stale_age
+| proxy.config.http.keep_alive_no_activity_timeout_in
+| proxy.config.http.keep_alive_no_activity_timeout_out
+| proxy.config.http.transaction_no_activity_timeout_in
+| proxy.config.http.transaction_no_activity_timeout_out
+| proxy.config.http.transaction_active_timeout_out
+| proxy.config.http.origin_max_connections
+| proxy.config.http.connect_attempts_max_retries
+| proxy.config.http.connect_attempts_max_retries_dead_server
+| proxy.config.http.connect_attempts_rr_retries
+| proxy.config.http.connect_attempts_timeout
+| proxy.config.http.post_connect_attempts_timeout
+| proxy.config.http.down_server.cache_time
+| proxy.config.http.down_server.abort_threshold
+| proxy.config.http.cache.fuzz.time
+| proxy.config.http.cache.fuzz.min_time
+| proxy.config.http.doc_in_cache_skip_dns
+| proxy.config.http.background_fill_active_timeout
+| proxy.config.http.response_server_str
+| proxy.config.http.cache.heuristic_lm_factor
+| proxy.config.http.cache.fuzz.probability
+| proxy.config.http.background_fill_completed_threshold
+| proxy.config.net.sock_packet_mark_out
+| proxy.config.net.sock_packet_tos_out
+| proxy.config.http.insert_age_in_response
+| proxy.config.http.chunking.size
+| proxy.config.http.flow_control.enabled
+| proxy.config.http.flow_control.low_water
+| proxy.config.http.flow_control.high_water
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/esi.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/esi.en.rst b/doc/reference/plugins/esi.en.rst
new file mode 100644
index 0000000..9130791
--- /dev/null
+++ b/doc/reference/plugins/esi.en.rst
@@ -0,0 +1,22 @@
+ESI Plugin (undocumented)
+*************************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+This plugin implements the ESI specification.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/geoip_acl.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/geoip_acl.en.rst b/doc/reference/plugins/geoip_acl.en.rst
new file mode 100644
index 0000000..a864706
--- /dev/null
+++ b/doc/reference/plugins/geoip_acl.en.rst
@@ -0,0 +1,94 @@
+GeoIP ACLs Plugin
+*****************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+This is a simple ATS plugin for denying (or allowing) requests based on
+the source IP geo-location. Currently only the Maxmind APIs are
+supported, but we'd be happy to other other (open) APIs if you let us
+know. This plugin comes with the standard distribution of Apache Traffic
+Server, and should be installed as part of the normal build process.
+
+
+Configuration
+=============
+
+Once installed, there are three primary use cases, which we will discuss
+in details. Note that in all configurations, the first plugin parameter
+must specify what the matches should be applied to. Currently, only one
+rule set is supported, for Country ISO codes. This is specified with a
+parameter of ::
+
+ @pparam=country
+
+Future additions to this plugin could include other regions, such as
+city, state, continent etc.
+
+The three typical use cases are as follows:
+
+1. Per remap configurations, applicable to the entire remap rule. This
+ is useful when you can partition your content so that entire prefix
+ paths should be filtered. For example, lets assume that
+ http://example.com/music is restricted to US customers only, and
+ everything else is world wide accessible. In remap.config, you would
+ have something like ::
+
+ map http://example.com/music http://music.example.com \
+ @plugin=geoip_acl.so @pparam=country @pparam=allow @pparam=US
+ map http://example.com http://other.example.com
+
+2. If you can not partition the data with a path prefix, you can specify
+ a separate regex mapping filter. The remap.config file might then
+ look like ::
+
+ map http://example.com http://music.example.com \
+ @plugin=geoip_acl.so @pparam=country \
+ @pparam=regex::/etc/music.regex
+
+where music.regex is a format with PCRE (perl compatible) regular
+expressions, and unique rules for match. E.g.::
+
+ .*\.mp3 allow US
+ .*\.ogg deny US
+
+Note that the default in the case of no matches on the regular
+expressions is to "allow" the request. This can be overriden, see next
+use case.
+
+3. You can also combine 1) and 2), and provide defaults in the
+ remap.config configuration, which then applies for the cases where no
+ regular expressions matches at all. This would be useful to override
+ the default which is to allow all requests that don't match. For
+ example ::
+
+ map http://example.com http://music.example.com \
+ @plugin=geoip_acl.so @pparam=country @pparam=allow @pparam= US
+ @pparam=regex::/etc/music.regex
+
+This tells the plugin that in the situation where there is no matching
+regular expression, only allow requests originating from the US.
+
+Finally, there's one additional parameter option that can be used ::
+
+ @pparam=html::/some/path.html
+
+This will override the default reponse body for the denied responses
+with a custom piece of HTML. This can be useful to explain to your users
+why they are getting denied access to a particular piece of content.
+This configuration can be used with any of the use cases described
+above.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/gzip.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/gzip.en.rst b/doc/reference/plugins/gzip.en.rst
new file mode 100644
index 0000000..ca49913
--- /dev/null
+++ b/doc/reference/plugins/gzip.en.rst
@@ -0,0 +1,91 @@
+gzip / deflate Plugin
+*********************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+This plugin gzips or deflates responses, whichever is applicable. It can
+compress origin respones as well as cached responses. The plugin is built
+and installed as part of the normal Apache Traffic Server installation
+process.
+
+Installation
+============
+
+Add the following line to
+```plugin.config`` <../../configuration-files/plugin.config>`_::
+
+ gzip.so
+
+In this case, the plugin will use the default behaviour:
+
+- Enable caching
+- Compress text/\* for every origin
+- Don't hide accept encoding from origin servers (for an offloading
+ reverse proxy)
+- No urls are disallowed from compression
+
+Configuration
+=============
+
+Alternatively, a configuration can also be specified::
+
+ gzip.so <path-to-plugin>/sample.gzip.config
+
+After modifying plugin.cofnig, restart traffic server (sudo
+traffic_line -L) the configuration is re-read when a management update
+is given (sudo traffic_line -x)
+
+Options
+=======
+
+Flags and options are:
+
+``enabled``: (``true`` or ``false``) Enable or disable compression for a
+host.
+
+``remove-accept-encoding``: (``true`` or ``false``) Sets whether the
+plugin should hide the accept encoding from origin servers:
+
+- To ease the load on the origins.
+- For when the proxy parses responses, and the resulting
+ compression/decompression is wasteful.
+
+``cache``: (``true`` or ``false``) When set, the plugin stores the
+uncompressed and compressed response as alternates.
+
+``compressible-content-type``: Wildcard pattern for matching
+compressible content types.
+
+``disallow``: Wildcard pattern for disabling compression on urls.
+
+Options can be set globally or on a per-site basis, as such::
+
+ # Set some global options first
+ cache true
+ enabled true
+ remove-accept-encoding false
+ compressible-content-type text/*
+
+ # Now set a configuration for www.example.com
+ [www.example.com]
+ cache false
+ remove-accept-encoding true
+ disallow /notthis/*.js
+
+See example.gzip.config for example configurations.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/header_filter.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/header_filter.en.rst b/doc/reference/plugins/header_filter.en.rst
new file mode 100644
index 0000000..3885612
--- /dev/null
+++ b/doc/reference/plugins/header_filter.en.rst
@@ -0,0 +1,133 @@
+Header Filter Plugin
+********************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+The ``header_filter`` is a simple plugin for filtering out headers from
+requests (or responses). Typical configuration is done either with a
+global configuration, in
+```plugin.config`` <../../configuration-files/plugin.config>`_::
+
+ header_filter.so /usr/local/etc/hdr_filters.conf
+
+Or, alternatively, in a
+```per-remap`` <../../configuration-files/remap.config>`_ rule
+configuration ::
+
+ map http://a.com/ http://b.com @plugin=header_filter.so @pparam=hdr_filters.conf
+
+Even if you don't have a global configuration, if your remap rules
+schedules actions in hooks other than during remap, you must also add
+the ``header_filter.so`` to the
+```plugin.config`` <../../configuration-files/remap.config>`_ (see
+above), but without args::
+
+ header_filter.so
+
+The configuration files looks like ::
+
+ [READ_REQUEST_HDR]
+ X-From-Someone
+ Cookie
+
+ [READ_RESPONSE_HDR]
+ X-From-Server
+ Set-Cookie
+
+ [SEND_RESPONSE_HDR]
+ X-Fie "Test" # Match the entire string
+ X-Foo /Test/ # Match the (Perl) regex
+ X-Bar [Test* # Match the prefix string
+ X-Fum *Test] # Match the postfix string
+
+
+Comments are prefixed with ``#``, and in most cases, the regular
+expression matching is the best choice (very little overhead). The
+pattern matches can also take an option '``!``\ ' to reverse the test.
+The default action is to delete all headers that do (not) match the
+pattern. E.g.::
+
+ [SEND_REQUEST_HDR]
+ X-Fie /test/
+ X-Foo ! /test/i
+
+The final "``i``\ " qualifier (works on all pattern matches) forces the
+match or comparison to be made case insensitive (just like in Perl).
+
+It's also possible to replace or add headers, using the = and +
+operators. For example ::
+
+ [SEND_REQUEST_HDR]
+ Host =www.example.com=
+ X-Foo +ATS+
+
+This will force the Host: header to have exactly one value,
+``www.example.com``, while ``X-Foo`` will have at least one header with
+the value ATS, but there could be more instances of the header from the
+existing header in the request.
+
+Possible hooks are ::
+
+ READ_REQUEST_HDR
+ SEND_REQUEST_HDR
+ READ_RESPONSE_HDR
+ SEND_RESPONSE_HDR
+
+If not specified, the default hook to add the rules (headers to filter)
+is ``READ_REQUEST_HDR``. It's completely acceptable (and useful) to
+configure a remap rule to delete headers in a later hook (e.g. when
+reading a response from the server). This is what actually makes the
+plugin even remotely useful.
+
+
+Examples
+========
+
+Set X-Forwarded-Proto https on SSL connections
+----------------------------------------------
+
+Often times a backend wants to know whether it's running under HTTP or
+HTTPS. While not regulated standard, we can use the
+``X-Forwarded-Proto`` header for this purpose.
+
+In ```plugin.config`` <../../configuration-files/plugin.config>`_ we
+need to add::
+
+ header_filter.so
+
+Then, in ```remap.config`` <../../configuration-files/remap.config>`_ we
+can configure ``header_filter`` on a case by case basis::
+
+ map http://example.org http://172.16.17.42:8080
+ map https://example.org http://172.16.17.42:8080 @plugin=header_filter.so @pparam=/etc/trafficserver/x_fwd_proto.conf
+
+The configuration that ties everything together is then
+``/etc/trafficserver/x_fwd_proto.config``, to which we add::
+
+ [SEND_REQUEST_HDR]
+ X-Forwarded-Proto =https=
+
+To activate this configuration, we need to restart Traffic Server with
+``traffic_line -L``.
+
+In the backend servers we can now pick this up and do appropriately set
+server variables that will be picked up by CGI programs for instance. In
+the case of Apache httpd backend, this can be acomplished with
+```mod_setenvif`` <http://httpd.apache.org/docs/current/mod/mod_setenvif.html#setenvif>`_::
+
+ SetEnvIf X-Forwarded-Proto https HTTPS=on SSL=on
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/hipes.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/hipes.en.rst b/doc/reference/plugins/hipes.en.rst
new file mode 100644
index 0000000..2651c67
--- /dev/null
+++ b/doc/reference/plugins/hipes.en.rst
@@ -0,0 +1,64 @@
+HIPES system (undocumented)
+***************************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+This plugin implements the HIPES system.
+
+Configuration
+=============
+
+``server:<host>``
+ Name of the server to send this request to
+
+``urlp:<name>``
+ Default: ``url``
+ Name of the query parameter for the service URL
+
+``path:<path>``
+ Default: ``/``
+ Path to use for the service URL
+
+``ssl``
+ Default: ``no``
+ Use SSL when connecting to the service
+
+``service``
+ Service server, ``host[:port]``
+
+``server``
+ Default: ``hipes.yimg.com``
+ Name of HIPES server, ``host[:port]``
+
+``active_timeout``
+ The active connection timeout in ms
+
+``no_activity_timeout``
+ The no activity timeout in ms
+
+``connect_timeout``
+ The connect timeout in ms
+
+``dns_timeout``
+ The DNS timeout
+
+The timeout options override the server defaults (from
+```records.config`` <../../configuration-files/records.config>`_), and
+only apply to the connection to the specific "service" host.
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/index.en.rst b/doc/reference/plugins/index.en.rst
new file mode 100644
index 0000000..fd2a4dd
--- /dev/null
+++ b/doc/reference/plugins/index.en.rst
@@ -0,0 +1,75 @@
+Plugin Reference
+****************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+Overview
+========
+
+One of the key features of Apache Traffic Server is modularity.
+Features that aren't needed in the core simply aren't there. This
+is a good thing, because it guarantees that our core can remain
+fast by concentrating on the things that we always provide: Caching
+and proxying.
+
+All other things can be moved into plugins, by opening up a consistent
+C API, everyone can implement their own functionality, without
+having to touch the core.
+
+Stable plugins
+==============
+
+Plugins that are considered stable are installed by default in
+Apache Traffic Server releases.
+
+.. toctree::
+ :maxdepth: 1
+
+ cacheurl.en
+ conf_remap.en
+ gzip.en
+ header_filter.en
+ regex_remap.en
+ stats_over_http.en
+
+Experimental plugins
+====================
+
+Plugins that are considered experimental are located in the
+```plugins/experimental`` <https://git-wip-us.apache.org/repos/asf?p=trafficserver.git;a=tree;f=plugins/experimental;hb=HEAD>`_
+directory in the Apache Traffic Server source tree. Exmperimental plugins can be compiled by passing the
+`--enable-experimental-plugins` option to `configure`::
+
+ $ autoconf -i
+ $ ./configure --enable-experimental-plugins
+ $ make
+
+.. toctree::
+ :maxdepth: 1
+
+ balancer.en
+ buffer_upload.en
+ cacheurl.en
+ combo_handler.en
+ esi.en
+ geoip_acl.en
+ hipes.en
+ metafilter.en
+ mysql_remap.en
+ stale_while_revalidate.en
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/metafilter.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/metafilter.en.rst b/doc/reference/plugins/metafilter.en.rst
new file mode 100644
index 0000000..7c75157
--- /dev/null
+++ b/doc/reference/plugins/metafilter.en.rst
@@ -0,0 +1,110 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information regarding
+ copyright ownership. The ASF licenses this file to you under
+ the Apache License, Version 2.0 (the "License"); you may not use
+ this file except in compliance with the License. You may obtain
+ a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an "AS
+ IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
+ express or implied. See the License for the specific language
+ governing permissions and limitations under the License.
+
+Metalink plugin
+===============
+
+The `metalink` plugin implements the
+`Metalink <http://en.wikipedia.org/wiki/Metalink>`_
+protocol in order to try not to download the same file twice. This
+improves cache efficiency and speeds up user downloads.
+
+Take standard headers and knowledge about objects in the cache and
+potentially rewrite those headers so that a client will use a URL
+that is already cached instead of one that isn't.
+
+The `metalink` headers are specified in :rfc:`6429` and :rfc:`3230`
+and are sent by various download redirectors or content distribution
+networks.
+
+A lot of download sites distribute the same files from many different
+mirrors and users don't know which mirrors are already cached. These
+sites often present users with a simple download button, but the
+button doesn't predictably access the same mirror, or a mirror that
+is already cached. To users it seems like the download works sometimes
+(takes seconds) and not others (takes hours), which is frustrating.
+
+An extreme example of this happens when users share a limited,
+possibly unreliable internet connection, as is common in parts of
+Africa for example.
+
+How it works
+------------
+
+When the `metalink` plugin sees a response with a ``Location: ...`` header and a
+``Digest: SHA-256=...`` header, it checks to see if the URL in the Location
+header is already cached. If it isn't, then it tries to find a URL
+that is cached to use instead. It looks in the cache for some object
+that matches the digest in the Digest header and if it finds
+something, then it rewites the ``Location`` header with the URL from
+that object.
+
+That way a client should get sent to a URL that's already cached
+and the user won't end up downloading the file again.
+
+Installation
+------------
+
+`metalink` is a global plugin. It is enabled by adding it to your
+:file:`plugins.config` file. There are no options.
+
+Implementation Status
+---------------------
+
+The `metalink` plugin implements the ``TS_HTTP_SEND_RESPONSE_HDR_HOOK``
+hook to check and potentially rewrite the ``Location: ...`` and
+``Digest: SHA-256=...`` headers after responses are cached. It
+doesn't do it before they're cached because the contents of the
+cache can change after responses are cached. It uses :c:func:`TSCacheRead`
+to check if the URL in the ``Location: ...`` header is already
+cached. In future, the plugin should also check if the URL is fresh
+or not.
+
+The plugin implements ``TS_HTTP_READ_RESPONSE_HDR_HOOK`` and a null
+transform to compute the SHA-256 digest for content as it's added
+to the cache, then uses :c:func:`TSCacheWrite` to associate the
+digest with the request URL. This adds a new cache object where the
+key is the digest and the object is the request URL.
+
+To check if the cache already contains content that matches a digest,
+the plugin must call :c:func:`TSCacheRead` with the digest as the
+key, read the URL stored in the resultant object, and then call
+:c:func:`TSCacheRead` again with this URL as the key. This is
+probably inefficient and should be improved.
+
+An early version of the plugin scanned ``Link: <...>; rel=duplicate``
+headers. If the URL in the ``Location: ...`` header was not already
+cached, it scanned ``Link: <...>; rel=duplicate`` headers for a URL
+that was. The ``Digest: SHA-256=...`` header is superior because it
+will find content that already exists in the cache in every case
+that a ``Link: <...>; rel=duplicate`` header would, plus in cases
+where the URL is not listed among the ``Link: <...>; rel=duplicate``
+headers, maybe because the content was downloaded from a URL not
+participating in the content distribution network, or maybe because
+there are too many mirrors to list in ``Link: <...>; rel=duplicate``
+headers.
+
+The ``Digest: SHA-256=...`` header is also more efficient than ``Link:
+<...>; rel=duplicate`` headers because it involves a constant number
+of cache lookups. :rfc:`6249` requires a ``Digest: SHA-256=...`` header
+or ``Link: <...>; rel=duplicate`` headers MUST be ignored:
+
+ If Instance Digests are not provided by the Metalink servers, the
+ Link header fields pertaining to this specification MUST be ignored.
+
+ Metalinks contain whole file hashes as described in Section 6,
+ and MUST include SHA-256, as specified in [FIPS-180-3].
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/mysql_remap.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/mysql_remap.en.rst b/doc/reference/plugins/mysql_remap.en.rst
new file mode 100644
index 0000000..6e7957e
--- /dev/null
+++ b/doc/reference/plugins/mysql_remap.en.rst
@@ -0,0 +1,83 @@
+MySQL Remap Plugin
+******************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+This is a basic plugin for doing dynamic "remaps" from a database. It
+essentially rewrites the incoming request's Host header / origin server
+connection to one retrieved from a database.
+
+The generic proxying setup is the following::
+
+ UA ----> Traffic Server ----> Origin Server
+
+Without the plugin a request like::
+
+ GET /path/to/something HTTP/1.1
+ Host: original.host.com
+
+Ends up requesting ``http://original.host.com/path/to/something``
+
+With this plugin enabled, you can easily change that to anywhere you
+desire. Imagine the many possibilities....
+
+We have benchmarked the plugin with ab at about 9200 requests/sec (1.7k
+object) on a commodity hardware with a local setup of both, MySQL and
+Traffic Server local. Real performance is likely to be substantially
+higher, up to the MySQL's max queries / second.
+
+Installation
+============
+
+This plugin is only built if the configure option ::
+
+ --enable-experimental-plugins
+
+is given at build time.
+
+Configuration
+=============
+
+Import the default schema to a database you create::
+
+ mysql -u root -p -e "CREATE DATABASE mysql_remap;" # create a new database
+ mysql -u root -p mysql_remap < schema/import.sql # import the provided schema
+
+insert some interesting values in mysql_remap.hostname &
+mysql_remap.map
+
+Traffic Server plugin configuration is done inside a global
+configuration file: ``/etc/trafficserver/plugin.config``::
+
+ mysql_remap.so /etc/trafficserver/mysql_remap.ini
+
+The INI file should contain the following values::
+
+ [mysql_remap]
+ mysql_host = localhost #default
+ mysql_port = 3306 #default
+ mysql_username = remap_user
+ mysql_password =
+ mysql_database = mysql_remap #default
+
+To debug errors, start trafficserver manually using::
+
+ traffic_server -T "mysql_remap"
+
+And resolve any errors or warnings displayed.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/regex_remap.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/regex_remap.en.rst b/doc/reference/plugins/regex_remap.en.rst
new file mode 100644
index 0000000..a98107b
--- /dev/null
+++ b/doc/reference/plugins/regex_remap.en.rst
@@ -0,0 +1,131 @@
+Regex Remap Plugin
+******************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+This allows you to configure mapping rules based on regular expressions.
+This is similar to what you can accomplish using mod_rewrite in Apache
+httpd, but obviously not as flexible or sophisticated (yet).
+
+To use this plugin, configure a remap.config rule like ::
+
+ map http://a.com http://b.com @plugin=regex_remap.so @pparam=maps.reg
+
+The parameter with the file name is always required, and the regular
+expressions within are evaluated sequentially from the first to the
+last. When a regular expression is positively matched against a request
+URL, evaluation is stopped and the rewrite rule is applied. If none of
+the regular expressions are a match, the default destination URL is
+applied (``http://b.com`` in the example above).
+
+An optional argument (``@pparam``) with the string "``profile``\ " will
+enable profiling of this regex remap rule, e.g. ::
+
+ ... @pparam=maps.reg @pparam=profile
+
+Profiling is very low overhead, and the information is dumped to
+``traffic.out``, located in the log directory. This information is
+useful to optimize the order of your regular expression, such that the
+most common matches appears early in the file. In order to force a
+profile dump, you can do ::
+
+ $ sudo touch remap.config
+ $ sudo traffic_line -x
+
+By default, only the path and query string of the URL are provided for
+the regular expressions to match. The following optional parameters can
+be used to modify the plugin instance behavior ::
+
+ @pparam=[no-]method [default: off]
+ @pparam=[no-]query-string [default: on]
+ @pparam=[no-]matrix-parameters [default: off]
+
+If you wish to match on the HTTP method used (e.g. "``GET``\ "),
+you must use the option ``@pparam=method``. e.g. ::
+
+ ... @pparam=maps.reg @pparam=method
+
+With this enabled, the string that you will need to match will look
+like ::
+
+ GET/path?query=bar
+
+
+The methods are always all upper-case, and always followed by one single
+space. There is no space between the method and the rest of the URL (or
+URI path).
+
+By default, the query string is part of the string that is matched
+again, to turn this off use the option 'no-query-string', e.g. ::
+
+ ... @pparam=maps.reg @pparam=no-query-string
+
+Finally, you can also include the matrix parameters in the string, using
+the option 'matrix-parameters', e.g. ::
+
+ ... @pparam=maps.reg @pparam=matrix-parameters
+
+The config file (``maps.reg`` above) can be placed anywhere, but unless
+you specify an absolute path (as above), it will default to ::
+
+ /usr/local/etc/regex_remap
+
+A typical regex would look like ::
+
+ ^/(ogre.*)/more http://www.ogre.com/$h/$0/$1
+
+The regular expression must not contain any white spaces!
+
+When the regular expression is matched, only the URL path + query string
+is matched (without any of the optional configuration options). The path
+will always start with a "/". Various substitution strings are allowed
+on the right hand side during evaluation ::
+
+ $0 - The entire matched string
+ $1-9 - Regular expression groups ($1 first group etc.)
+ $h - The original host header from the request
+ $f - The host as used in the "from" portion of the remap rule
+ $t - The host as used in the "to" portion of the remap rule
+ $p - The original port number
+ $s - The scheme (e.g. http) of the request
+ $P - The entire path of the request
+ $q - The query part of the request
+ $r - The path parameters of the request (not implemented yet)
+ $c - The cookie string from the request
+ $i - The client IP for this request
+
+You can also provide options, similar to how you configure your
+remap.config. The following options are available ::
+
+ @status=<nnn> - Force the response code to <nnn>
+ @active_timeout=<nnn> - Active timeout (in ms)
+ @no_activity_timeout=<nnn> - No activity timeout (in ms)
+ @connect_timeout=<nnn> - Connect timeouts (in ms)
+ @dns_timeout=<nnn> - Connect timeouts (in ms)
+
+This can be useful to force a particular response for some URLs, e.g. ::
+
+ ^/(ogre.*)/bad http://www.examle.com/ @status=404
+
+Or, to force a 302 redirect ::
+
+ ^/oldurl/(.*)$ http://news.example.com/new/$1 @status=302
+
+Setting the status to 301 or 302 will force the new URL to be used
+as a redirect (Location:).
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/stale_while_revalidate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/stale_while_revalidate.en.rst b/doc/reference/plugins/stale_while_revalidate.en.rst
new file mode 100644
index 0000000..0a59c90
--- /dev/null
+++ b/doc/reference/plugins/stale_while_revalidate.en.rst
@@ -0,0 +1,21 @@
+Stale While Revalidate Plugin (undocumented)
+********************************************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+refresh content asynchronously while serving stale data
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/plugins/stats_over_http.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/plugins/stats_over_http.en.rst b/doc/reference/plugins/stats_over_http.en.rst
new file mode 100644
index 0000000..39b69be
--- /dev/null
+++ b/doc/reference/plugins/stats_over_http.en.rst
@@ -0,0 +1,50 @@
+Stats over HTTP Plugin
+**********************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+
+This plugin implements an HTTP interface to all Traffic Server statistics. The
+metrics returned are in a JSON format, for easy processing. This plugin is now
+part of the standard ATS build process, and should be available after install.
+
+To enable this plugin, add to the plugin.conf file::
+
+ stats_over_http.so
+
+
+After starting Traffic Server, the JSON metrics are now available on the
+default URL::
+
+ http://host:port/_stats
+
+
+where host and port is the hostname/IP and port number of the server. You can
+optionally modify the path to use, and this is highly recommended in a public
+facing server. For example::
+
+ stats_over_http.so 81c075bc0cca1435ea899ba4ad72766b
+
+
+and the URL would then be e.g.::
+
+ https://host:port/81c075bc0cca1435ea899ba4ad72766b
+
+
+This is weak security at best, since the secret could possibly leak if you are
+careless and send it over clear text.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/sdk/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/index.en.rst b/doc/sdk/index.en.rst
index da45d84..cab4d0c 100644
--- a/doc/sdk/index.en.rst
+++ b/doc/sdk/index.en.rst
@@ -63,11 +63,3 @@ Contents:
adding-statistics.en
sample-source-code.en
troubleshooting-tips.en
- man/index.en
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/sdk/man/TSAPI.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/man/TSAPI.en.rst b/doc/sdk/man/TSAPI.en.rst
deleted file mode 100644
index d2ab1b2..0000000
--- a/doc/sdk/man/TSAPI.en.rst
+++ /dev/null
@@ -1,143 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
-.. default-domain:: c
-
-=======
-`TSAPI`
-=======
-
-Synopsis
-========
-| `#include <ts/ts.h>`
-| `#include <ts/remap.h>`
-
-Description
-===========
-The Apache Traffic Server API enables you to create plugins, using
-the C programming language, that customize the behavior of your
-Traffic Server installation.
-
-Traffic Server enables sophisticated caching and processing of
-web-related traffic, such as DNS and HTTP requests and responses.
-Traffic Server itself consists of an event-driven loop that can be
-simplified as follows::
-
- for (;;) {
- event = get_next_event();
- handle_event (event);
- }
-
-You compile your plugin source code to create a shared library that
-Traffic Server loads when it is started. Your plugin contains
-callback functions that are registered for specific Traffic Server
-events. When Traffic Server needs to process an event, it invokes
-any and all call-back functions you've registered for that event
-type.
-
-Possible uses for plugins include the following:
-
-* HTTP processing plugins can filter, blacklist, authorize users or transform content.
-* Protocol plugins can enable Traffic Server to proxy-cache new protocol content.
-* A blacklisting plugin denies attempts to access web sites that are off-limits.
-* Append transform plugins add data to HTTP response content.
-* An image conversion plugin transforms JPEG images to GIF images.
-* Compression plugins send response content to a compression server
- that compresses the data (alternatively, a compression library local
- to the Traffic Server host machine could do the compression).
-* Authorization plugins check a user's permissions to access
- particular web sites. The plugin could consult a local authorization
- program or send queries to an authorization server.
-* A plugin that gathers client information from request headers
- and enters this information in a database.
-* A protocol plugin listen for specific protocol requests on a
- designated port and then uses Traffic Server's proxy server and
- cache to serve client requests.
-
-Naming conventions
-==================
-
-The Traffic Server API adheres to the following naming conventions:
-
-* The TS prefix is used for all function and variable names defined
- in the Traffic Server API. For example, :data:`TS_EVENT_NONE`, :type:`TSMutex`,
- and :func:`TSContCreate`.
-* Enumerated values are always written in all uppercase letters.
- For example, :data:`TS_EVENT_NONE` and :data:`TS_VC_CLOSE_ABORT`.
-* Constant values are all uppercase; enumerated values can be seen
- as a subset of constants. For example, :data:`TS_URL_SCHEME_FILE` and
- :data:`TS_MIME_FIELD_ACCEPT`.
-* The names of defined types are mixed-case. For example, :type:`TSHttpSsn`
- and :func:`TSHttpTxn`. :func:`TSDebug`
-* Function names are mixed-case. For example, :func:`TSUrlCreate`
- and :func:`TSContDestroy`.
-* Function names use the following subject-verb naming style:
- TS-<subject>-<verb>, where <subject> goes from general to specific.
- This makes it easier to determine what a function does by reading
- its name. For example, the function to retrieve the password field
- (the specific subject) from a URL (the general subject) is
- :func:`TSUrlPasswordGet`.
-* Common verbs like Create, Destroy, Get, Set, Copy, Find, Retrieve,
- Insert, Remove, and Delete are used only when appropriate.
-
-Plugin loading and configuration
-================================
-
-When Traffic Server is first started, it consults the plugin.config
-file to determine the names of all shared plugin libraries that
-need to be loaded. The plugin.config file also defines arguments
-that are to be passed to each plugin's initialization function,
-:func:`TSPluginInit`. The :file:`records.config` file defines the path to
-each plugin shared library.
-
-The sample :file:`plugin.config` file below contains a comment line, a blank
-line, and two plugin configurations::
-
- # This is a comment line.
- my-plugin.so www.junk.com www.trash.com www.garbage.com
- some-plugin.so arg1 arg2 $proxy.config.http.cache.on
-
-Each plugin configuration in the :file:`plugin.config` file resembles
-a UNIX or DOS shell command; each line in :file:`plugin.config`
-cannot exceed 1023 characters.
-
-The first plugin configuration is for a plugin named my-plugin.so.
-It contains three arguments that are to be passed to that plugin's
-initialization routine. The second configuration is for a plugin
-named some-plugin.so; it contains three arguments. The last argument,
-$proxy.config.http.cache.on, is actually a configuration variable.
-Traffic Server will look up the specified configuration variable
-and substitute its value.
-
-Plugins are loaded and initialized by Traffic Server in the order
-they appear in the :file:`plugin.config` file.
-
-Plugin initialization
-=====================
-
-Each plugin must define an initialization function named
-:func:`TSPluginInit` that Traffic Server invokes when the
-plugin is loaded. :func:`TSPluginInit` is commonly used to
-read configuration information and register hooks for event
-notification.
-
-Files
-=====
-:file:`{CONFIG_DIR}/plugin.config`, :file:`{CONFIG_DIR}/records.config`
-
-See also
-========
-:manpage:`TSPluginInit(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/sdk/man/TSDebug.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/man/TSDebug.en.rst b/doc/sdk/man/TSDebug.en.rst
deleted file mode 100644
index 6471fa5..0000000
--- a/doc/sdk/man/TSDebug.en.rst
+++ /dev/null
@@ -1,83 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
-.. default-domain:: c
-
-==========
-`TSDebug`
-==========
-
-Library
-=======
-Apache Traffic Server plugin API
-
-Synopsis
-========
-`#include <ts/ts.h>`
-
-.. function:: void TSDebug(const char * tag, const char * format, ...)
-.. function:: void TSError(const char * tag, const char * format, ...)
-.. function:: int TSIsDebugTagSet(const char * tag)
-.. function:: void TSDebugSpecific(int debug_flag, const char * tag, const char * format, ...)
-.. function:: void TSHttpTxnDebugSet(TSHttpTxn txnp, int on)
-.. function:: void TSHttpSsnDebugSet(TSHttpSsn ssn, int on)
-.. function:: int TSHttpTxnDebugGet(TSHttpTxn txnp)
-.. function:: int TSHttpSsnDebugGet(TSHttpSsn ssn)
-.. macro:: void TSAssert(expression)
-.. macro:: void TSReleaseAssert(expression)
-
-Description
-===========
-
-:func:`TSError` is similar to :func:`printf` except that instead
-of writing the output to the C standard output, it writes output
-to the Traffic Server error log.
-
-:func:`TSDebug` is the same as :func:`TSError` except that it only
-logs the debug message if the given debug tag is enabled. It writes
-output to the Traffic Server debug log.
-
-:func:`TSIsDebugTagSet` returns non-zero if the given debug tag is
-enabled.
-
-In debug mode, :macro:`TSAssert` Traffic Server to prints the file
-name, line number and expression, and then aborts. In release mode,
-the expression is not removed but the effects of printing an error
-message and aborting are. :macro:`TSReleaseAssert` prints an error
-message and aborts in both release and debug mode.
-
-:func:`TSDebugSpecific` emits a debug line even if the debug tag
-is turned off, as long as debug flag is enabled. This can be used
-in conjuction with :func:`TSHttpTxnDebugSet`, :func:`TSHttpSsnDebugSet`,
-:func:`TSHttpTxnDebugGet` and :func:`TSHttpSsnDebugGet` to enable
-debugging on specific session and transaction objects.
-
-Examples
-========
-
-This example uses :func:`TSDebugSpecific` to log a message when a specific
-debugging flag is enabled::
-
- #include <ts/ts.h>
-
- // Emit debug message if "tag" is enabled or the txn debug
- // flag is set.
- TSDebugSpecifc(TSHttpTxnDebugGet(txn), "tag" ,
- "Hello World from transaction %p", txn);
-
-SEE ALSO
-========
-:manpage:`TSAPI(3ts)`, :manpage:`printf(3)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/sdk/man/TSHttpHookAdd.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/man/TSHttpHookAdd.en.rst b/doc/sdk/man/TSHttpHookAdd.en.rst
deleted file mode 100644
index d791db5..0000000
--- a/doc/sdk/man/TSHttpHookAdd.en.rst
+++ /dev/null
@@ -1,120 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
-
-.. default-domain:: c
-
-===============
-`TSHttpHookAdd`
-===============
-
-Library
-=======
-Apache Traffic Server plugin API
-
-Synopsis
-========
-`#include <ts/ts.h>`
-
-.. function:: void TSHttpHookAdd(TSHttpHookID id, TSCont contp)
-.. function:: void TSHttpSsnHookAdd(TSHttpSsn ssnp, TSHttpHookID id, TSCont contp)
-.. function:: void TSHttpTxnHookAdd(TSHttpTxn txnp, TSHttpHookID id, TSCont contp)
-
-Description
-===========
-
-Hooks are points in Apache Traffic Server transaction HTTP processing
-where plugins can step in and do some work. Registering a plugin
-function for callback amounts to adding the function to a hook. You
-can register your plugin to be called back for every single
-transaction, or for specific transactions only.
-
-HTTP transaction hooks are set on a global basis using the function
-:func:`TSHttpHookAdd`. This means that the continuation specified
-as the parameter to :func:`TSHttpHookAdd` is called for every
-transaction. :func:`TSHttpHookAdd` is typically called from
-:func:`TSPluginInit` or :func:`TSRemapInit`.
-
-A session consists of a single client connection to Traffic Server.
-A session can consist of several transactions in succession. The
-session starts when the client connection opens, and ends when the
-connection closes. :func:`TSHttpSsnHookAdd` adds :data:`contp` to
-the end of the list of HTTP transaction hooks specified by :data:`id`.
-This means that :data:`contp` is called back for every transaction
-within the session, at the point specified by the hook ID. Since
-:data:`contp` is added to a session, it is not possible to call
-:func:`TSHttpSsnHookAdd` from the plugin initialization routine;
-the plugin needs a handle to an HTTP session.
-
-A transaction consists of a single HTTP request from a client and
-the response that Traffic Server sends to that client. A transaction
-begins when Traffic Server receives a request, and ends when Traffic
-Server sends the response. :func:`TSHttpTxnHookAdd` adds :data:`contp`
-to the end of the list of HTTP transaction hooks specified by
-:data:`id`. Since :data:`contp` is added to a transaction, it is
-not possible to call :func:`TSHttpTxnHookAdd` from the plugin
-initialization routine but only when the plugin has a handle to an
-HTTP transaction.
-
-Return values
-=============
-
-None. Adding hooks is always successful.
-
-Examples
-========
-
-The following example demonstrates how to add global, session and
-transaction hooks::
-
- #include <ts/ts.h>
-
- static int
- handler(TSCont contp, TSEvent event, void *edata)
- {
- TSHttpSsn ssnp;
- TSHttpTxn txnp;
-
- switch (event){
- case TS_EVENT_HTTP_SSN_START:
- ssnp = (TSHttpSsn) edata;
- // Add a session hook ...
- TSHttpSsnHookAdd(ssnp, TS_HTTP_TXN_START_HOOK, contp);
- TSHttpSsnReenable(ssnp, TS_EVENT_HTTP_CONTINUE);
- return 0;
- case TS_EVENT_HTTP_TXN_START:
- txnp = (TSHttpTxn) edata;
- // Add a transaction hook ...
- TSHttpTxnHookAdd(ssnp, TS_HTTP_READ_REQUEST_HDR_HOOK, contp);
- TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE);
- return 0;
- default:
- break;
- }
-
- return 0;
- }
-
- void
- TSPluginInit (int argc, const char *argv[])
- {
- TSCont contp;
- contp = TSContCreate(handler, NULL);
- TSHttpHookAdd(TS_HTTP_SSN_START_HOOK, contp);
- }
-
-SEE ALSO
-========
-:manpage:`TSAPI(3ts)`, :manpage:`TSContCreate(3ts)`
[6/7] docs: split reference material into top-level pages
Posted by jp...@apache.org.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/records.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/records.config.en.rst b/doc/admin/configuration-files/records.config.en.rst
deleted file mode 100644
index a17fbbd..0000000
--- a/doc/admin/configuration-files/records.config.en.rst
+++ /dev/null
@@ -1,1758 +0,0 @@
-..
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-==============
-records.config
-==============
-
-.. configfile:: records.config
-
-The :file:`records.config` file is a list of configurable variables used by
-the Traffic Server software. Many of the variables in the
-:file:`records.config` file are set automatically when you set configuration
-options in Traffic Line or Traffic Shell. After you modify the
-:file:`records.config` file,
-run the command :option:`traffic_line -x` to apply the changes.
-When you apply changes to one node in a cluster, Traffic Server
-automatically applies the changes to all other nodes in the cluster.
-
-Format
-======
-
-Each variable has the following format::
-
- SCOPE variable_name DATATYPE variable_value
-
-where
-
-``SCOPE`` is related to clustering and is either ``CONFIG`` (all members of the cluster) or ``LOCAL`` (only the local machine)
-
-``DATATYPE`` is one of ``INT`` (integer), ``STRING`` (string), ``FLOAT`` (floating point).
-
-A variable marked as ``Deprecated`` is still functional but should be avoided as it may be removed in a future release without warning.
-
-A variable marked as ``Reloadable`` can be updated via the command::
-
- traffic_line -x
-
-Examples
-========
-
-In the following example, the variable `proxy.config.proxy_name`_ is
-a ``STRING`` datatype with the value ``my_server``. This means that the
-name of the Traffic Server proxy is ``my_server``. ::
-
- CONFIG proxy.config.proxy_name STRING my_server
-
-If the server name should be ``that_server`` the line would be ::
-
- CONFIG proxy.config.proxy_name STRING that_server
-
-In the following example, the variable ``proxy.config.arm.enabled`` is
-a yes/no flag. A value of ``0`` (zero) disables the option; a value of
-``1`` enables the option. ::
-
- CONFIG proxy.config.arm.enabled INT 0
-
-In the following example, the variable sets the cluster startup timeout
-to 10 seconds. ::
-
- CONFIG proxy.config.cluster.startup_timeout INT 10
-
-Environment Overrides
-=====================
-
-Every :file:`records.config` configuration variable can be overridden
-by a corresponding environment variable. This can be useful in
-situations where you need a static :file:`records.config` but still
-want to tweak one or two settings. The override variable is formed
-by converting the :file:`records.config` variable name to upper
-case, and replacing any dot separators with an underscore.
-
-Overriding a variable from the environment is permanent and will
-not be affected by future configuration changes made in
-:file:`records.config` or applied with :program:`traffic_line`.
-
-For example, we could override the `proxy.config.product_company`_ variable
-like this::
-
- $ PROXY_CONFIG_PRODUCT_COMPANY=example traffic_cop &
- $ traffic_line -r proxy.config.product_company
-
-Configuration Variables
-=======================
-
-The following list describes the configuration variables available in
-the :file:`records.config` file.
-
-System Variables
-----------------
-
-.. ts:confvar:: CONFIG proxy.config.product_company STRING Apache Software Foundation
-
- The name of the organization developing Traffic Server.
-
-.. ts:confvar:: CONFIG proxy.config.product_vendor STRING Apache
-
- The name of the vendor providing Traffic Server.
-
-.. ts:confvar:: CONFIG proxy.config.product_name STRING Traffic Server
-
- The name of the product.
-
-.. ts:confvar:: CONFIG proxy.config.proxy_name STRING ``build_machine``
- :reloadable:
-
- The name of the Traffic Server node.
-
-.. ts:confvar:: CONFIG proxy.config.bin_path STRING bin
-
- The location of the Traffic Server ``bin`` directory.
-
-.. ts:confvar:: CONFIG proxy.config.proxy_binary STRING traffic_server
-
- The name of the executable that runs the ``traffic_server`` process.
-
-.. ts:confvar:: CONFIG proxy.config.proxy_binary_opts STRING -M
-
- The command-line options for starting Traffic Server.
-
-.. ts:confvar:: CONFIG proxy.config.manager_binary STRING traffic_manager
-
- The name of the executable that runs the ``traffic_manager`` process.
-
-.. ts:confvar:: CONFIG proxy.config.cli_binary STRING traffic_line
-
- The name of the executable that runs the command-line interface :program:`traffic_line`.
-
-.. ts:confvar:: CONFIG proxy.config.watch_script STRING traffic_cop
-
- The name of the executable that runs the ``traffic_cop`` process.
-
-.. ts:confvar:: CONFIG proxy.config.env_prep STRING
-
- The script executed before the ``traffic_manager`` process spawns
- the ``traffic_server`` process.
-
-.. ts:confvar:: CONFIG proxy.config.config_dir STRING config
-
- The directory that contains Traffic Server configuration files.
-
-.. ts:confvar:: CONFIG proxy.config.temp_dir STRING /tmp
-
- The directory used for Traffic Server temporary files.
-
-.. ts:confvar:: CONFIG proxy.config.alarm_email STRING
- :reloadable:
-
- The email address to which Traffic Server sends alarm messages.
-
-During a custom Traffic Server installation, you can specify the email address;
-otherwise, Traffic Server uses the Traffic Server user account name as the default value for this variable.
-
-.. ts:confvar:: CONFIG proxy.config.syslog_facility STRING LOG_DAEMON
-
- The facility used to record system log files. Refer to
- `Understanding Traffic Server Log Files <../working-log-files#UnderstandingTrafficServerLogFiles>`_.
-
-.. ts:confvar:: CONFIG proxy.config.cop.core_signal INT 0
-
- The signal sent to ``traffic_cop``'s managed processes to stop them.
-
-A value of ``0`` means no signal will be sent.
-
-.. ts:confvar:: CONFIG proxy.config.cop.linux_min_swapfree_kb INT 10240
-
- The minimum amount of free swap space allowed before Traffic Server stops the ``traffic_server`` and ``traffic_manager`` processes to
- prevent the system from hanging. This configuration variable applies if swap is enabled in Linux 2.2 only.
-
-.. ts:confvar:: CONFIG proxy.config.output.logfile STRING traffic.out
-
- The name and location of the file that contains warnings, status messages, and error messages produced by the Traffic Server
- processes. If no path is specified, then Traffic Server creates the file in its logging directory.
-
-.. ts:confvar:: CONFIG proxy.config.snapshot_dir STRING snapshots
-
- The directory in which Traffic Server stores configuration snapshots on the local system. Unless you specify an absolute path, this
- directory is located in the Traffic Server ``config`` directory.
-
-.. ts:confvar:: CONFIG proxy.config.exec_thread.autoconfig INT 1
-
- When enabled (the default, ``1``), Traffic Server scales threads according to the available CPU cores. See the config option below.
-
-.. ts:confvar:: CONFIG proxy.config.exec_thread.autoconfig.scale FLOAT 1.5
-
- Factor by which Traffic Server scales the number of threads. The multiplier is usually the number of available CPU cores. By default
- this is scaling factor is ``1.5``.
-
-.. ts:confvar:: CONFIG proxy.config.exec_thread.limit INT 2
-
- *XXX* What does this do?
-
-.. ts:confvar:: CONFIG proxy.config.accept_threads INT 0
-
- When enabled (``1``), runs a separate thread for accept processing. If disabled (``0``), then only 1 thread can be created.
-
-.. ts:confvar:: CONFIG proxy.config.thread.default.stacksize INT 1096908
-
- The new default thread stack size, for all threads. The original default is set at 1 MB.
-
-Network
-=======
-
-.. ts:confvar:: LOCAL proxy.local.incoming_ip_to_bind STRING 0.0.0.0 ::
-
- Controls the global default IP addresses to which to bind proxy server ports. The value is a space separated list of IP addresses, one per supported IP address family (currently IPv4 and IPv6).
-
-Unless explicitly specified in `proxy.config.http.server_ports`_ the server port will be bound to one of these addresses, selected by IP address family. The built in default is any address. This is used if no address for a family is specified. This setting is useful if most or all server ports should be bound to the same address.
-
-.. note:: This is ignored for inbound transparent server ports because they must be able to accept connections on arbitrary IP addresses.
-
-.. topic:: Example
-
- Set the global default for IPv4 to ``192.168.101.18`` and leave the global default for IPv6 as any address.::
-
- LOCAL proxy.local.incoming_ip_to_bind STRING 192.168.101.18
-
-.. topic:: Example
-
- Set the global default for IPv4 to ``191.68.101.18`` and the global default for IPv6 to ``fc07:192:168:101::17``.::
-
- LOCAL proxy.local.incoming_ip_to_bind STRING 192.168.101.18 fc07:192:168:101::17
-
-.. ts:confvar:: LOCAL proxy.local.outgoing_ip_to_bind STRING 0.0.0.0 ::
-
- This controls the global default for the local IP address for outbound connections to origin servers. The value is a list of space separated IP addresses, one per supported IP address family (currently IPv4 and IPv6).
-
- Unless explicitly specified in `proxy.config.http.server_ports`_ one of these addresses, selected by IP address family, will be used as the local address for outbound connections. This setting is useful if most or all of the server ports should use the same outbound IP addresses.
-
-.. note:: This is ignore for outbound transparent ports as the local outbound address will be the same as the client local address.
-
-.. topic:: Example
-
- Set the default local outbound IP address for IPv4 connectionsn to ``192.168.101.18``.::
-
- LOCAL proxy.local.outgoing_ip_to_bind STRING 192.168.101.18
-
-.. topic:: Example
-
- Set the default local outbound IP address to ``192.168.101.17`` for IPv4 and ``fc07:192:168:101::17`` for IPv6.::
-
- LOCAL proxy.local.outgoing_ip_to_bind STRING 192.168.101.17 fc07:192:168:101::17
-
-Cluster
-=======
-
-.. ts:confvar:: LOCAL proxy.local.cluster.type INT 3
-
- Sets the clustering mode:
-
-===== ====================
-Value Effect
-===== ====================
-1 full-clustering mode
-2 management-only mode
-3 no clustering
-===== ====================
-
-.. ts:confvar:: CONFIG proxy.config.cluster.rsport INT 8088
-
- The reliable service port. The reliable service port is used to send configuration information between the nodes in a cluster. All nodes
- in a cluster must use the same reliable service port.
-
-.. ts:confvar:: CONFIG proxy.config.cluster.threads INT 1
-
- The number of threads for cluster communication. On heavy cluster, the number should be adjusted. It is recommend that take the thread
- CPU usage as a reference when adjusting.
-
-Local Manager
-=============
-
-.. ts:confvar:: CONFIG proxy.config.lm.sem_id INT 11452
-
- The semaphore ID for the local manager.
-
-.. ts:confvar:: CONFIG proxy.config.admin.autoconf_port INT 8083
-
- The autoconfiguration port.
-
-.. ts:confvar:: CONFIG proxy.config.admin.number_config_bak INT 3
-
- The maximum number of copies of rolled configuration files to keep.
-
-.. ts:confvar:: CONFIG proxy.config.admin.user_id STRING nobody
-
- Option used to specify who to run the ``traffic_server`` process as; also used to specify ownership of config and log files.
-
-The nonprivileged user account designated to Traffic Server.
-
-As of version 2.1.1 if the user_id is prefixed with pound character (#) the remaining of the string is considered to be
-``numeric user identifier <http://en.wikipedia.org/wiki/User_identifier>``_.
-If the value is set to ``#-1`` Traffic Server will not change the user during startup.
-
-Setting ``user_id`` to ``root`` or ``#0`` is now forbidden to
-increase security. Trying to do so, will cause the
-``traffic_server`` fatal failure. However there are two ways to
-bypass that restriction: Specify ``-DBIG_SECURITY_HOLE`` in
-``CXXFLAGS`` during compilation. Set the ``user_id=#-1`` and start
-trafficserver as root.
-
-Process Manager
-===============
-
-.. ts:confvar:: CONFIOG proxy.config.process_manager.mgmt_port INT 8084
-
- The port used for internal communication between the ``traffic_manager`` and ``traffic_server`` processes.
-
-Alarm Configuration
-===================
-
-.. ts:confvar:: CONFIG proxy.config.alarm.bin STRING example_alarm_bin.sh
-
- Name of the script file that can execute certain actions when an alarm is signaled. The default file is a sample script named
- ``example_alarm_bin.sh`` located in the ``bin`` directory. You must dit the script to suit your needs.
-
-.. ts:confvar:: CONFIG proxy.config.alarm.abs_path STRING NULL
-
- The full path to the script file that sends email to alert someone bout Traffic Server problems.
-
-HTTP Engine
-===========
-
-.. ts:confvar:: CONFIG proxy.config.http.server_ports STRING 8080
-
- Ports used for proxying HTTP traffic.
-
-This is a list, separated by space or comma, of :index:`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. The case of keywords is ignored. The order of keywords is irrelevant but unspecified results may occur if incompatible options are used (noted below). Options without values are idempotent. Options with values use the last (right most) value specified, except for ``ip-out`` as detailed later.
-
-Quick reference chart.
-
-=========== =============== ========================================
-Name Note Definition
-=========== =============== ========================================
-*number* **Required** The local port.
-ipv4 **Default** Bind to IPv4 address family.
-ipv6 Bind to IPv6 address family.
-tr-in Inbound transparent.
-tr-out Outbound transparent.
-tr-full Fully transparent (inbound and outbound)
-tr-pass Pass through enabled.
-ssl SSL terminated.
-ip-in **Value** Local inbound IP address.
-ip-out **Value** Local outbound IP address.
-ip-resolve **Value** IP address resolution style.
-blind Blind (``CONNECT``) port.
-compress **N/I** Compressed. Not implemented.
-=========== =============== ========================================
-
-*number*
- Local IP port to bind. This is the port to which ATS clients will connect.
-
-ipv4
- Use IPv4. This is the default and is included primarily for completeness. This forced if the ``ip-in`` option is used with an IPv4 address.
-
-ipv6
- Use IPv6. This is forced if the ``ip-in`` option is used with an IPv6 address.
-
-tr-in
- Inbound transparent. The proxy port will accept connections to any IP address on the port. To have IPv6 inbound transparent you must use this and the ``ipv6`` option. This overrides `proxy.local.incoming_ip_to_bind`_.
-
- Not compatible with: ``ip-in``, ``ssl``, ``blind``
-
-tr-out
- Outbound transparent. If ATS connects to an origin server for a transaction on this port, it will use the client's address as its local address. This overrides `proxy.local.outgoing_ip_to_bind`_.
-
- Not compatible with: ``ip-out``, ``ssl``
-
-tr-full
- Fully transparent. This is a convenience option and is identical to specifying both ``tr-in`` and ``tr-out``.
-
- Not compatible with: Any option not compatible with ``tr-in`` or ``tr-out``.
-
-tr-pass
- Transparent pass through. This option is useful only for inbound transparent proxy ports. If the parsing of the expected HTTP header fails, then the transaction is switched to a blind tunnel instead of generating an error response to the client. It effectively enables `proxy.config.http.use_client_target_addr`_ for the transaction as there is no other place to obtain the origin server address.
-
-ip-in
- Set the local IP address for the port. This is the address to which clients will connect. This forces the IP address family for the port. The ``ipv4`` or ``ipv6`` can be used but it is optional and is an error for it to disagree with the IP address family of this value. An IPv6 address **must** be enclosed in square brackets. If this is omitted `proxy.local.incoming_ip_to_bind`_ is used.
-
- Not compatible with: ``tr-in``.
-
-ip-out
- Set the local IP address for outbound connections. This is the address used by ATS locally when it connects to an origin server for transactions on this port. If this is omitted `proxy.local.outgoing_ip_to_bind`_ is used.
-
- This option can used multiple times, once for each IP address family. The address used is selected by the IP address family of the origin server address.
-
- Not compatible with: ``tr-out``.
-
-ip-resolve
- Set the IP address resolution style for the origin server for transactions on this proxy port.
-
-ssl
- Require SSL termination for inbound connections. SSL must be configured for this option to provide a functional server port.
-
- Not compatible with: ``tr-in``, ``tr-out``, ``blind``.
-
-blind
- Accept only ``CONNECT`` transactions on this port.
-
- Not compatible with: ``tr-in``, ``ssl``.
-
-compress
- Compress the connection. Retained only by inertia, should be considered "not implemented".
-
-.. topic:: Example
-
- Listen on port 80 on any address for IPv4 and IPv6.::
-
- 80 80:ipv6
-
-.. topic:: Example
-
- Listen transparently on any IPv4 address on port 8080, and
- transparently on port 8080 on local address ``fc01:10:10:1::1``
- (which implies ``ipv6``).::
-
- IPv4:tr-FULL:8080 TR-full:IP-in=[fc02:10:10:1::1]:8080
-
-.. topic:: Example
-
- Listen on port 8080 for IPv6, fully transparent. Set up an SSL port on 443. These ports will use the IP address from `proxy.local.incoming_ip_to_bind`_. 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.::
-
- 8080:ipv6:tr-full 443:ssl ip-in=192.168.17.1:80:ip-out=[fc01:10:10:1::1]:ip-out=10.10.10.1
-
-.. ts:confvar:: CONFIG proxy.config.http.connect_ports STRING 443 563
-
- The range of origin server ports that can be used for tunneling via ``CONNECT``.
-
-Traffic Server allows tunnels only to the specified ports.
-Supports both wildcards ('\*') and ranges ("0-1023").
-
-.. note:: These are the ports on the *origin server*, not `server ports <#proxy-config-http-server-ports>`_.
-
-.. ts:confvar:: CONFIG proxy.config.http.insert_request_via_str INT 1
- :reloadable:
-
- Set how the ``Via`` field is handled on a request to the origin server.
-
-===== ============================================
-Value Effect
-===== ============================================
-0 no extra information is added to the string.
-1 all extra information is added.
-2 some extra information is added.
-===== ============================================
-
-.. note:: the ``Via`` header string interpretation can be `decoded here. </tools/via>`_
-
-.. ts:confvar:: CONFIG proxy.config.http.insert_response_via_str INT 1
- :reloadable:
-
- Set how the ``Via`` field is handled on the response to the client.
-
-===== ======================
-Value Effect
-===== ======================
-0 no extra information is added to the string.
-1 all extra information is added.
-2 some extra information is added.
-===== ======================
-
-.. ts:confvar:: CONFIG proxy.config.http.response_server_enabled INT 1
- :reloadable:
-
- You can specify one of the following:
-
- - ``0`` no Server: header is added to the response.
- - ``1`` the Server: header is added (see string below).
- - ``2`` the Server: header is added only if the response from rigin does not have one already.
-
-.. ts:confvar:: CONFIG proxy.config.http.insert_age_in_response INT 1
- :reloadable:
-
- This option specifies whether Traffic Server should insert an ``Age`` header in the response. The Age field value is the cache's
- estimate of the amount of time since the response was generated or revalidated by the origin server.
-
- - ``0`` no ``Age`` header is added
- - ``1`` the ``Age`` header is added
-
-.. ts:confvar:: CONFIG proxy.config.http.response_server_str STRING ATS/
- :reloadable:
-
- The Server: string that ATS will insert in a response header (if requested, see above). Note that the current version number is
- always appended to this string.
-
-.. ts:confvar:: CONFIG proxy.config.http.enable_url_expandomatic INT 1
- :reloadable:
-
- Enables (``1``) or disables (``0``) ``.com`` domain expansion. This configures the Traffic Server to resolve unqualified hostnames by
- prepending with ``www.`` and appending with ``.com`` before redirecting to the expanded address. For example: if a client makes
- a request to ``host``, then Traffic Server redirects the request to ``www.host.com``.
-
-.. ts:confvar:: CONFIG proxy.config.http.chunking_enabled INT 1
- :reloadable:
-
- Specifies whether Traffic Sever can generate a chunked response:
-
- - ``0`` Never
- - ``1`` Always
- - ``2`` Generate a chunked response if the server has returned HTTP/1.1 before
- - ``3`` = Generate a chunked response if the client request is HTTP/1.1 and the origin server has returned HTTP/1.1 before
-
- **Note:** If HTTP/1.1 is used, then Traffic Server can use
- keep-alive connections with pipelining to origin servers. If
- HTTP/0.9 is used, then Traffic Server does not use ``keep-alive``
- connections to origin servers. If HTTP/1.0 is used, then Traffic
- Server can use ``keep-alive`` connections without pipelining to
- origin servers.
-
-.. ts:confvar:: CONFIG proxy.config.http.share_server_sessions INT 1
-
- Enables (``1``) or disables (``0``) the reuse of server sessions.
-
-.. ts:confvar:: CONFIG proxy.config.http.record_heartbeat INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) ``traffic_cop`` heartbeat ogging.
-
-.. ts:confvar:: CONFIG proxy.config.http.use_client_target_addr INT 0
-
- For fully transparent ports use the same origin server address as the client.
-
-This option causes Traffic Server to avoid where possible doing DNS
-lookups in forward transparent proxy mode. The option is only
-effective if the following three conditions are true -
-
-* Traffic Server is in forward proxy mode.
-* The proxy port is inbound transparent.
-* The target URL has not been modified by either remapping or a plugin.
-
-If any of these conditions are not true, then normal DNS processing
-is done for the connection.
-
-If all of these conditions are met, then the origin server IP
-address is retrieved from the original client connection, rather
-than through HostDB or DNS lookup. In effect, client DNS resolution
-is used instead of Traffic Server DNS.
-
-This can be used to be a little more efficient (looking up the
-target once by the client rather than by both the client and Traffic
-Server) but the primary use is when client DNS resolution can differ
-from that of Traffic Server. Two known uses cases are:
-
-#. Embedded IP addresses in a protocol with DNS load sharing. In
- this case, even though Traffic Server and the client both make
- the same request to the same DNS resolver chain, they may get
- different origin server addresses. If the address is embedded in
- the protocol then the overall exchange will fail. One current
- example is Microsoft Windows update, which presumably embeds the
- address as a security measure.
-
-#. The client has access to local DNS zone information which is not
- available to Traffic Server. There are corporate nets with local
- DNS information for internal servers which, by design, is not
- propagated outside the core corporate network. Depending a
- network topology it can be the case that Traffic Server can
- access the servers by IP address but cannot resolve such
- addresses by name. In such as case the client supplied target
- address must be used.
-
-This solution must be considered interim. In the longer term, it
-should be possible to arrange for much finer grained control of DNS
-lookup so that wildcard domain can be set to use Traffic Server or
-client resolution. In both known use cases, marking specific domains
-as client determined (rather than a single global switch) would
-suffice. It is possible to do this crudely with this flag by
-enabling it and then use identity URL mappings to re-disable it for
-specific domains.
-
-Parent Proxy Configuration
-==========================
-
-.. ts:confvar:: CONFIG proxy.config.http.parent_proxy_routing_enable INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) the parent caching option. Refer to Hierarchical Caching <../hierachical-caching>_.
-
-.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.retry_time INT 300
- :reloadable:
-
- The amount of time allowed between connection retries to a parent cache that is unavailable.
-
-.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.fail_threshold INT 10
- :reloadable:
-
- The number of times the connection to the parent cache can fail before Traffic Server considers the parent unavailable.
-
-.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.total_connect_attempts INT 4
- :reloadable:
-
- The total number of connection attempts allowed to a parent cache before Traffic Server bypasses the parent or fails the request
- (depending on the ``go_direct`` option in the :file:`bypass.config` file).
-
-.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.per_parent_connect_attempts INT 2
- :reloadable:
-
- The total number of connection attempts allowed per parent, if multiple parents are used.
-
-.. ts:confvar:: CONFIG proxy.config.http.parent_proxy.connect_attempts_timeout INT 30
- :reloadable:
-
- The timeout value (in seconds) for parent cache connection attempts.
-
-.. ts:confvar:: CONFIG proxy.config.http.forward.proxy_auth_to_parent INT 0
- :reloadable:
-
- Configures Traffic Server to send proxy authentication headers on to the parent cache.
-
-HTTP Connection Timeouts
-========================
-
-.. ts:confvar:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_in INT 10
- :reloadable:
-
- Specifies how long Traffic Server keeps connections to clients open for a subsequent request after a transaction ends.
-
-.. ts:confvar:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_out INT 10
- :reloadable:
-
- Specifies how long Traffic Server keeps connections to origin servers open for a subsequent transfer of data after a transaction ends.
-
-.. ts:confvar:: CONFIG proxy.config.http.transaction_no_activity_timeout_in INT 120
- :reloadable:
-
- Specifies how long Traffic Server keeps connections to clients open if a transaction stalls.
-
-.. ts:confvar:: CONFIG proxy.config.http.transaction_no_activity_timeout_out INT 120
- :reloadable:
-
- Specifies how long Traffic Server keeps connections to origin servers open if the transaction stalls.
-
-.. ts:confvar:: CONFIG proxy.config.http.transaction_active_timeout_in INT 0
- :reloadable:
-
- The maximum amount of time Traffic Server can remain connected to a client. If the transfer to the client is not complete before this
- timeout expires, then Traffic Server closes the connection.
-
-The default value of ``0`` specifies that there is no timeout.
-
-.. ts:confvar:: CONFIG proxy.config.http.transaction_active_timeout_out INT 0
- :reloadable:
-
- The maximum amount of time Traffic Server waits for fulfillment of a connection request to an origin server. If Traffic Server does not
- complete the transfer to the origin server before this timeout expires, then Traffic Server terminates the connection request.
-
-The default value of ``0`` specifies that there is no timeout.
-
-.. ts:confvar:: CONFIG proxy.config.http.accept_no_activity_timeout INT 120
- :reloadable:
-
- The timeout interval in seconds before Traffic Server closes a connection that has no activity.
-
-.. ts:confvar:: CONFIG proxy.config.http.background_fill_active_timeout INT 60
- :reloadable:
-
- Specifies how long Traffic Server continues a background fill before giving up and dropping the origin server connection.
-
-.. ts:confvar:: CONFIG proxy.config.http.background_fill_completed_threshold FLOAT 0.50000
- :reloadable:
-
- The proportion of total document size already transferred when a client aborts at which the proxy continues fetching the document
- from the origin server to get it into the cache (a **background fill**).
-
-Origin Server Connect Attempts
-==============================
-
-.. ts:confvar:: CONFIG proxy.config.http.connect_attempts_max_retries INT 6
- :reloadable:
-
- The maximum number of connection retries Traffic Server can make when the origin server is not responding.
-
-.. ts:confvar:: CONFIG proxy.config.http.connect_attempts_max_retries_dead_server INT 2
- :reloadable:
-
- The maximum number of connection retries Traffic Server can make when the origin server is unavailable.
-
-.. ts:confvar:: CONFIG proxy.config.http.server_max_connections INT 0
- :reloadable:
-
- Limits the number of socket connections across all origin servers to the value specified. To disable, set to zero (``0``).
-
-.. ts:confvar:: CONFIG proxy.config.http.origin_max_connections INT 0
- :reloadable:
-
- Limits the number of socket connections per origin server to the value specified. To enable, set to one (``1``).
-
-.. ts:confvar:: CONFIG proxy.config.http.origin_min_keep_alive_connections INT 0
- :reloadable:
-
- As connection to an origin server are opened, keep at least 'n' number of connections open to that origin, even if the connection
- isn't used for a long time period. Useful when the origin supports keep-alive, removing the time needed to set up a new connection from
- the next request at the expense of added (inactive) connections. To enable, set to one (``1``).
-
-.. ts:confvar:: CONFIG proxy.config.http.connect_attempts_rr_retries INT 2
- :reloadable:
-
- The maximum number of failed connection attempts allowed before a round-robin entry is marked as 'down' if a server has round-robin DNS entries.
-
-.. ts:confvar:: CONFIG proxy.config.http.connect_attempts_timeout INT 30
- :reloadable:
-
- The timeout value (in seconds) for an origin server connection.
-
-.. ts:confvar:: CONFIG proxy.config.http.post_connect_attempts_timeout INT 1800
- :reloadable:
-
- The timeout value (in seconds) for an origin server connection when the client request is a ``POST`` or ``PUT`` request.
-
-.. ts:confvar:: CONFIG proxy.config.http.down_server.cache_time INT 900
- :reloadable:
-
- Specifies how long (in seconds) Traffic Server remembers that an origin server was unreachable.
-
-.. ts:confvar:: CONFIG proxy.config.http.down_server.abort_threshold INT 10
- :reloadable:
-
- The number of seconds before Traffic Server marks an origin server as unavailable after a client abandons a request because the origin
- server was too slow in sending the response header.
-
-Congestion Control
-==================
-
-.. ts:confvar:: CONFIG proxy.config.http.congestion_control.enabled INT 0
-
- Enables (``1``) or disables (``0``) the Congestion Control option, which configures Traffic Server to stop forwarding HTTP requests to
- origin servers when they become congested. Traffic Server sends the client a message to retry the congested origin server later. Refer
- to `Using Congestion Control <../http-proxy-caching#UsingCongestionControl>`_.
-
-Negative Response Caching
-=========================
-
-.. ts:confvar:: CONFIG proxy.config.http.negative_caching_enabled INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server caches negative responses (such as ``404 Not Found``) when a requested page does not exist. The next
- time a client requests the same page, Traffic Server serves the negative response directly from cache.
-
- **Note**: ``Cache-Control`` directives from the server forbidding ache are ignored for the following HTTP response codes, regardless
- of the value specified for the `proxy.config.http.negative_caching_enabled`_ variable. The
- following negative responses are cached by Traffic Server:::
-
- 204 No Content
- 305 Use Proxy
- 400 Bad Request
- 403 Forbidden
- 404 Not Found
- 405 Method Not Allowed
- 500 Internal Server Error
- 501 Not Implemented
- 502 Bad Gateway
- 503 Service Unavailable
- 504 Gateway Timeout
-
-Proxy User Variables
-====================
-
-.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_from INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server removes the ``From`` header to protect the privacy of your users.
-
-.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_referer INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server removes the ``Referrer`` header to protect the privacy of your site and users.
-
-.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_user_agent INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server removes the ``User-agent`` header to protect the privacy of your site and users.
-
-.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_cookie INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server removes the ``Cookie`` header to protect the privacy of your site and users.
-
-.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_client_ip INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server removes ``Client-IP`` headers for more privacy.
-
-.. ts:confvar:: CONFIG proxy.config.http.anonymize_insert_client_ip INT 1
- :reloadable:
-
- When enabled (``1``), Traffic Server inserts ``Client-IP`` headers to retain the client IP address.
-
-.. ts:confvar:: CONFIG proxy.config.http.append_xforwards_header INT 0
-
- When enabled (``1``), Traffic Server appends ``X-Forwards`` headers to outgoing requests.
-
-.. ts:confvar:: CONFIG proxy.config.http.anonymize_other_header_list STRING NULL
- :reloadable:
-
- The headers Traffic Server should remove from outgoing requests.
-
-.. ts:confvar:: CONFIG proxy.config.http.insert_squid_x_forwarded_for INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server adds the client IP address to the ``X-Forwarded-For`` header.
-
-.. ts:confvar:: CONFIG proxy.config.http.normalize_ae_gzip INT 0
- :reloadable:
-
- Enable (``1``) to normalize all ``Accept-Encoding:`` headers to one of the following:
-
- - ``Accept-Encoding: gzip`` (if the header has ``gzip`` or ``x-gzip`` with any ``q``) **OR**
- - *blank* (for any header that does not include ``gzip``)
-
- This is useful for minimizing cached alternates of documents (e.g. ``gzip, deflate`` vs. ``deflate, gzip``). Enabling this option is
- recommended if your origin servers use no encodings other than ``gzip``.
-
-Security
-========
-
-.. ts:confvar:: CONFIG proxy.config.http.push_method_enabled INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) the HTTP ``PUSH`` option, which allows you to deliver content directly to the cache without a user
- request.
-
- **Important:** If you enable this option, then you must also specify
- a filtering rule in the ip_allow.config file to allow only certain
- machines to push content into the cache.
-
-Cache Control
-=============
-
-.. ts:confvar:: CONFIG proxy.config.cache.enable_read_while_writer INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) ability to a read cached object while the another connection is completing the write to cache for
- the same object.
-
-.. ts:confvar:: CONFIG proxy.config.cache.force_sector_size INT 512
- :reloadable:
-
- Forces the use of a specific hardware sector size (512 - 8192 bytes).
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.http INT 1
- :reloadable:
-
- Enables (``1``) or disables (``0``) caching of HTTP requests.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_client_no_cache INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server ignores client requests to bypass the cache.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.ims_on_client_no_cache INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server issues a conditional request to the origin server if an incoming request has a ``No-Cache`` header.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_server_no_cache INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server ignores origin server requests to bypass the cache.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.cache_responses_to_cookies INT 3
- :reloadable:
-
- Specifies how cookies are cached:
-
- - ``0`` = do not cache any responses to cookies
- - ``1`` = cache for any content-type
- - ``2`` = cache only for image types
- - ``3`` = cache for all but text content-types
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_authentication INT 0
-
- When enabled (``1``), Traffic Server ignores ``WWW-Authentication`` headers in responses ``WWW-Authentication`` headers are removed and
- not cached.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.cache_urls_that_look_dynamic INT 1
- :reloadable:
-
- Enables (``1``) or disables (``0``) caching of URLs that look dynamic, i.e.: URLs that end in *``.asp``* or contain a question
- mark (*``?``*), a semicolon (*``;``*), or *``cgi``*. For a full list, please refer to
- `HttpTransact::url_looks_dynamic </link/to/doxygen>`_
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.enable_default_vary_headers INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) caching of alternate versions of HTTP objects that do not contain the ``Vary`` header.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.when_to_revalidate INT 0
- :reloadable:
-
- Specifies when to revalidate content:
-
- - ``0`` = use cache directives or heuristic (the default value)
- - ``1`` = stale if heuristic
- - ``2`` = always stale (always revalidate)
- - ``3`` = never stale
- - ``4`` = use cache directives or heuristic (0) unless the request
- has an ``If-Modified-Since`` header
-
- If the request contains the ``If-Modified-Since`` header, then
- Traffic Server always revalidates the cached content and uses the
- client's ``If-Modified-Since`` header for the proxy request.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.when_to_add_no_cache_to_msie_requests INT 0
- :reloadable:
-
- Specifies when to add ``no-cache`` directives to Microsoft Internet Explorer requests. You can specify the following:
-
- - ``0`` = ``no-cache`` is *not* added to MSIE requests
- - ``1`` = ``no-cache`` is added to IMS MSIE requests
- - ``2`` = ``no-cache`` is added to all MSIE requests
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.required_headers INT 0
- :reloadable:
-
- The type of headers required in a request for the request to be cacheable.
-
- - ``0`` = no headers required to make document cacheable
- - ``1`` = either the ``Last-Modified`` header, or an explicit lifetime header, ``Expires`` or ``Cache-Control: max-age``, is required
- - ``2`` = explicit lifetime is required, ``Expires`` or ``Cache-Control: max-age``
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.max_stale_age INT 604800
- :reloadable:
-
- The maximum age allowed for a stale response before it cannot be cached.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.range.lookup INT 1
-
- When enabled (``1``), Traffic Server looks up range requests in the cache.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.enable_read_while_writer INT 0
-
- Enables (``1``) or disables (``0``) the ability to read a cached object while another connection is completing a write to cache
- for the same object.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.fuzz.min_time INT 0
- :reloadable:
-
- Sets a minimum fuzz time; the default value is ``0``. **Effective fuzz time** is a calculation in the range
- (``fuzz.min_time`` - ``fuzz.min_time``).
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_accept_mismatch INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server serves documents from cache with a ``Content-Type:`` header that does not match the ``Accept:``
- header of the request.
-
- **Note:** This option should only be enabled if you're having
- problems with caching *and* one of the following is true:
-
- - Your origin server sets ``Vary: Accept`` when doing content negotiation with ``Accept`` *OR*
- - The server does not send a ``406 (Not Acceptable)`` response for types that it cannot serve.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_accept_language_mismatch INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server serves documents from cache with a ``Content-Language:`` header that does not match the
- ``Accept-Language:`` header of the request.
-
- **Note:** This option should only be enabled if you're having
- problems with caching and your origin server is guaranteed to set
- ``Vary: Accept-Language`` when doing content negotiation with
- ``Accept-Language``.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_accept_charset_mismatch INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server serves documents from cache with a ``Content-Type:`` header that does not match the
- ``Accept-Charset:`` header of the request.
-
- **Note:** This option should only be enabled if you're having
- problems with caching and your origin server is guaranteed to set
- ``Vary: Accept-Charset`` when doing content negotiation with
- ``Accept-Charset``.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_client_cc_max_age INT 1
- :reloadable:
-
- When enabled (``1``), Traffic Server ignores any ``Cache-Control: max-age`` headers from the client.
-
-.. ts:confvar:: CONFIG proxy.config.cache.permit.pinning INT 0
- :reloadable:
-
- When enabled (``1``), Traffic Server will keep certain HTTP objects in the cache for a certain time as specified in cache.config.
-
-Heuristic Expiration
-====================
-
-.. ts::confvar:: proxy.config.http.cache.heuristic_min_lifetime INT 3600
- :reloadable:
-
- The minimum amount of time an HTTP object without an expiration date can remain fresh in the cache before is considered to be stale.
-
-.. ts::confvar:: proxy.config.http.cache.heuristic_max_lifetime INT 86400
- :reloadable:
-
- The maximum amount of time an HTTP object without an expiration date can remain fresh in the cache before is considered to be stale.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.heuristic_lm_factor FLOAT 0.10000
- :reloadable:
-
- The aging factor for freshness computations. Traffic Server stores an object for this percentage of the time that elapsed since it last
- changed.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.fuzz.time INT 240
- :reloadable:
-
- How often Traffic Server checks for an early refresh, during the period before the document stale time. The interval specified must
- be in seconds.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.fuzz.probability FLOAT 0.00500
- :reloadable:
-
- The probability that a refresh is made on a document during the specified fuzz time.
-
-Dynamic Content & Content Negotiation
-=====================================
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.vary_default_text STRING NULL
- :reloadable:
-
- The header on which Traffic Server varies for text documents.
-
-For example: if you specify ``User-agent``, then Traffic Server caches
-all the different user-agent versions of documents it encounters.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.vary_default_images STRING NULL
- :reloadable:
-
- The header on which Traffic Server varies for images.
-
-.. ts:confvar:: CONFIG proxy.config.http.cache.vary_default_other STRING NULL
- :reloadable:
-
- The header on which Traffic Server varies for anything other than text and images.
-
-Customizable User Response Pages
-================================
-
-.. ts:confvar:: CONFIG proxy.config.body_factory.enable_customizations INT 0
- Specifies whether customizable response pages are enabled or
- disabled and which response pages are used:
-
- - ``0`` = disable customizable user response pages
- - ``1`` = enable customizable user response pages in the default directory only
- - ``2`` = enable language-targeted user response pages
-
-.. ts:confvar:: CONFIG proxy.config.body_factory.enable_logging INT 1
-
- Enables (``1``) or disables (``0``) logging for customizable response pages. When enabled, Traffic Server records a message in
- the error log each time a customized response page is used or modified.
-
-.. ts:confvar:: CONFIG proxy.config.body_factory.template_sets_dir STRING config/body_factory
-
- The customizable response page default directory.
-
-.. ts:confvar:: CONFIG proxy.config.body_factory.response_suppression_mode INT 0
-
- Specifies when Traffic Server suppresses generated response pages:
-
- - ``0`` = never suppress generated response pages
- - ``1`` = always suppress generated response pages
- - ``2`` = suppress response pages only for intercepted traffic
-
-DNS
-===
-
-.. ts:confvar:: CONFIG proxy.config.dns.search_default_domains INT 1
- :Reloadable:
-
- Enables (``1``) or disables (``0``) local domain expansion.
-
-Traffic Server can attempt to resolve unqualified hostnames by
-expanding to the local domain. For example if a client makes a
-request to an unqualified host (``host_x``) and the Traffic Server
-local domain is ``y.com`` , then Traffic Server will expand the
-hostname to ``host_x.y.com``.
-
-.. ts:confvar:: CONFIG proxy.config.dns.splitDNS.enabled INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) DNS server selection. When enabled, Traffic Server refers to the :file:`splitdns.config` file for
- the selection specification. Refer to `Configuring DNS Server Selection (Split DNS) <../security-options#ConfiguringDNSServerSelectionSplit>`_.
-
-.. ts:confvar:: CONFIG proxy.config.dns.url_expansions STRING NULL
-
- Specifies a list of hostname extensions that are automatically added to the hostname after a failed lookup. For example: if you want
- Traffic Server to add the hostname extension .org, then specify ``org`` as the value for this variable (Traffic Server automatically
- adds the dot (.)).
-
- **Note:** If the variable
- `proxy.config.http.enable_url_expandomatic`_ is set to ``1`` (the default value), then you do not have to add *``www.``* and
- *``.com``* to this list because Traffic Server automatically tries www. and .com after trying the values you've specified.
-
-.. ts:confvar:: CONFIG proxy.config.dns.resolv_conf STRING /etc/resolv.conf
-
- Allows to specify which ``resolv.conf`` file to use for finding resolvers. While the format of this file must be the same as the
- standard ``resolv.conf`` file, this option allows an administrator to manage the set of resolvers in an external configuration file,
- without affecting how the rest of the operating system uses DNS.
-
-.. ts:confvar:: CONFIG proxy.config.dns.round_robin_nameservers INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) DNS server round-robin.
-
-.. ts:confvar:: CONFIG proxy.config.dns.nameservers STRING NULL
- :reloadable:
-
- The DNS servers.
-
-.. ts:confvar:: CONFIG proxy.config.srv_enabled INT 0
- :reloadable:
-
- Indicates whether to use SRV records for orgin server lookup.
-
-HostDB
-======
-
-.. ts:confvar:: CONFIG proxy.config.hostdb.serve_stale_for INT
-
- The number of seconds for which to use a stale NS record while initiating a background fetch for the new data.
-
-.. ts:confvar:: CONFIG proxy.config.hostdb.storage_size INT 33554432
-
- The amount of space (in bytes) used to store ``hostdb``.
- The value of this variable must be increased if you increase the size of the
- `proxy.config.hostdb.size`_ variable.
-
-.. ts:confvar:: CONFIG proxy.config.hostdb.size INT 200000
-
- The maximum number of entries that can be stored in the database.
-
-.. note::
-
- For values above ``200000``, you must increase the value of the `proxy.config.hostdb.storage_size`_ variable by at least 44 bytes per entry.
-
-.. ts:confvar:: CONFIG proxy.config.hostdb.ttl_mode INT 0
- :reloadable:
-
- The host database time to live mode. You can specify one of the
- following:
-
- - ``0`` = obey
- - ``1`` = ignore
- - ``2`` = min(X,ttl)
- - ``3`` = max(X,ttl)
-
-.. ts:confvar:: CONFIG proxy.config.hostdb.timeout INT 1440
- :reloadable:
-
- The foreground timeout (in minutes).
-
-.. ts:confvar:: CONFIG proxy.config.hostdb.strict_round_robin INT 0
- :reloadable:
-
- When disabled (``0``), Traffic Server always uses the same origin
- server for the same client, for as long as the origin server is
- available.
-
-Logging Configuration
-=====================
-
-.. ts:confvar:: CONFIG proxy.config.log.logging_enabled INT 3
- :reloadable:
-
- Enables and disables event logging:
-
- - ``0`` = logging disabled
- - ``1`` = log errors only
- - ``2`` = log transactions only
- - ``3`` = full logging (errors + transactions)
-
- Refer to `Working with Log Files <../working-log-files>`_.
-
-.. ts:confvar:: CONFIG proxy.config.log.max_secs_per_buffer INT 5
- :reloadable:
-
- The maximum amount of time before data in the buffer is flushed to disk.
-
-.. ts:confvar:: CONFIG proxy.config.log.max_space_mb_for_logs INT 2000
- :reloadable:
-
- The amount of space allocated to the logging directory (in MB).
- **Note:** All files in the logging directory contribute to the space used, even if they are not log files. In collation client mode, if
- there is no local disk logging, or max_space_mb_for_orphan_logs is set to a higher value than max_space_mb_for_logs, TS will
- take proxy.config.log.max_space_mb_for_orphan_logs for maximum allowed log space.
-
-.. ts:confvar:: CONFIG proxy.config.log.max_space_mb_for_orphan_logs INT 25
- :reloadable:
-
- The amount of space allocated to the logging directory (in MB) if this node is acting as a collation client.
-
- **Note:** When max_space_mb_for_orphan_logs is take as the maximum allowedlog space in the logging system, the same rule apply to
- proxy.config.log.max_space_mb_for_logs also apply to proxy.config.log.max_space_mb_for_orphan_logs, ie: All files in
- the logging directory contribute to the space used, even if they are not log files. you may need to consider this when you enable full
- remote logging, and bump to the same size as proxy.config.log.max_space_mb_for_logs.
-
-.. ts:confvar:: CONFIG proxy.config.log.max_space_mb_headroom INT 10
- :reloadable:
-
- The tolerance for the log space limit (in bytes). If the variable `proxy.config.log.auto_delete_rolled_files`_ is set to ``1``
- (enabled), then autodeletion of log files is triggered when the amount of free space available in the logging directory is less than
- the value specified here.
-
-.. ts:confvar:: CONFIG proxy.config.log.hostname STRING localhost
- :reloadable:
-
- The hostname of the machine running Traffic Server.
-
-.. ts:confvar:: CONFIG proxy.config.log.logfile_dir STRING install_dir\ ``/logs``
- :reloadable:
-
- The full path to the logging directory. This can be an absolute path or a path relative to the directory in which Traffic Server is installed.
-
- **Note:** The directory you specify must already exist.
-
-.. ts:confvar:: CONFIG proxy.config.log.logfile_perm STRING rw-r--r--
- :reloadable:
-
- The log file permissions. The standard UNIX file permissions are used (owner, group, other). Permissible values are:
-
- ``-`` no permission ``r`` read permission ``w`` write permission ``x`` execute permission
-
- Permissions are subject to the umask settings for the Traffic Server process. This means that a umask setting of\ ``002`` will not allow
- write permission for others, even if specified in the configuration file. Permissions for existing log files are not changed when the
- configuration is changed.
-
-.. ts:confvar:: CONFIG proxy.config.log.custom_logs_enabled INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) custom logging.
-
-.. ts:confvar:: CONFIG proxy.config.log.squid_log_enabled INT 1
- :reloadable:
-
- Enables (``1``) or disables (``0``) the `squid log file format <../working-log-files/log-formats#SquidFormat>`_.
-
-.. ts:confvar:: CONFIG proxy.config.log.squid_log_is_ascii INT 1
- :reloadable:
-
- The squid log file type:
-
- - ``1`` = ASCII
- - ``0`` = binary
-
-.. ts:confvar:: CONFIG proxy.config.log.squid_log_name STRING squid
- :reloadable:
-
- The `squid log <../working-log-files/log-formats#SquidFormat>`_ filename.
-
-.. ts:confvar:: CONFIG proxy.config.log.squid_log_header STRING NULL
-
- The `squid log <../working-log-files/log-formats#SquidFormat>`_ file header text.
-
-.. ts:confvar:: CONFIG proxy.config.log.common_log_enabled INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) the `Netscape common log file format <../working-log-files/log-formats#NetscapeFormats>`_.
-
-.. ts:confvar:: CONFIG proxy.config.log.common_log_is_ascii INT 1
- :reloadable:
-
- The `Netscape common log <../working-log-files/log-formats#NetscapeFormats>`_ file type:
-
- - ``1`` = ASCII
- - ``0`` = binary
-
-.. ts:confvar:: CONFIG proxy.config.log.common_log_name STRING common
- :reloadable:
-
- The `Netscape common log <../working-log-files/log-formats#NetscapeFormats>`_ filename.
-
-.. ts:confvar:: CONFIG proxy.config.log.common_log_header STRING NULL
- :reloadable:
-
- The `Netscape common log <../working-log-files/log-formats#NetscapeFormats>`_ file header text.
-
-.. ts:confvar:: CONFIG proxy.config.log.extended_log_enabled INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) the `Netscape extended log file format <../working-log-files/log-formats#NetscapeFormats>`_.
-
-.. ts:confvar:: CONFIG proxy.confg.log.extended_log_is_ascii INT 1
-
- The `Netscape extended log <../working-log-files/log-formats#NetscapeFormats>`_ file type:
-
- - ``1`` = ASCII
- - ``0`` = binary
-
-.. ts:confvar:: CONFIG proxy.config.log.extended_log_name STRING extended
-
- The `Netscape extended log <../working-log-files/log-formats#NetscapeFormats>`_ filename.
-
-.. ts:confvar:: CONFIG proxy.config.log.extended_log_header STRING NULL
- :reloadable:
-
- The `Netscape extended log <../working-log-files/log-formats#NetscapeFormats>`_ file header text.
-
-.. ts:confvar:: CONFIG proxy.config.log.extended2_log_enabled INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) the `Netscape Extended-2 log file format <../working-log-files/log-formats#NetscapeFormats>`_.
-
-.. ts:confvar:: CONFIG proxy.config.log.extended2_log_is_ascii INT 1
- :reloadable:
-
- The `Netscape Extended-2 log <../working-log-files/log-formats#NetscapeFormats>`_ file type:
-
- - ``1`` = ASCII
- - ``0`` = binary
-
-.. ts:confvar:: CONFIG proxy.config.log.extended2_log_name STRING extended2
- :reloadable:
-
- The `Netscape Extended-2 log <../working-log-files/log-formats#NetscapeFormats>`_ filename.
-
-.. ts:confvar:: CONFIG proxy.config.log.extended2_log_header STRING NULL
- :reloadable:
-
- The `Netscape Extended-2 log <../working-log-files/log-formats#NetscapeFormats>`_ file header text.
-
-.. ts:confvar:: CONFIG proxy.config.log.separate_icp_logs INT 0
- :reloadable:
-
- When enabled (``1``), configures Traffic Server to store ICP transactions in a separate log file.
-
- - ``0`` = separation is disabled, all ICP transactions are recorded in the same file as HTTP transactions
- - ``1`` = all ICP transactions are recorded in a separate log file.
- - ``-1`` = filter all ICP transactions from the default log files; ICP transactions are not logged anywhere.
-
-.. ts:confvar:: CONFIG proxy.config.log.separate_host_logs INT 0
- :reloadable:
-
- When enabled (``1``), configures Traffic Server to create a separate log file for HTTP transactions for each origin server listed in the
- :file:`log_hosts.config` file. Refer to `HTTP Host Log Splitting <../working-log-files#HTTPHostLogSplitting>`_.
-
-.. ts:confvar:: LOCAL proxy.local.log.collation_mode INT 0
- :reloadable:
-
- Set the log collation mode.
-
-===== ======
-Value Effect
-===== ======
-0 collation is disabled
-1 this host is a log collation server
-2 this host is a collation client and sends entries using standard formats to the collation server
-3 this host is a collation client and sends entries using the traditional custom formats to the collation server
-4 this host is a collation client and sends entries that use both the standard and traditional custom formats to the collation server
-===== ======
-
-For information on sending XML-based custom formats to the collation
-server, refer to `logs_xml.config <logs_xml.config>`_.
-
-.. note:: Although Traffic Server supports traditional custom logging, you should use the more versatile XML-based custom formats.
-
-.. ts:confvar:: proxy.confg.log.collation_host STRING NULL
-
- The hostname of the log collation server.
-
-.. ts:confvar:: CONFIG proxy.config.log.collation_port INT 8085
- :reloadable:
-
- The port used for communication between the collation server and client.
-
-.. ts:confvar:: CONFIG proxy.config.log.collation_secret STRING foobar
- :reloadable:
-
- The password used to validate logging data and prevent the exchange of unauthorized information when a collation server is being used.
-
-.. ts:confvar:: CONFIG proxy.config.log.collation_host_tagged INT 0
- :reloadable:
-
- When enabled (``1``), configures Traffic Server to include the hostname of the collation client that generated the log entry in each entry.
-
-.. ts:confvar:: CONFIG proxy.config.log.collation_retry_sec INT 5
- :reloadable:
-
- The number of seconds between collation server connection retries.
-
-.. ts:confvar:: CONFIG proxy.config.log.rolling_enabled INT 1
- :reloadable:
-
- Specifies how log files are rolled. You can specify the following values:
-
- - ``0`` = disables log file rolling
- - ``1`` = enables log file rolling at specific intervals during the day (specified with the
- `proxy.config.log.rolling_interval_sec`_ and `proxy.config.log.rolling_offset_hr`_ variables)
- - ``2`` = enables log file rolling when log files reach a specific size (specified with the `proxy.config.log.rolling_size_mb`_ variable)
- - ``3`` = enables log file rolling at specific intervals during the day or when log files reach a specific size (whichever occurs first)
- - ``4`` = enables log file rolling at specific intervals during the day when log files reach a specific size (i.e., at a specified
- time if the file is of the specified size)
-
-.. ts:confvar:: CONFIG proxy.config.log.rolling_interval_sec INT 86400
- :reloadable:
-
- The log file rolling interval, in seconds. The minimum value is ``300`` (5 minutes). The maximum, and default, value is 86400 seconds (one day).
-
- **Note:** If you start Traffic Server within a few minutes of the next rolling time, then rolling might not occur until the next rolling time.
-
-.. ts:confvar:: CONFIG proxy.config.log.rolling_offset_hr INT 0
- :reloadable:
-
- The file rolling offset hour. The hour of the day that starts the log rolling period.
-
-.. ts:confvar:: CONFIG proxy.config.log.rolling_size_mb INT 10
- :reloadable:
-
- The size that log files must reach before rolling takes place.
-
-.. ts:confvar:: CONFIG proxy.config.log.auto_delete_rolled_files INT 1
- :reloadable:
-
- Enables (``1``) or disables (``0``) automatic deletion of rolled files.
-
-.. ts:confvar:: CONFIG proxy.config.log.sampling_frequency INT 1
- :reloadable:
-
- Configures Traffic Server to log only a sample of transactions rather than every transaction. You can specify the following values:
-
- - ``1`` = log every transaction
- - ``2`` = log every second transaction
- - ``3`` = log every third transaction and so on...
-
-.. ts:confvar:: CONFIG proxy.config.http.slow.log.threshold INT 0
- :reloadable:
-
- The number of milliseconds before a slow connection's debugging stats are dumped. Specify ``1`` to enable or ``0`` to disable.
-
-Diagnostic Logging Configuration
-================================
-
-.. ts:confvar:: CONFIG proxy.config.diags.output.status STRING
-.. ts:confvar:: CONFIG proxy.config.diags.output.warning STRING
-.. ts:confvar:: CONFIG proxy.config.diags.output.emergency STRING
-
- control where Traffic Server should log diagnostic output. Messages at diagnostic level can be directed to any combination of diagnostic
- destinations. Valid diagnostic message destinations are:::
-
- * 'O' = Log to standard output
- * 'E' = Log to standard error
- * 'S' = Log to syslog
- * 'L' = Log to diags.log
-
-.. topic:: Example
-
- To log debug diagnostics to both syslog and diags.log:::
-
- proxy.config.diags.output.debug STRING SL
-
-Reverse Proxy
-=============
-
-.. ts:confvar:: CONFIG proxy.config.reverse_proxy.enabled INT 1
- :reloadable:
-
- Enables (``1``) or disables (``0``) HTTP reverse proxy.
-
-.. ts:confvar:: CONFIG proxy.config.header.parse.no_host_url_redirect STRING NULL
- :reloadable:
-
- The URL to which to redirect requests with no host headers (reverse
- proxy).
-
-URL Remap Rules
-===============
-
-.. ts:confvar:: CONFIG proxy.config.url_remap.default_to_server_pac INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) requests for a PAC file on the proxy service port (8080 by default) to be redirected to the PAC
- port. For this type of redirection to work, the variable `proxy.config.reverse_proxy.enabled`_ must be set to ``1``.
-
-.. ts:confvar:: CONFIG proxy.config.url_remap.default_to_server_pac_port INT -1
- :reloadable:
-
- Sets the PAC port so that PAC requests made to the Traffic Server
- proxy service port are redirected this port. ``-1`` is the default
- setting that sets the PAC port to the autoconfiguration port (the
- default autoconfiguration port is 8083). This variable can be used
- together with the `proxy.config.url_remap.default_to_server_pac`_
- variable to get a PAC file from a different port. You must create
- and run a process that serves a PAC file on this port. For example:
- if you create a Perl script that listens on port 9000 and writes a
- PAC file in response to any request, then you can set this variable
- to ``9000``. Browsers that request the PAC file from a proxy server
- on port 8080 will get the PAC file served by the Perl script.
-
-.. ts:confvar:: CONFIG proxy.config.url_remap.remap_required INT 1
- :reloadable:
-
- Set this variable to ``1`` if you want Traffic Server to serve
- requests only from origin servers listed in the mapping rules of the
- :file:`remap.config` file. If a request does not match, then the browser
- will receive an error.
-
-.. ts:confvar:: CONFIG proxy.config.url_remap.pristine_host_hdr INT 1
- :reloadable:
-
- Set this variable to ``1`` if you want to retain the client host
- header in a request during remapping.
-
-SSL Termination
-===============
-
-.. ts:confvar:: CONFIG proxy.config.ssl.SSLv2 INT 0
-
- Enables (``1``) or disables (``0``) SSLv2. Please don't enable it.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.SSLv3 INT 1
-
- Enables (``1``) or disables (``0``) SSLv3.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.TLSv1 INT 1
-
- Enables (``1``) or disables (``0``) TLSv1.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.client.certification_level INT 0
-
- Sets the client certification level:
-
- - ``0`` = no client certificates are required. Traffic Server does
- not verify client certificates during the SSL handshake. Access
- to Traffic Server depends on Traffic Server configuration options
- (such as access control lists).
-
- - ``1`` = client certificates are optional. If a client has a
- certificate, then the certificate is validated. If the client
- does not have a certificate, then the client is still allowed
- access to Traffic Server unless access is denied through other
- Traffic Server configuration options.
-
- - ``2`` = client certificates are required. The client must be
- authenticated during the SSL handshake. Clients without a
- certificate are not allowed to access Traffic Server.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.server.cert.path STRING /config
-
- The location of the SSL certificates and chains used for accepting
- and validation new SSL sessions. If this is a relative path,
- it is appended to the Traffic Server installation PREFIX. All
- certificates and certificate chains listed in
- :file:`ssl_multicert.config` will be loaded relative to this path.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.server.private_key.path STRING NULL
-
- The location of the SSL certificate private keys. Change this
- variable only if the private key is not located in the SSL
- certificate file. All private keys listed in
- :file:`ssl_multicert.config` will be loaded relative to this
- path.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.server.cert_chain.filename STRING NULL
-
- The name of a file containing a global certificate chain that
- should be used with every server certificate. This file is only
- used if there are certificates defined in :file:`ssl_multicert.conf`.
- Unless this is an absolute path, it is loaded relative to the
- path specified by `proxy.config.ssl.server.cert.path`_.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.CA.cert.path STRING NULL
-
- The location of the certificate authority file that client
- certificates will be verified against.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.CA.cert.filename STRING NULL
-
- The filename of the certificate authority that client certificates
- will be verified against.
-
-Client-Related Configuration
-----------------------------
-
-.. ts:confvar:: CONFIG proxy.config.ssl.client.verify.server INT 0
-
- Configures Traffic Server to verify the origin server certificate
- with the Certificate Authority (CA).
-
-.. ts:confvar:: CONFIG proxy.config.ssl.client.cert.filename STRING NULL
-
- The filename of SSL client certificate installed on Traffic Server.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.client.cert.path STRING /config
-
- The location of the SSL client certificate installed on Traffic
- Server.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.client.private_key.filename STRING NULL
-
- The filename of the Traffic Server private key. Change this variable
- only if the private key is not located in the Traffic Server SSL
- client certificate file.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.client.private_key.path STRING NULL
-
- The location of the Traffic Server private key. Change this variable
- only if the private key is not located in the SSL client certificate
- file.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.client.CA.cert.filename STRING NULL
-
- The filename of the certificate authority against which the origin
- server will be verified.
-
-.. ts:confvar:: CONFIG proxy.config.ssl.client.CA.cert.path STRING NULL
-
- Specifies the location of the certificate authority file against
- which the origin server will be verified.
-
-ICP Configuration
-=================
-
-.. ts:confvar:: CONFIG proxy.config.icp.enabled INT 0
-
- Sets ICP mode for hierarchical caching:
-
- - ``0`` = disables ICP
- - ``1`` = allows Traffic Server to receive ICP queries only
- - ``2`` = allows Traffic Server to send and receive ICP queries
-
- Refer to `ICP Peering <../hierachical-caching#ICPPeering>`_.
-
-.. ts:confvar:: CONFIG proxy.config.icp.icp_interface STRING your_interface
-
- Specifies the network interface used for ICP traffic.
-
- **Note:** The Traffic Server installation script detects your
- network interface and sets this variable appropriately. If your
- system has multiple network interfaces, check that this variable
- specifies the correct interface.
-
-.. ts:confvar:: CONFIG proxy.config.icp.icp_port INT 3130
- :reloadable:
-
- Specifies the UDP port that you want to use for ICP messages.
-
-.. ts:confvar:: CONFIG proxy.config.icp.query_timeout INT 2
- :reloadable:
-
- Specifies the timeout used for ICP queries.
-
-Scheduled Update Configuration
-==============================
-
-.. XXX this is missing something:
-
- ``INT``
- ``0``
- Enables (``1``) or disables (``0``) the Scheduled Update option.
-
-.. ts:confvar:: CONFIG proxy.config.update.force INT 0
- :reloadable:
-
- Enables (``1``) or disables (``0``) a force immediate update. When
- enabled, Traffic Server overrides the scheduling expiration time for
- all scheduled update entries and initiates updates until this option
- is disabled.
-
-.. ts:confvar:: CONFIG proxy.config.update.retry_count INT 10
- :reloadable:
-
- Specifies the number of times Traffic Server can retry the scheduled
- update of a URL in the event of failure.
-
-.. ts:confvar:: CONFIG proxy.config.update.retry_interval INT 2
- :reloadable:
-
- Specifies the delay (in seconds) between each scheduled update retry
- for a URL in the event of failure.
-
-.. ts:confvar:: CONFIG proxy.config.update.concurrent_updates INT 100
- :reloadable:
-
- Specifies the maximum simultaneous update requests allowed at any
- time. This option prevents the scheduled update process from
- overburdening the host.
-
-Remap Plugin Processor
-======================
-
-.. ts:confvar:: CONFIG proxy.config.remap.use_remap_processor INT 0
-
- Enables (``1``) or disables (``0``) the ability to run separate threads for remap plugin processing.
-
-.. ts:confvar:: CONFIG proxy.config.remap.num_remap_threads INT 1
-
- Specifies the number of threads that will be used for remap plugin rocessing.
-
-Plug-in Configuration
-=====================
-
-.. ts:confvar:: CONFIG proxy.config.plugin.plugin_dir STRING config/plugins
-
- Specifies the location of Traffic Server plugins.
-
-Sockets
-=======
-
-.. ts:confvar:: CONFIG proxy.config.net.defer_accept INT `1`
-
- default: ``1`` meaning ``on`` all Platforms except Linux: ``45`` seconds
-
- This directive enables operating system specific optimizations for a listening socket. ``defer_accept`` holds a call to ``accept(2)``
- back until data has arrived. In Linux' special case this is up to a maximum of 45 seconds.
-
-.. ts:confvar:: CONFIG proxy.config.net.sock_send_buffer_size_in INT 0
-
- Sets the send buffer size for connections from the client to Traffic Server.
-
-.. ts:confvar:: CONFIG proxy.config.net.sock_recv_buffer_size_in INT 0
-
- Sets the receive buffer size for connections from the client to Traffic Server.
-
-.. ts:confvar:: CONFIG proxy.config.net.sock_option_flag_in INT 0
-
- Turns different options "on" for the socket handling client connections:::
-
- TCP_NODELAY (1)
- SO_KEEPALIVE (2)
-
- **Note:** This is a flag and you look at the bits set. Therefore,
- you must set the value to ``3`` if you want to enable both options
- above.
-
-.. ts:confvar:: CONFIG proxy.config.net.sock_send_buffer_size_out INT 0
-
- Sets the send buffer size for connections from Traffic Server to the origin server.
-
-.. ts:confvar:: CONFIG proxy.config.net.sock_recv_buffer_size_out INT 0
-
- Sets the receive buffer size for connections from Traffic Server to
- the origin server.
-
-.. ts:confvar:: CONFIG proxy.config.net.sock_option_flag_out INT 0
-
- Turns different options "on" for the origin server socket:::
-
- TCP_NODELAY (1)
- SO_KEEPALIVE (2)
-
- **Note:** This is a flag and you look at the bits set. Therefore,
- you must set the value to ``3`` if you want to enable both options
- above.
-
-.. ts:confvar:: CONFIG proxy.config.net.sock_mss_in INT 0
-
- Same as the command line option ``--accept_mss`` that sets the MSS for all incoming requests.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/remap.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/remap.config.en.rst b/doc/admin/configuration-files/remap.config.en.rst
deleted file mode 100644
index 5122e60..0000000
--- a/doc/admin/configuration-files/remap.config.en.rst
+++ /dev/null
@@ -1,277 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-============
-remap.config
-============
-
-.. configfile:: remap.config
-
-.. toctree::
- :maxdepth: 2
-
-
-The :file:`remap.config` file contains mapping rules that Traffic Server
-uses to perform the following actions:
-
-- Map URL requests for a specific origin server to the appropriate
- location on Traffic Server when Traffic Server acts as a reverse
- proxy for that particular origin server
-- Reverse-map server location headers so that when origin servers
- respond to a request with a location header that redirects the client
- to another location, the clients do not bypass Traffic Server
-- Redirect HTTP requests permanently or temporarily without Traffic
- Server having to contact any origin servers
-
-Refer to `Reverse Proxy and HTTP
-Redirects <../reverse-proxy-http-redirects>`_, for information about
-redirecting HTTP requests and using reverse proxy.
-
-After you modify the :file:`remap.config` run the
-:option:`traffic_line -x` to apply the changes. When you apply the
-changes to one node in a cluster, Traffic Server automatically applies
-the changes to all other nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`remap.config` file must contain a mapping rule.
-Traffic Server recognizes three space-delimited fields: ``type``,
-``target``, and ``replacement``. The following list describes the format
-of each field.
-
-*``type``* {#type}
- Enter one of the following:
-
- - ``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.
-
- - ``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).
-
-*``target``* {#target}
- Enter the origin ("from") URL. You can enter up to four components:
-
- ::
-
- scheme://host:port/path_prefix
-
- where *``scheme``* is ``http``.
-
-*``replacement``* {#replacement}
- Enter the origin ("from") URL. You can enter up to four components:
-
- ::
-
- scheme://host:port/path_prefix
-
- where *``scheme``* can be ``http`` or ``https``.
-
-Precedence
-==========
-
-Remap rules are not processed top-down, but based on an internal
-priority
-
-1. ``map`` and ``reverse_map``
-2. ``redirect`` and ``redirect_temporary``
-3. ``regex_remap``
-4. ``regex_redirect`` and ``regex_redirect_temporary``
-
-Examples
-========
-
-The following section shows example mapping rules in the
-:file:`remap.config` file.
-
-Reverse Proxy Mapping Rules
-===========================
-
-The following example shows a map rule that does not specify a path
-prefix in the target or replacement:
-
-::
-
- map http://www.x.com/ http://server.hoster.com/
- reverse_map http://server.hoster.com/ http://www.x.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``
-
-The following example shows a map rule with path prefixes specified in
-the target:
-
-::
-
- map http://www.y.com/marketing/ http://marketing.y.com/
- reverse_map http://marketing.y.com/ http://www.y.com/marketing/
- map http://www.y.com/sales/ http://sales.y.com/
- reverse_map http://sales.y.com/ http://www.y.com/sales/
- map http://www.y.com/engineering/ http://engineering.y.com/
- reverse_map http://engineering.y.com/ http://www.y.com/engineering/
- map http://www.y.com/stuff/ http://info.y.com/
- reverse_map http://info.y.com/ http://www.y.com/stuff/
-
-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``
-
-The following example shows that the order of the rules matters:
-
-::
-
- map http://www.g.com/ http://external.g.com/
- reverse_map http://external.g.com/ http://www.g.com/
- map http://www.g.com/stuff/ http://stuff.g.com/
- reverse_map http://stuff.g.com/ http://www.g.com/stuff/
-
-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``
-
-In the above examples, the second rule is never applied because all URLs
-that match the second rule also match the first rule. The first rule
-takes precedence because it appears earlier in the :file:`remap.config`
-file.
-
-The following example shows a mapping with a path prefix specified in
-the target and replacement::
-
- map http://www.h.com/a/b/ http://server.h.com/customers/x/y
- reverse_map http://server.h.com/customers/x/y/ http://www.h.com/a/b/
-
-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``
-
-The following example shows reverse-map rules::
-
- 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 \| 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
-``Host:`` header. As a solution, set the variable
-*``proxy.config.header.parse.no_host_url_redirect``* in the
-:file:`records.config` file to the URL to which Traffic Server will redirect
-requests without host headers.
-
-Redirect Mapping Rules
-======================
-
-The following rule permanently redirects all HTTP requests for
-``www.company.com`` to ``www.company2.com``:
-
-::
-
- 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``:
-
-::
-
- redirect_temporary http://www.company1.com/ http://www.company2.com/
-
-Regular Expression (regex) Remap Support
-========================================
-
-Regular expressions can be specified in remapping rules, with the
-limitations below:
-
-- Only the ``host`` field can contain a regex; the ``scheme``,
- ``port``, and other fields cannot. For path manipulation via regexes,
- use the ``regex_remap`` plugin.
-- The number of capturing subpatterns is limited to 9. This means that
- ``$0`` through ``$9`` can be used as subtraction placeholders (``$0``
- will be the entire input string).
-- The number of substitutions in the expansion string is limited to 10.
-- There is no ``regex_`` equivalent to ``reverse_remap``, so when using
- ``regex_remap`` you should make sure the reverse path is clear by
- setting
- (`*``proxy.config.url_remap.pristine_host_hdr``* <../configuration-files/records.config#proxy.config.url_remap.pristine_host_hdr>`_)
-
-Examples
---------
-
-::
-
- 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
-
-Plugin Chaining
-===============
-
-Plugins can be configured to be evaluated in a specific order, passing
-the results from one in to the next (unless a plugin returns 0, then the
-"chain" is broken).
-
-Examples
---------
-
-::
-
- 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.
-
-This will pass "1" and "2" to plugin1.so and "3" to plugin2.so
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/splitdns.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/splitdns.config.en.rst b/doc/admin/configuration-files/splitdns.config.en.rst
deleted file mode 100644
index 4298a45..0000000
--- a/doc/admin/configuration-files/splitdns.config.en.rst
+++ /dev/null
@@ -1,125 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-===============
-splitdns.config
-===============
-
-
-The :file:`splitdns.config` file enables you to specify the DNS server that
-Traffic Server should use for resolving hosts under specific conditions.
-For more information, refer to `Configuring DNS Server Selection (Split
-DNS) <../security-options#SplitDNS>`_.
-
-To specify a DNS server, you must supply the following information in
-each active line within the file:
-
-- A primary destination specifier in the form of a destination domain,
- a destination host, or a URL regular expression
-- A set of server directives, listing one or more DNS servers with
- corresponding port numbers
-
-You can also include the following optional information with each DNS
-server specification:
-
-- A default domain for resolving hosts
-- A search list specifying the domain search order when multiple
- domains are specified
-
-After you modify the :file:`splitdns.config` file,
-run the :option:`traffic_line -x`
-command to apply the changes. When you apply changes to a node in a
-cluster, Traffic Server automatically applies the changes to all other
-nodes in the cluster.
-
-Format
-======
-
-Each line in the :file:`splitdns.config` file uses one of the following
-formats:
-
-::
-
- dest_domain=dest_domain | dest_host | url_regex named=dns_server def_domain=def_domain search_list=search_list
-
-The following list describes each field.
-
-*``dest_domain``* {#dest_domain}
- A valid domain name. This specifies that DNS server selection will
- be based on the destination domain. You can prefix the domain with
- an exclamation mark (``!``) to indicate the NOT logical operator.
-
-*``dest_host``* {#dest_host}
- A valid hostname. This specifies that DNS server selection will be
- based on the destination host. You can prefix the host with an
- exclamation mark (``!``) to indicate the ``NOT`` logical operator.
-
-*``url_regex``* {#url_regex}
- A valid URL regular expression. This specifies that DNS server
- selection will be based on a regular expression.
-
-*``dns_server``* {#dns_server}
- This is a required directive. It identifies the DNS server that
- Traffic Server should use with the given destination specifier. You
- can specify a port using a colon (``:``). If you do not specify a
- port, then 53 is used. Specify multiple DNS servers with spaces or
- semicolons (``;``) as separators.
-
- You must specify the domains with IP addresses in CIDR ("dot")
- notation.
-
-*``def_domain``* {#def_domain}
- A valid domain name. This optional directive specifies the default
- domain name to use for resolving hosts. Only one entry is allowed.
- If you do not provide the default domain, the system determines its
- value from ``/etc/resolv.conf``
-
-*``search_list``* {#search_list}
- A list of domains separated by spaces or semicolons (;). This
- specifies the domain search order. If you do not provide the search
- list, the system determines the value from ``/etc/resolv.conf``
-
-Examples
-========
-
-Consider the following DNS server selection specifications:
-
-::
-
- dest_domain=internal.company.com named=255.255.255.255:212 255.255.255.254 def_domain=company.com search_list=company.com company1.com
- dest_domain=!internal.company.com named=255.255.255.253
-
-Now consider the following two requests:
-
-::
-
- http://minstar.internal.company.com
-
-This request matches the first line and therefore selects DNS server
-``255.255.255.255`` on port ``212``. All resolver requests use
-``company.com`` as the default domain, and ``company.com`` and
-``company1.com`` as the set of domains to search first.
-
-::
-
- http://www.microsoft.com
-
-This request matches the second line. Therefore, Traffic Server selects
-DNS server ``255.255.255.253``. Because no ``def_domain`` or
-``search_list`` was supplied, Traffic Server retrieves this information
-from ``/etc/resolv.conf``
-
[5/7] docs: split reference material into top-level pages
Posted by jp...@apache.org.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/ssl_multicert.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/ssl_multicert.config.en.rst b/doc/admin/configuration-files/ssl_multicert.config.en.rst
deleted file mode 100644
index 8a11e9b..0000000
--- a/doc/admin/configuration-files/ssl_multicert.config.en.rst
+++ /dev/null
@@ -1,81 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-====================
-ssl_multicert.config
-====================
-
-.. configfile:: ssl_multicert.config
-
-The :file:`ssl_multicert.config` file lets you configure Traffic Server to
-use multiple SSL server certificates with the SSL termination option. If
-you have a Traffic Server system with more than one IP address assigned
-to it, then you can assign a different SSL certificate to be served when
-a client requests a particular IP address.
-
-Format
-======
-
-The format of the :file:`ssl_multicert.config` file is:
-
-::
-
- dest_ip=ipaddress ssl_cert_name=cert_name ssl_key_name=key_name
-
-where ``ipaddress`` is an IP address assigned to Traffic Server ,
-``ssl_cert_name`` is the filename of the Traffic Server SSL server
-certificate, ``ssl_key_name`` is the filename of the Traffic Server
-SSL private key. If the private key is located in the certificate file,
-then you do not need to specify the name of the private key.
-Additionally ``ssl_ca_name`` can be used to specify the location of a
-Certification Authorithy change in case that differs from what is
-specified under the :file:`records.config`
-``proxy.config.ssl.CA.cert.filename`` value.
-
-Traffic Server will try to find the files specified in
-*``ssl_cert_name``* relative to
-```proxy.config.ssl.server.cert.path`` <../records.config#proxy.config.ssl.server.cert.path>`_,
-*``ssl_key_name``* relative to
-```proxy.config.ssl.server.private_key.path`` <../records.config#proxy.config.ssl.server.private_key.path>`_,
-and *``ssl_ca_name``* relative to
-```proxy.config.ssl.CA.cert.path`` <../records.config#proxy.config.ssl.CA.cert.path>`_.
-
-Examples
-========
-
-The following example configures Traffic Server to use the SSL
-certificate ``server.pem`` for all requests to the IP address
-111.11.11.1 and the SSL certificate ``server1.pem`` for all requests to
-the IP address 11.1.1.1. Since the private key *is* included in the
-certificate files, no private key name is specified.
-
-::
-
- dest_ip=111.11.11.1 ssl_cert_name=server.pem
- dest_ip=11.1.1.1 ssl_cert_name=server1.pem
-
-The following example configures Traffic Server to use the SSL
-certificate ``server.pem`` and the private key ``serverKey.pem`` for all
-requests to the IP address 111.11.11.1. Traffic Server uses the SSL
-certificate ``server1.pem`` and the private key ``serverKey1.pem`` for
-all requests to the IP address 11.1.1.1.
-
-::
-
- dest_ip=111.11.11.1 ssl_cert_name=server.pem ssl_key_name=serverKey.pem
- dest_ip=11.1.1.1 ssl_cert_name=server1.pem ssl_key_name=serverKey1.pem
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/storage.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/storage.config.en.rst b/doc/admin/configuration-files/storage.config.en.rst
deleted file mode 100644
index aa5a953..0000000
--- a/doc/admin/configuration-files/storage.config.en.rst
+++ /dev/null
@@ -1,120 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-==============
-storage.config
-==============
-
-.. configfile:: storage.config
-
-The :file:`storage.config` file lists all the files, directories, and/or
-hard disk partitions that make up the Traffic Server cache. After you
-modify the :file:`storage.config` file, you must restart Traffic Server.
-
-Format
-======
-
-The format of the :file:`storage.config` file is::
-
- pathname size volume=volume_number
-
-where ``pathname`` is the name of a partition, directory or file, ``size``
-is the size of the named partition, directory or file (in bytes), and
-``volume`` is the volume number that is used in :file:`volume.config`
-and :file:`hosting.config`. You must specify a size for directories or
-files; size is optional for raw partitions. ``volume`` is optional.
-
-You can use any partition of any size. For best performance:
-
-- Use raw disk partitions.
-- For each disk, make all partitions the same size.
-- For each node, use the same number of partitions on all disks.
-- Group similar kinds of storage into different volumes. For example
- split out SSD's or RAM drives into their own volume.
-
-Specify pathnames according to your operating system requirements. See
-the following examples. In the :file:`storage.config` file, a formatted or
-raw disk must be at least 128 MB.
-
-When using raw disk or partitions, you should make sure the admin user,
-which is the traffic_server running at, have the read&write privileges.
-The admin user_id is set in
-```proxy.config.admin.user_id`` <records.config#proxy.config.admin.user_id>`_.
-One good practice is if the disk set with g+rw, put the admin user into
-the group which have the privileges.
-
-Examples
-========
-
-The following basic example shows 64 MB of cache storage in the
-``/big_dir`` directory::
-
- /big_dir 67108864
-
-You can use the ``.`` symbol for the current directory. Here is an
-example for 64 MB of cache storage in the current directory::
-
- . 67108864
-
-Solaris Example
----------------
-
-The following example is for the Solaris operating system::
-
- /dev/rdsk/c0t0d0s5
- /dev/rdsk/c0t0d1s5
-
-
-.. note:: Size is optional. If not specified, the entire partition is used.
-
-Linux Example
--------------
-
-The following example will use an entire raw disk in the Linux operating
-system:::
-
- /dev/sde volume=1
- /dev/sdf volume=2
-
-In order to make sure ``traffic_server`` will have access to this disk
-you can use ``udev`` to persistently set the right permissions. The
-following rules are targeted for an Ubuntu system, and stored in
-``/etc/udev/rules.d/51-cache-disk.rules``::
-
- # Assign /dev/sde and /dev/sdf to the www group
- # make the assignment final, no later changes allowed to the group!
- SUBSYSTEM=="block", KERNEL=="sd[ef]", GROUP:="www"
-
-FreeBSD Example ## {#LinuxExample}
-----------------------------------
-
-Starting with 5.1 FreeBSD dropped support for explicit raw devices. All
-devices on FreeBSD can be accessed raw now.
-
-The following example will use an entire raw disk in the FreeBSD
-operating system::
-
- /dev/ada1
- /dev/ada2
-
-In order to make sure ``traffic_server`` will have access to this disk
-you can use ``devfs`` to persistently set the right permissions. The
-following rules are stored in ``/etc/devfs.conf``::
-
- # Assign /dev/ada1 and /dev/ada2 to the tserver user
- own ada[12] tserver:tserver
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/update.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/update.config.en.rst b/doc/admin/configuration-files/update.config.en.rst
deleted file mode 100644
index 0b7659e..0000000
--- a/doc/admin/configuration-files/update.config.en.rst
+++ /dev/null
@@ -1,203 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-=============
-update.config
-=============
-
-.. configfile:: update.config
-
-The :file:`update.config` file controls how Traffic Server performs a
-scheduled update of specific local cache content. The file contains a
-list of URLs specifying objects that you want to schedule for update.
-
-A scheduled update performs a local HTTP ``GET`` on the objects at the
-specific time or interval. You can control the following parameters for
-each specified object:
-
-- The URL
-- URL-specific request headers, which overrides the default
-- The update time and interval
-- The recursion depth
-
-After you modify the :file:`update.config` file,
-run the :option:`traffic_line -x`
-command to apply changes. When you apply changes to one node in a
-cluster, Traffic Server automatically applies the changes to all other
-nodes in the cluster.
-
-Supported Tag/Attribute Pairs
-=============================
-
-Scheduled update supports the following tag/attribute pairs when
-performing recursive URL updates:
-
-- ``<a href=" ">``
-- ``<img src=" ">``
-- ``<img href=" ">``
-- ``<body background=" ">``
-- ``<frame src=" ">``
-- ``<iframe src=" ">``
-- ``<fig src=" ">``
-- ``<overlay src=" ">``
-- ``<applet code=" ">``
-- ``<script src=" ">``
-- ``<embed src=" ">``
-- ``<bgsound src=" ">``
-- ``<area href=" ">``
-- ``<base href=" ">``
-- ``<meta content=" ">``
-
-Scheduled update is designed to operate on URL sets consisting of
-hundreds of input URLs (expanded to thousands when recursive URLs are
-included); it is *not* intended to operate on extremely large URL sets,
-such as those used by Internet crawlers.
-
-Format
-======
-
-Each line in the :file:`update.config` file uses the following format:
-
-::
-
- URL\request_headers\offset_hour\interval\recursion_depth\
-
-The following list describes each field.
-
-*``URL``* {#URL}
- HTTP-based URLs.
-
-*``request_headers``* {#request_headers}
- Optional. A list of headers, separated by semicolons, passed in each
- ``GET`` request. You can define any request header that conforms to
- the HTTP specification; the default is no request header.
-
-*``offset_hour``* {#offset_hour}
- The base hour used to derive the update periods. The range is 00-23
- hours.
-
-*``interval``* {#interval}
- The interval (in seconds) at which updates should occur, starting at
- the offset hour.
-
-*``recursion_depth``* {#recursion_depth}
- The depth to which referenced URLs are recursively updated, starting
- at the given URL. This field applies only to HTTP.
-
-Examples
-========
-
-An example HTTP scheduled update is provided below:
-
-::
-
- http://www.company.com\User-Agent: noname user agent\13\3600\5\
-
-The example specifies the URL and request headers, an offset hour of 13
-(1 pm), an interval of one hour, and a recursion depth of 5. This would
-result in updates at 13:00, 14:00, 15:00, and so on. To schedule an
-update that occurs only once a day, use an interval value 86400 (i.e.,
-24 hours x 60 minutes x 60 seconds = 86400).
-
-Specifying URL Regular Expressions (``url_regex``)
-==================================================
-
-This section describes how to specify a ``url_regex``. Entries of type
-``url_regex`` within the configuration files use regular expressions to
-perform a match.
-
-The following list provides examples to show how to create a valid
-``url_regex``.
-
-``x``
- Matches the character ``x``
-
-``.``
- Match any character
-
-``^``
- Specifies beginning of line
-
-``$``
- Specifies end of line
-
-``[xyz]``
- A **character class**. In this case, the pattern matches either
- ``x``, ``y``, or\ ``z``
-
-``[abj-oZ]``
- A **character class** with a range. This pattern matches ``a``,
- ``b``, any letter from ``j`` through ``o``, or ``Z``
-
-``[^A-Z]``
- A **negated character class**. For example, this pattern matches any
- character except those in the class.
-
-``r*``
- Zero or more ``r``, where ``r`` is any regular expression.
-
-``r+``
- One or more ``r``, where ``r`` is any regular expression.
-
-``r?``
- Zero or one ``r``, where ``r`` is any regular expression.
-
-``r{2,5}``
- From two to five ``r``, where ``r`` is any regular expression.
-
-``r{2,}``
- Two or more ``r``, where ``r`` is any regular expression.
-
-``r{4}``
- Exactly four ``r``, where ``r`` is any regular expression.
-
-``"[xyz]\"images"``
- The literal string ``[xyz]"images"``
-
-``\X``
- If ``X`` is ``a, b, f, n, r, t,`` or ``v``, then the ``ANSI-C``
- interpretation of ``\x``; otherwise, a literal ``X``. This is used
- to escape operators such as ``*``
-
-``\0``
- A ``NULL`` character
-
-``\123``
- The character with octal value ``123``
-
-``\x2a``
- The character with hexadecimal value ``2a``
-
-``(r)``
- Matches an ``r``, where ``r`` is any regular expression. You can use
- parentheses to override precedence.
-
-``rs``
- The regular expression ``r``, followed by the regular expression
- ``s``
-
-``r|s``
- Either an ``r`` or an ``s``
-
-``#<n>#``
- Inserts an **end node**, which causes regular expression matching to
- stop when reached. The value ``n`` is returned.
-
-You can specify ``dest_domain=mydomain.com`` to match any host in
-``mydomain.com``. Likewise, you can specify ``dest_domain=.`` to match
-any request.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/configuration-files/volume.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/configuration-files/volume.config.en.rst b/doc/admin/configuration-files/volume.config.en.rst
deleted file mode 100644
index 51f239f..0000000
--- a/doc/admin/configuration-files/volume.config.en.rst
+++ /dev/null
@@ -1,72 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-=============
-volume.config
-=============
-
-.. configfile:: volume.config
-
-The :file:`volume.config` file enables you to manage your cache space more
-efficiently and restrict disk usage by creating cache volumes of
-different sizes for specific protocols. You can further configure these
-volumes to store data from certain origin servers and/or domains in the
-:file:`hosting.config` file.
-
-.. important::
-
- The volume configuration must be the same on all nodes in
- a cluster. You must stop Traffic Server before you change the cache
- volume size and protocol assignment. For step-by-step instructions about
- partitioning the cache, refer to `Partitioning the
- Cache <../configuring-cache#PartitioningCache>`_.
-
-Format
-======
-
-For each volume you want to create, enter a line with the following
-format:
-
-::
-
- volume=volume_number scheme=protocol_type size=volume_size
-
-where *``volume_number``* is a number between 1 and 255 (the maximum
-number of volumes is 255) and *``protocol_type``* is ``http``. Traffic
-Server supports ``http`` for HTTP volume types; *``volume_size``* is the
-amount of cache space allocated to the volume. This value can be either
-a percentage of the total cache space or an absolute value. The absolute
-value must be a multiple of 128 MB, where 128 MB is the smallest value.
-If you specify a percentage, then the size is rounded down to the
-closest multiple of 128 MB.
-
-Each volume is striped across several disks to achieve parallel I/O. For
-example: if there are four disks, then a 1-GB volume will have 256 MB on
-each disk (assuming each disk has enough free space available). If you
-do not allocate all the disk space in the cache, then the extra disk
-space is not used. You can use the extra space later to create new
-volumes without deleting and clearing the existing volumes.
-
-Examples
-========
-
-The following example partitions the cache evenly between HTTP and HTTPS
-requests::
-
- volume=1 scheme=http size=50%
- volume=2 scheme=https size=50%
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/admin/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/admin/index.en.rst b/doc/admin/index.en.rst
index 90aeed6..560b77b 100644
--- a/doc/admin/index.en.rst
+++ b/doc/admin/index.en.rst
@@ -1,4 +1,4 @@
-Administrators's Guide
+Administrators' Guide
**********************
.. Licensed to the Apache Software Foundation (ASF) under one
@@ -43,10 +43,8 @@ Contents:
security-options.en
working-log-files.en
event-logging-formats.en
- configuration-files.en
traffic-line-commands.en
traffic-server-error-messages.en
- commands/index.en
faqs.en
@@ -305,10 +303,3 @@ following:
Traffic Server security options are described in more detail in
`Security Options <security-options>`_.
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/index.rst
----------------------------------------------------------------------
diff --git a/doc/index.rst b/doc/index.rst
index e793b63..951bd86 100644
--- a/doc/index.rst
+++ b/doc/index.rst
@@ -39,11 +39,13 @@ bandwidth.
admin/index.en
sdk/index.en
- plugins/index.en
+ reference/configuration/index.en
+ reference/commands/index.en
+ reference/plugins/index.en
+ reference/api/index.en
Indices and tables
==================
* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/balancer.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/balancer.en.rst b/doc/plugins/balancer.en.rst
deleted file mode 100644
index 9d54d91..0000000
--- a/doc/plugins/balancer.en.rst
+++ /dev/null
@@ -1,92 +0,0 @@
-Balancer Plugin
-***************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-This is a plugin for Traffic Server, that allows you to configure
-mapping rules.
-
-To use this plugin, configure a remap.config rule like
-
-::
- map http://foo.com http://bar.com @plugin=balancer.so @pparam=rotation:news
-
-The "To-Url" in the remap.config rule is generally not used, unless the
-lookup completely fails (i.e. this is a backup URL for extreme error
-cases).
-
-This is a list of all available options (set via @pparam):
-
-::
- rotation The name of the rotation (e.g. news) [to-host in remap]
- hash What to hash on, url, path, cookie, ip, header (primary)
- hash2 Optional, secondary hash, to hash within a multi-host bucket
- bucketw Width of each hash bucket [1]
-
-The rotation parameter specifies which rotation to do the lookup on. If
-not specified, we will default to the same name as used in the To URL in
-the remap rule.
-
-The bucket width specifies how many hosts a particular hash bucket
-should contain, for example:
-
-::
- @pparam=bucketw:2
-
-The hash parameter can be used zero or more times, without it, no
-hashing is done at all. If you have more than one hash keys, they are
-concatenated in the order specified. For example:
-
-::
- @pparam=hash:ip @pparam=hash:cookie/B
-
-The "header" hash key takes a required extra value, for example:
-
-::
- @pparam=hash:header/Host
-
-For "cookie" hash keys, you can optionally specify an identifier for
-which cookie to use (without it, the entire cookie header is used). For
-example:
-
-::
- @pparam=hash:cookie/B
-
-The secondary hash ("hash2") is used to provide "stickiness" within a
-bucket that's larger than one host (i.e. bucketw > 1). This allows you
-to (for example) have a primary hash on the URL, where each URL is
-served by some number of servers. A secondary hash on B-cookie would
-then provide user stickiness, so that for a particular URL, a particular
-user will always hit the same server.
-
-If the hashes you've requested (either "hash" or "hash2") can not be
-generated, we default to using the URL instead for the primary hash. For
-the secondary hash, if set, we'll default to the src-IP. If these
-defaults are not desirable, make sure that you have at least one hash
-key that is guaranteed to exist (e.g. @pparam=hash:ip).
-
-If no "hash" parameters are specified, no hashing is done. This is the
-default behavior, obviously. In this cash, the "hash2" directive has no
-effect as well.
-
-Finally, a couple of "flag" options (parameters) are available, to
-control some of the lookup mechanisms:
-
-- @pparam=hostip will use the IP returned by the lookup
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/buffer_upload.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/buffer_upload.en.rst b/doc/plugins/buffer_upload.en.rst
deleted file mode 100644
index ab5f209..0000000
--- a/doc/plugins/buffer_upload.en.rst
+++ /dev/null
@@ -1,89 +0,0 @@
-Buffer Upload Plugin
-********************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-.. XXX Discribe what the heck this plugin actually does.
-
-Upload proxy specs for phase I:
-
-1. Memory buffering (buffer the entire POST data in IOBuffer before
- connecting to OS) 1.1. Memory buffer size is configured with
- "mem_buffer_size" in config file. Default and minimum value is 32K
- You can increase it in the config file. If the size of a request is
- larger than the "mem_buffer_size" value specifiied in the config
- file, then the upload proxy feature will be disabled for this
- particular request
-
-2. Disk buffering (buffer the entire POST data on disk before connecting
- to OS) 2.1. Use disk async IO. This involved some changes in ATS core
- . new APIs wrapping around ink_aio_read() and ink_aio_write() .
- change to distinguish between api call's AIO and cache's AIO .
- guarantee api call's AIO only involves certain amount of threads .
- the number of threads is configurable in plugin's config file
- (default is 4)
-
-3.
-
- 2. Directories and files generated on disk . base directory:
- FOOBAR/var/buffer_upload_tmp/ (configurable in config file) .
- number of subdirectories: 64 (configurable in config file) .
- filename are randomly generated . files will be removed when the
- entire data have been sent out to OS . remove dangling files (left
- on disk due to transaction interruption or traffic server crash)
- at startup time
-
-4.
-
- 3. Default chunk size when reading from disk: 16K, configurable in
- config file
-
-5. Default buffering mode: disk aio buffering mode 3.1. to turn off disk
- buffering, add a "use_disk_buffer 0" line in config file
-
-6. Trigger POST buffering on certain URLs 4.1. certain URLs will be
- provided in a plain text file (one URL each line) 4.2. specify
- filename in config file by "url_list_file" 4.3. max length of each
- URL: 4096 (configurable in config file) 4.4. use exact match, don't
- support regex for now
-
-7. URL conversion for Mail's specific URL format 5.1. for now check if
- the "host" part in the URL is same as the proxy server name, then
- will do this conversion 5.2. To turn on URL conversion feature, set
- "convert_url 1" in config file
-
-8. All request headers inlcuding cookies plus the entire POST data will
- be buffered (either in memory or on disk)
-
-9. Config file can be explicitly sepcified as a parameter in command
- line (in plugin.config file)
-
-a sample config file:
-
-use_disk_buffer 1 convert_url 1 chunk_size 1024 url_list_file
-/tmp/url_list.conf max_url_length 10000 base_dir /tmp/test1
-subdir_num 100 thread_num 10 mem_buffer_size 40000
-
-default config file: FOOBAR/etc/upload.conf
-
-default config values: use_disk_buffer 1 convert_url 0 chunk_size
-16384 url_list_file none max_url_length 4096 base_dir
-FOOBAR/var/buffer_upload_tmp subdir_num 64 thread_num 4
-mem_buffer_size 32768
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/cacheurl.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/cacheurl.en.rst b/doc/plugins/cacheurl.en.rst
deleted file mode 100644
index 093beac..0000000
--- a/doc/plugins/cacheurl.en.rst
+++ /dev/null
@@ -1,59 +0,0 @@
-CacheURL Plugin
-***************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-
-This plugin allows you to change the key that is used for caching a
-request. It is designed so that multiple requests that have different
-URLs but the same content (for example, site mirrors) need be cached
-only once.
-
-Installation
-============
-
-This plugin is only built if the configure option ::
-
- --enable-experimental-plugins
-
-is given at build time.
-
-Configuration
-=============
-
-Create a ``cacheurl.config`` file in the plugin directory with the url
-patterns to match. See the ``cacheurl.config.example`` file for what to
-put in this file.
-
-Add the plugin to your
-```plugins.config`` <../../configuration-files/plugins.config>`_ file::
-
- cacheurl.so
-
-Start traffic server. Any rewritten URLs will be written to
-``cacheurl.log`` in the log directory by default.
-
-More docs
-=============
-
-There are some docs on cacheurl in Chinese, please find them in the following:
-
-```http://people.apache.org/~zym/trafficserver/cacheurl.html`` <http://people.apache.org/~zym/trafficserver/cacheurl.html>`_
-
-```https://blog.zymlinux.net/index.php/archives/195`` <https://blog.zymlinux.net/index.php/archives/195>`_
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/combo_handler.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/combo_handler.en.rst b/doc/plugins/combo_handler.en.rst
deleted file mode 100644
index 260d3f3..0000000
--- a/doc/plugins/combo_handler.en.rst
+++ /dev/null
@@ -1,84 +0,0 @@
-Combohandler Plugin
-*******************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-This plugin provides an intelligent way to combine multiple URLs into a single
-URL, and have Apache Traffic Server combine the components into one
-response. This is useful for example to create URLs that combine multiple CSS
-or Javascript files into one.
-
-Installation
-============
-
-This plugin is only built if the configure option ::
-
- --enable-experimental-plugins
-
-is given at build time. Note that this plugin is built and installed in
-combination with the ESI module, since they share common code.
-
-Configuration
-=============
-
-The arguments in the
-```plugin.config`` <../../configuration-files/plugin.config>`_ line in
-order represent
-
-1. The path that should triggers combo handler (defaults to
- "admin/v1/combo")
-
-2. The name of the key used for signature verification (disabled by
- default)
-
-A "-" can be supplied as a value for any of these arguments to request
-default value be applied.
-
-Also, just like the original combohandler, this plugin generates URLs of
-the form ``http://localhost/<dir>/<file-path>``. ``<dir>`` here defaults
-to ``l`` unless specified by the file path in the query parameter using
-a colon. For example::
-
- http://combo.com/admin/v1/combo?filepath1&dir1:filepath2&filepath3
-
-Will result in these three pages being fetched::
-
- http://localhost/l/filepath1
- http://localhost/dir1/filepath2
- http://localhost/l/filepath3
-
-Remap rules have to be specified to map the above URLs to desired
-content servers.
-
-The plugin also supports a prefix parameter. Common parts of successive
-file paths can be extracted and specified separately using a 'p' query
-parameter. Successive file path parameters are appended to this prefix
-to create complete file paths. The prefix will remain active until
-changed or cleared (set to an empty string). For example, the query ::
- "/file1&p=/path1/&file2&file3&p=&/file4&p=/dir:path2/&file5&file6"
-
-results in these file paths being "reconstructed"::
-
- /file1
- /path1/file2
- /path1/file3
- /file4
- /dir:path2/file5
- /dir:path2/file6
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/conf_remap.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/conf_remap.en.rst b/doc/plugins/conf_remap.en.rst
deleted file mode 100644
index 2f90e1c..0000000
--- a/doc/plugins/conf_remap.en.rst
+++ /dev/null
@@ -1,107 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information regarding
- copyright ownership. The ASF licenses this file to you under
- the Apache License, Version 2.0 (the "License"); you may not use
- this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an "AS
- IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- express or implied. See the License for the specific language
- governing permissions and limitations under the License.
-
-conf_remap Plugin
-=================
-
-The `conf_remap` plugin allows you to override configuration
-directives dependent on actual remapping rules. The plugin is built
-and installed as part of the normal Apache Traffic Server installation
-process.
-
-If you want to achieve this behaviour now, configure a remap rule
-like this::
-
- map http://cdn.example.com/ http://some-server.example.com @plugin=conf_remap.so @pparam=/etc/trafficserver/cdn.conf
-
-where `cdn.conf` would look like :file:`records.config`. For example::
-
- CONFIG proxy.config.url_remap.pristine_host_hdr INT 1
-
-Doing this, you will override your global default configuration on
-a per mapping rule. For now, those options may be overridden through
-the `conf_remap` plugin:
-
-|
-|
-| proxy.config.url_remap.pristine_host_hdr
-| proxy.config.http.chunking_enabled
-| proxy.config.http.negative_caching_enabled
-| proxy.config.http.negative_caching_lifetime
-| proxy.config.http.cache.when_to_revalidate
-| proxy.config.http.keep_alive_enabled_in
-| proxy.config.http.keep_alive_enabled_out
-| proxy.config.http.keep_alive_post_out
-| proxy.config.http.share_server_sessions
-| proxy.config.net.sock_recv_buffer_size_out
-| proxy.config.net.sock_send_buffer_size_out
-| proxy.config.net.sock_option_flag_out
-| proxy.config.http.forward.proxy_auth_to_parent
-| proxy.config.http.anonymize_remove_from
-| proxy.config.http.anonymize_remove_referer
-| proxy.config.http.anonymize_remove_user_agent
-| proxy.config.http.anonymize_remove_cookie
-| proxy.config.http.anonymize_remove_client_ip
-| proxy.config.http.anonymize_insert_client_ip
-| proxy.config.http.response_server_enabled
-| proxy.config.http.insert_squid_x_forwarded_for
-| proxy.config.http.server_tcp_init_cwnd
-| proxy.config.http.send_http11_requests
-| proxy.config.http.cache.http
-| proxy.config.http.cache.cluster_cache_local
-| proxy.config.http.cache.ignore_client_no_cache
-| proxy.config.http.cache.ignore_client_cc_max_age
-| proxy.config.http.cache.ims_on_client_no_cache
-| proxy.config.http.cache.ignore_server_no_cache
-| proxy.config.http.cache.cache_responses_to_cookies
-| proxy.config.http.cache.ignore_authentication
-| proxy.config.http.cache.cache_urls_that_look_dynamic
-| proxy.config.http.cache.required_headers
-| proxy.config.http.insert_request_via_str
-| proxy.config.http.insert_response_via_str
-| proxy.config.http.cache.heuristic_min_lifetime
-| proxy.config.http.cache.heuristic_max_lifetime
-| proxy.config.http.cache.guaranteed_min_lifetime
-| proxy.config.http.cache.guaranteed_max_lifetime
-| proxy.config.http.cache.max_stale_age
-| proxy.config.http.keep_alive_no_activity_timeout_in
-| proxy.config.http.keep_alive_no_activity_timeout_out
-| proxy.config.http.transaction_no_activity_timeout_in
-| proxy.config.http.transaction_no_activity_timeout_out
-| proxy.config.http.transaction_active_timeout_out
-| proxy.config.http.origin_max_connections
-| proxy.config.http.connect_attempts_max_retries
-| proxy.config.http.connect_attempts_max_retries_dead_server
-| proxy.config.http.connect_attempts_rr_retries
-| proxy.config.http.connect_attempts_timeout
-| proxy.config.http.post_connect_attempts_timeout
-| proxy.config.http.down_server.cache_time
-| proxy.config.http.down_server.abort_threshold
-| proxy.config.http.cache.fuzz.time
-| proxy.config.http.cache.fuzz.min_time
-| proxy.config.http.doc_in_cache_skip_dns
-| proxy.config.http.background_fill_active_timeout
-| proxy.config.http.response_server_str
-| proxy.config.http.cache.heuristic_lm_factor
-| proxy.config.http.cache.fuzz.probability
-| proxy.config.http.background_fill_completed_threshold
-| proxy.config.net.sock_packet_mark_out
-| proxy.config.net.sock_packet_tos_out
-| proxy.config.http.insert_age_in_response
-| proxy.config.http.chunking.size
-| proxy.config.http.flow_control.enabled
-| proxy.config.http.flow_control.low_water
-| proxy.config.http.flow_control.high_water
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/esi.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/esi.en.rst b/doc/plugins/esi.en.rst
deleted file mode 100644
index 9130791..0000000
--- a/doc/plugins/esi.en.rst
+++ /dev/null
@@ -1,22 +0,0 @@
-ESI Plugin (undocumented)
-*************************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-This plugin implements the ESI specification.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/geoip_acl.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/geoip_acl.en.rst b/doc/plugins/geoip_acl.en.rst
deleted file mode 100644
index a864706..0000000
--- a/doc/plugins/geoip_acl.en.rst
+++ /dev/null
@@ -1,94 +0,0 @@
-GeoIP ACLs Plugin
-*****************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-This is a simple ATS plugin for denying (or allowing) requests based on
-the source IP geo-location. Currently only the Maxmind APIs are
-supported, but we'd be happy to other other (open) APIs if you let us
-know. This plugin comes with the standard distribution of Apache Traffic
-Server, and should be installed as part of the normal build process.
-
-
-Configuration
-=============
-
-Once installed, there are three primary use cases, which we will discuss
-in details. Note that in all configurations, the first plugin parameter
-must specify what the matches should be applied to. Currently, only one
-rule set is supported, for Country ISO codes. This is specified with a
-parameter of ::
-
- @pparam=country
-
-Future additions to this plugin could include other regions, such as
-city, state, continent etc.
-
-The three typical use cases are as follows:
-
-1. Per remap configurations, applicable to the entire remap rule. This
- is useful when you can partition your content so that entire prefix
- paths should be filtered. For example, lets assume that
- http://example.com/music is restricted to US customers only, and
- everything else is world wide accessible. In remap.config, you would
- have something like ::
-
- map http://example.com/music http://music.example.com \
- @plugin=geoip_acl.so @pparam=country @pparam=allow @pparam=US
- map http://example.com http://other.example.com
-
-2. If you can not partition the data with a path prefix, you can specify
- a separate regex mapping filter. The remap.config file might then
- look like ::
-
- map http://example.com http://music.example.com \
- @plugin=geoip_acl.so @pparam=country \
- @pparam=regex::/etc/music.regex
-
-where music.regex is a format with PCRE (perl compatible) regular
-expressions, and unique rules for match. E.g.::
-
- .*\.mp3 allow US
- .*\.ogg deny US
-
-Note that the default in the case of no matches on the regular
-expressions is to "allow" the request. This can be overriden, see next
-use case.
-
-3. You can also combine 1) and 2), and provide defaults in the
- remap.config configuration, which then applies for the cases where no
- regular expressions matches at all. This would be useful to override
- the default which is to allow all requests that don't match. For
- example ::
-
- map http://example.com http://music.example.com \
- @plugin=geoip_acl.so @pparam=country @pparam=allow @pparam= US
- @pparam=regex::/etc/music.regex
-
-This tells the plugin that in the situation where there is no matching
-regular expression, only allow requests originating from the US.
-
-Finally, there's one additional parameter option that can be used ::
-
- @pparam=html::/some/path.html
-
-This will override the default reponse body for the denied responses
-with a custom piece of HTML. This can be useful to explain to your users
-why they are getting denied access to a particular piece of content.
-This configuration can be used with any of the use cases described
-above.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/gzip.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/gzip.en.rst b/doc/plugins/gzip.en.rst
deleted file mode 100644
index ca49913..0000000
--- a/doc/plugins/gzip.en.rst
+++ /dev/null
@@ -1,91 +0,0 @@
-gzip / deflate Plugin
-*********************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-This plugin gzips or deflates responses, whichever is applicable. It can
-compress origin respones as well as cached responses. The plugin is built
-and installed as part of the normal Apache Traffic Server installation
-process.
-
-Installation
-============
-
-Add the following line to
-```plugin.config`` <../../configuration-files/plugin.config>`_::
-
- gzip.so
-
-In this case, the plugin will use the default behaviour:
-
-- Enable caching
-- Compress text/\* for every origin
-- Don't hide accept encoding from origin servers (for an offloading
- reverse proxy)
-- No urls are disallowed from compression
-
-Configuration
-=============
-
-Alternatively, a configuration can also be specified::
-
- gzip.so <path-to-plugin>/sample.gzip.config
-
-After modifying plugin.cofnig, restart traffic server (sudo
-traffic_line -L) the configuration is re-read when a management update
-is given (sudo traffic_line -x)
-
-Options
-=======
-
-Flags and options are:
-
-``enabled``: (``true`` or ``false``) Enable or disable compression for a
-host.
-
-``remove-accept-encoding``: (``true`` or ``false``) Sets whether the
-plugin should hide the accept encoding from origin servers:
-
-- To ease the load on the origins.
-- For when the proxy parses responses, and the resulting
- compression/decompression is wasteful.
-
-``cache``: (``true`` or ``false``) When set, the plugin stores the
-uncompressed and compressed response as alternates.
-
-``compressible-content-type``: Wildcard pattern for matching
-compressible content types.
-
-``disallow``: Wildcard pattern for disabling compression on urls.
-
-Options can be set globally or on a per-site basis, as such::
-
- # Set some global options first
- cache true
- enabled true
- remove-accept-encoding false
- compressible-content-type text/*
-
- # Now set a configuration for www.example.com
- [www.example.com]
- cache false
- remove-accept-encoding true
- disallow /notthis/*.js
-
-See example.gzip.config for example configurations.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/header_filter.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/header_filter.en.rst b/doc/plugins/header_filter.en.rst
deleted file mode 100644
index 3885612..0000000
--- a/doc/plugins/header_filter.en.rst
+++ /dev/null
@@ -1,133 +0,0 @@
-Header Filter Plugin
-********************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-The ``header_filter`` is a simple plugin for filtering out headers from
-requests (or responses). Typical configuration is done either with a
-global configuration, in
-```plugin.config`` <../../configuration-files/plugin.config>`_::
-
- header_filter.so /usr/local/etc/hdr_filters.conf
-
-Or, alternatively, in a
-```per-remap`` <../../configuration-files/remap.config>`_ rule
-configuration ::
-
- map http://a.com/ http://b.com @plugin=header_filter.so @pparam=hdr_filters.conf
-
-Even if you don't have a global configuration, if your remap rules
-schedules actions in hooks other than during remap, you must also add
-the ``header_filter.so`` to the
-```plugin.config`` <../../configuration-files/remap.config>`_ (see
-above), but without args::
-
- header_filter.so
-
-The configuration files looks like ::
-
- [READ_REQUEST_HDR]
- X-From-Someone
- Cookie
-
- [READ_RESPONSE_HDR]
- X-From-Server
- Set-Cookie
-
- [SEND_RESPONSE_HDR]
- X-Fie "Test" # Match the entire string
- X-Foo /Test/ # Match the (Perl) regex
- X-Bar [Test* # Match the prefix string
- X-Fum *Test] # Match the postfix string
-
-
-Comments are prefixed with ``#``, and in most cases, the regular
-expression matching is the best choice (very little overhead). The
-pattern matches can also take an option '``!``\ ' to reverse the test.
-The default action is to delete all headers that do (not) match the
-pattern. E.g.::
-
- [SEND_REQUEST_HDR]
- X-Fie /test/
- X-Foo ! /test/i
-
-The final "``i``\ " qualifier (works on all pattern matches) forces the
-match or comparison to be made case insensitive (just like in Perl).
-
-It's also possible to replace or add headers, using the = and +
-operators. For example ::
-
- [SEND_REQUEST_HDR]
- Host =www.example.com=
- X-Foo +ATS+
-
-This will force the Host: header to have exactly one value,
-``www.example.com``, while ``X-Foo`` will have at least one header with
-the value ATS, but there could be more instances of the header from the
-existing header in the request.
-
-Possible hooks are ::
-
- READ_REQUEST_HDR
- SEND_REQUEST_HDR
- READ_RESPONSE_HDR
- SEND_RESPONSE_HDR
-
-If not specified, the default hook to add the rules (headers to filter)
-is ``READ_REQUEST_HDR``. It's completely acceptable (and useful) to
-configure a remap rule to delete headers in a later hook (e.g. when
-reading a response from the server). This is what actually makes the
-plugin even remotely useful.
-
-
-Examples
-========
-
-Set X-Forwarded-Proto https on SSL connections
-----------------------------------------------
-
-Often times a backend wants to know whether it's running under HTTP or
-HTTPS. While not regulated standard, we can use the
-``X-Forwarded-Proto`` header for this purpose.
-
-In ```plugin.config`` <../../configuration-files/plugin.config>`_ we
-need to add::
-
- header_filter.so
-
-Then, in ```remap.config`` <../../configuration-files/remap.config>`_ we
-can configure ``header_filter`` on a case by case basis::
-
- map http://example.org http://172.16.17.42:8080
- map https://example.org http://172.16.17.42:8080 @plugin=header_filter.so @pparam=/etc/trafficserver/x_fwd_proto.conf
-
-The configuration that ties everything together is then
-``/etc/trafficserver/x_fwd_proto.config``, to which we add::
-
- [SEND_REQUEST_HDR]
- X-Forwarded-Proto =https=
-
-To activate this configuration, we need to restart Traffic Server with
-``traffic_line -L``.
-
-In the backend servers we can now pick this up and do appropriately set
-server variables that will be picked up by CGI programs for instance. In
-the case of Apache httpd backend, this can be acomplished with
-```mod_setenvif`` <http://httpd.apache.org/docs/current/mod/mod_setenvif.html#setenvif>`_::
-
- SetEnvIf X-Forwarded-Proto https HTTPS=on SSL=on
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/hipes.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/hipes.en.rst b/doc/plugins/hipes.en.rst
deleted file mode 100644
index 2651c67..0000000
--- a/doc/plugins/hipes.en.rst
+++ /dev/null
@@ -1,64 +0,0 @@
-HIPES system (undocumented)
-***************************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-This plugin implements the HIPES system.
-
-Configuration
-=============
-
-``server:<host>``
- Name of the server to send this request to
-
-``urlp:<name>``
- Default: ``url``
- Name of the query parameter for the service URL
-
-``path:<path>``
- Default: ``/``
- Path to use for the service URL
-
-``ssl``
- Default: ``no``
- Use SSL when connecting to the service
-
-``service``
- Service server, ``host[:port]``
-
-``server``
- Default: ``hipes.yimg.com``
- Name of HIPES server, ``host[:port]``
-
-``active_timeout``
- The active connection timeout in ms
-
-``no_activity_timeout``
- The no activity timeout in ms
-
-``connect_timeout``
- The connect timeout in ms
-
-``dns_timeout``
- The DNS timeout
-
-The timeout options override the server defaults (from
-```records.config`` <../../configuration-files/records.config>`_), and
-only apply to the connection to the specific "service" host.
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/index.en.rst b/doc/plugins/index.en.rst
deleted file mode 100644
index fd2a4dd..0000000
--- a/doc/plugins/index.en.rst
+++ /dev/null
@@ -1,75 +0,0 @@
-Plugin Reference
-****************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-Overview
-========
-
-One of the key features of Apache Traffic Server is modularity.
-Features that aren't needed in the core simply aren't there. This
-is a good thing, because it guarantees that our core can remain
-fast by concentrating on the things that we always provide: Caching
-and proxying.
-
-All other things can be moved into plugins, by opening up a consistent
-C API, everyone can implement their own functionality, without
-having to touch the core.
-
-Stable plugins
-==============
-
-Plugins that are considered stable are installed by default in
-Apache Traffic Server releases.
-
-.. toctree::
- :maxdepth: 1
-
- cacheurl.en
- conf_remap.en
- gzip.en
- header_filter.en
- regex_remap.en
- stats_over_http.en
-
-Experimental plugins
-====================
-
-Plugins that are considered experimental are located in the
-```plugins/experimental`` <https://git-wip-us.apache.org/repos/asf?p=trafficserver.git;a=tree;f=plugins/experimental;hb=HEAD>`_
-directory in the Apache Traffic Server source tree. Exmperimental plugins can be compiled by passing the
-`--enable-experimental-plugins` option to `configure`::
-
- $ autoconf -i
- $ ./configure --enable-experimental-plugins
- $ make
-
-.. toctree::
- :maxdepth: 1
-
- balancer.en
- buffer_upload.en
- cacheurl.en
- combo_handler.en
- esi.en
- geoip_acl.en
- hipes.en
- metafilter.en
- mysql_remap.en
- stale_while_revalidate.en
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/metafilter.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/metafilter.en.rst b/doc/plugins/metafilter.en.rst
deleted file mode 100644
index 7c75157..0000000
--- a/doc/plugins/metafilter.en.rst
+++ /dev/null
@@ -1,110 +0,0 @@
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information regarding
- copyright ownership. The ASF licenses this file to you under
- the Apache License, Version 2.0 (the "License"); you may not use
- this file except in compliance with the License. You may obtain
- a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an "AS
- IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
- express or implied. See the License for the specific language
- governing permissions and limitations under the License.
-
-Metalink plugin
-===============
-
-The `metalink` plugin implements the
-`Metalink <http://en.wikipedia.org/wiki/Metalink>`_
-protocol in order to try not to download the same file twice. This
-improves cache efficiency and speeds up user downloads.
-
-Take standard headers and knowledge about objects in the cache and
-potentially rewrite those headers so that a client will use a URL
-that is already cached instead of one that isn't.
-
-The `metalink` headers are specified in :rfc:`6429` and :rfc:`3230`
-and are sent by various download redirectors or content distribution
-networks.
-
-A lot of download sites distribute the same files from many different
-mirrors and users don't know which mirrors are already cached. These
-sites often present users with a simple download button, but the
-button doesn't predictably access the same mirror, or a mirror that
-is already cached. To users it seems like the download works sometimes
-(takes seconds) and not others (takes hours), which is frustrating.
-
-An extreme example of this happens when users share a limited,
-possibly unreliable internet connection, as is common in parts of
-Africa for example.
-
-How it works
-------------
-
-When the `metalink` plugin sees a response with a ``Location: ...`` header and a
-``Digest: SHA-256=...`` header, it checks to see if the URL in the Location
-header is already cached. If it isn't, then it tries to find a URL
-that is cached to use instead. It looks in the cache for some object
-that matches the digest in the Digest header and if it finds
-something, then it rewites the ``Location`` header with the URL from
-that object.
-
-That way a client should get sent to a URL that's already cached
-and the user won't end up downloading the file again.
-
-Installation
-------------
-
-`metalink` is a global plugin. It is enabled by adding it to your
-:file:`plugins.config` file. There are no options.
-
-Implementation Status
----------------------
-
-The `metalink` plugin implements the ``TS_HTTP_SEND_RESPONSE_HDR_HOOK``
-hook to check and potentially rewrite the ``Location: ...`` and
-``Digest: SHA-256=...`` headers after responses are cached. It
-doesn't do it before they're cached because the contents of the
-cache can change after responses are cached. It uses :c:func:`TSCacheRead`
-to check if the URL in the ``Location: ...`` header is already
-cached. In future, the plugin should also check if the URL is fresh
-or not.
-
-The plugin implements ``TS_HTTP_READ_RESPONSE_HDR_HOOK`` and a null
-transform to compute the SHA-256 digest for content as it's added
-to the cache, then uses :c:func:`TSCacheWrite` to associate the
-digest with the request URL. This adds a new cache object where the
-key is the digest and the object is the request URL.
-
-To check if the cache already contains content that matches a digest,
-the plugin must call :c:func:`TSCacheRead` with the digest as the
-key, read the URL stored in the resultant object, and then call
-:c:func:`TSCacheRead` again with this URL as the key. This is
-probably inefficient and should be improved.
-
-An early version of the plugin scanned ``Link: <...>; rel=duplicate``
-headers. If the URL in the ``Location: ...`` header was not already
-cached, it scanned ``Link: <...>; rel=duplicate`` headers for a URL
-that was. The ``Digest: SHA-256=...`` header is superior because it
-will find content that already exists in the cache in every case
-that a ``Link: <...>; rel=duplicate`` header would, plus in cases
-where the URL is not listed among the ``Link: <...>; rel=duplicate``
-headers, maybe because the content was downloaded from a URL not
-participating in the content distribution network, or maybe because
-there are too many mirrors to list in ``Link: <...>; rel=duplicate``
-headers.
-
-The ``Digest: SHA-256=...`` header is also more efficient than ``Link:
-<...>; rel=duplicate`` headers because it involves a constant number
-of cache lookups. :rfc:`6249` requires a ``Digest: SHA-256=...`` header
-or ``Link: <...>; rel=duplicate`` headers MUST be ignored:
-
- If Instance Digests are not provided by the Metalink servers, the
- Link header fields pertaining to this specification MUST be ignored.
-
- Metalinks contain whole file hashes as described in Section 6,
- and MUST include SHA-256, as specified in [FIPS-180-3].
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/mysql_remap.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/mysql_remap.en.rst b/doc/plugins/mysql_remap.en.rst
deleted file mode 100644
index 6e7957e..0000000
--- a/doc/plugins/mysql_remap.en.rst
+++ /dev/null
@@ -1,83 +0,0 @@
-MySQL Remap Plugin
-******************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-This is a basic plugin for doing dynamic "remaps" from a database. It
-essentially rewrites the incoming request's Host header / origin server
-connection to one retrieved from a database.
-
-The generic proxying setup is the following::
-
- UA ----> Traffic Server ----> Origin Server
-
-Without the plugin a request like::
-
- GET /path/to/something HTTP/1.1
- Host: original.host.com
-
-Ends up requesting ``http://original.host.com/path/to/something``
-
-With this plugin enabled, you can easily change that to anywhere you
-desire. Imagine the many possibilities....
-
-We have benchmarked the plugin with ab at about 9200 requests/sec (1.7k
-object) on a commodity hardware with a local setup of both, MySQL and
-Traffic Server local. Real performance is likely to be substantially
-higher, up to the MySQL's max queries / second.
-
-Installation
-============
-
-This plugin is only built if the configure option ::
-
- --enable-experimental-plugins
-
-is given at build time.
-
-Configuration
-=============
-
-Import the default schema to a database you create::
-
- mysql -u root -p -e "CREATE DATABASE mysql_remap;" # create a new database
- mysql -u root -p mysql_remap < schema/import.sql # import the provided schema
-
-insert some interesting values in mysql_remap.hostname &
-mysql_remap.map
-
-Traffic Server plugin configuration is done inside a global
-configuration file: ``/etc/trafficserver/plugin.config``::
-
- mysql_remap.so /etc/trafficserver/mysql_remap.ini
-
-The INI file should contain the following values::
-
- [mysql_remap]
- mysql_host = localhost #default
- mysql_port = 3306 #default
- mysql_username = remap_user
- mysql_password =
- mysql_database = mysql_remap #default
-
-To debug errors, start trafficserver manually using::
-
- traffic_server -T "mysql_remap"
-
-And resolve any errors or warnings displayed.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/regex_remap.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/regex_remap.en.rst b/doc/plugins/regex_remap.en.rst
deleted file mode 100644
index a98107b..0000000
--- a/doc/plugins/regex_remap.en.rst
+++ /dev/null
@@ -1,131 +0,0 @@
-Regex Remap Plugin
-******************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-This allows you to configure mapping rules based on regular expressions.
-This is similar to what you can accomplish using mod_rewrite in Apache
-httpd, but obviously not as flexible or sophisticated (yet).
-
-To use this plugin, configure a remap.config rule like ::
-
- map http://a.com http://b.com @plugin=regex_remap.so @pparam=maps.reg
-
-The parameter with the file name is always required, and the regular
-expressions within are evaluated sequentially from the first to the
-last. When a regular expression is positively matched against a request
-URL, evaluation is stopped and the rewrite rule is applied. If none of
-the regular expressions are a match, the default destination URL is
-applied (``http://b.com`` in the example above).
-
-An optional argument (``@pparam``) with the string "``profile``\ " will
-enable profiling of this regex remap rule, e.g. ::
-
- ... @pparam=maps.reg @pparam=profile
-
-Profiling is very low overhead, and the information is dumped to
-``traffic.out``, located in the log directory. This information is
-useful to optimize the order of your regular expression, such that the
-most common matches appears early in the file. In order to force a
-profile dump, you can do ::
-
- $ sudo touch remap.config
- $ sudo traffic_line -x
-
-By default, only the path and query string of the URL are provided for
-the regular expressions to match. The following optional parameters can
-be used to modify the plugin instance behavior ::
-
- @pparam=[no-]method [default: off]
- @pparam=[no-]query-string [default: on]
- @pparam=[no-]matrix-parameters [default: off]
-
-If you wish to match on the HTTP method used (e.g. "``GET``\ "),
-you must use the option ``@pparam=method``. e.g. ::
-
- ... @pparam=maps.reg @pparam=method
-
-With this enabled, the string that you will need to match will look
-like ::
-
- GET/path?query=bar
-
-
-The methods are always all upper-case, and always followed by one single
-space. There is no space between the method and the rest of the URL (or
-URI path).
-
-By default, the query string is part of the string that is matched
-again, to turn this off use the option 'no-query-string', e.g. ::
-
- ... @pparam=maps.reg @pparam=no-query-string
-
-Finally, you can also include the matrix parameters in the string, using
-the option 'matrix-parameters', e.g. ::
-
- ... @pparam=maps.reg @pparam=matrix-parameters
-
-The config file (``maps.reg`` above) can be placed anywhere, but unless
-you specify an absolute path (as above), it will default to ::
-
- /usr/local/etc/regex_remap
-
-A typical regex would look like ::
-
- ^/(ogre.*)/more http://www.ogre.com/$h/$0/$1
-
-The regular expression must not contain any white spaces!
-
-When the regular expression is matched, only the URL path + query string
-is matched (without any of the optional configuration options). The path
-will always start with a "/". Various substitution strings are allowed
-on the right hand side during evaluation ::
-
- $0 - The entire matched string
- $1-9 - Regular expression groups ($1 first group etc.)
- $h - The original host header from the request
- $f - The host as used in the "from" portion of the remap rule
- $t - The host as used in the "to" portion of the remap rule
- $p - The original port number
- $s - The scheme (e.g. http) of the request
- $P - The entire path of the request
- $q - The query part of the request
- $r - The path parameters of the request (not implemented yet)
- $c - The cookie string from the request
- $i - The client IP for this request
-
-You can also provide options, similar to how you configure your
-remap.config. The following options are available ::
-
- @status=<nnn> - Force the response code to <nnn>
- @active_timeout=<nnn> - Active timeout (in ms)
- @no_activity_timeout=<nnn> - No activity timeout (in ms)
- @connect_timeout=<nnn> - Connect timeouts (in ms)
- @dns_timeout=<nnn> - Connect timeouts (in ms)
-
-This can be useful to force a particular response for some URLs, e.g. ::
-
- ^/(ogre.*)/bad http://www.examle.com/ @status=404
-
-Or, to force a 302 redirect ::
-
- ^/oldurl/(.*)$ http://news.example.com/new/$1 @status=302
-
-Setting the status to 301 or 302 will force the new URL to be used
-as a redirect (Location:).
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/stale_while_revalidate.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/stale_while_revalidate.en.rst b/doc/plugins/stale_while_revalidate.en.rst
deleted file mode 100644
index 0a59c90..0000000
--- a/doc/plugins/stale_while_revalidate.en.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-Stale While Revalidate Plugin (undocumented)
-********************************************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-refresh content asynchronously while serving stale data
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/plugins/stats_over_http.en.rst
----------------------------------------------------------------------
diff --git a/doc/plugins/stats_over_http.en.rst b/doc/plugins/stats_over_http.en.rst
deleted file mode 100644
index 39b69be..0000000
--- a/doc/plugins/stats_over_http.en.rst
+++ /dev/null
@@ -1,50 +0,0 @@
-Stats over HTTP Plugin
-**********************
-
-.. Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-
-This plugin implements an HTTP interface to all Traffic Server statistics. The
-metrics returned are in a JSON format, for easy processing. This plugin is now
-part of the standard ATS build process, and should be available after install.
-
-To enable this plugin, add to the plugin.conf file::
-
- stats_over_http.so
-
-
-After starting Traffic Server, the JSON metrics are now available on the
-default URL::
-
- http://host:port/_stats
-
-
-where host and port is the hostname/IP and port number of the server. You can
-optionally modify the path to use, and this is highly recommended in a public
-facing server. For example::
-
- stats_over_http.so 81c075bc0cca1435ea899ba4ad72766b
-
-
-and the URL would then be e.g.::
-
- https://host:port/81c075bc0cca1435ea899ba4ad72766b
-
-
-This is weak security at best, since the secret could possibly leak if you are
-careless and send it over clear text.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/api/TSAPI.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSAPI.en.rst b/doc/reference/api/TSAPI.en.rst
new file mode 100644
index 0000000..d2ab1b2
--- /dev/null
+++ b/doc/reference/api/TSAPI.en.rst
@@ -0,0 +1,143 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+.. default-domain:: c
+
+=======
+`TSAPI`
+=======
+
+Synopsis
+========
+| `#include <ts/ts.h>`
+| `#include <ts/remap.h>`
+
+Description
+===========
+The Apache Traffic Server API enables you to create plugins, using
+the C programming language, that customize the behavior of your
+Traffic Server installation.
+
+Traffic Server enables sophisticated caching and processing of
+web-related traffic, such as DNS and HTTP requests and responses.
+Traffic Server itself consists of an event-driven loop that can be
+simplified as follows::
+
+ for (;;) {
+ event = get_next_event();
+ handle_event (event);
+ }
+
+You compile your plugin source code to create a shared library that
+Traffic Server loads when it is started. Your plugin contains
+callback functions that are registered for specific Traffic Server
+events. When Traffic Server needs to process an event, it invokes
+any and all call-back functions you've registered for that event
+type.
+
+Possible uses for plugins include the following:
+
+* HTTP processing plugins can filter, blacklist, authorize users or transform content.
+* Protocol plugins can enable Traffic Server to proxy-cache new protocol content.
+* A blacklisting plugin denies attempts to access web sites that are off-limits.
+* Append transform plugins add data to HTTP response content.
+* An image conversion plugin transforms JPEG images to GIF images.
+* Compression plugins send response content to a compression server
+ that compresses the data (alternatively, a compression library local
+ to the Traffic Server host machine could do the compression).
+* Authorization plugins check a user's permissions to access
+ particular web sites. The plugin could consult a local authorization
+ program or send queries to an authorization server.
+* A plugin that gathers client information from request headers
+ and enters this information in a database.
+* A protocol plugin listen for specific protocol requests on a
+ designated port and then uses Traffic Server's proxy server and
+ cache to serve client requests.
+
+Naming conventions
+==================
+
+The Traffic Server API adheres to the following naming conventions:
+
+* The TS prefix is used for all function and variable names defined
+ in the Traffic Server API. For example, :data:`TS_EVENT_NONE`, :type:`TSMutex`,
+ and :func:`TSContCreate`.
+* Enumerated values are always written in all uppercase letters.
+ For example, :data:`TS_EVENT_NONE` and :data:`TS_VC_CLOSE_ABORT`.
+* Constant values are all uppercase; enumerated values can be seen
+ as a subset of constants. For example, :data:`TS_URL_SCHEME_FILE` and
+ :data:`TS_MIME_FIELD_ACCEPT`.
+* The names of defined types are mixed-case. For example, :type:`TSHttpSsn`
+ and :func:`TSHttpTxn`. :func:`TSDebug`
+* Function names are mixed-case. For example, :func:`TSUrlCreate`
+ and :func:`TSContDestroy`.
+* Function names use the following subject-verb naming style:
+ TS-<subject>-<verb>, where <subject> goes from general to specific.
+ This makes it easier to determine what a function does by reading
+ its name. For example, the function to retrieve the password field
+ (the specific subject) from a URL (the general subject) is
+ :func:`TSUrlPasswordGet`.
+* Common verbs like Create, Destroy, Get, Set, Copy, Find, Retrieve,
+ Insert, Remove, and Delete are used only when appropriate.
+
+Plugin loading and configuration
+================================
+
+When Traffic Server is first started, it consults the plugin.config
+file to determine the names of all shared plugin libraries that
+need to be loaded. The plugin.config file also defines arguments
+that are to be passed to each plugin's initialization function,
+:func:`TSPluginInit`. The :file:`records.config` file defines the path to
+each plugin shared library.
+
+The sample :file:`plugin.config` file below contains a comment line, a blank
+line, and two plugin configurations::
+
+ # This is a comment line.
+ my-plugin.so www.junk.com www.trash.com www.garbage.com
+ some-plugin.so arg1 arg2 $proxy.config.http.cache.on
+
+Each plugin configuration in the :file:`plugin.config` file resembles
+a UNIX or DOS shell command; each line in :file:`plugin.config`
+cannot exceed 1023 characters.
+
+The first plugin configuration is for a plugin named my-plugin.so.
+It contains three arguments that are to be passed to that plugin's
+initialization routine. The second configuration is for a plugin
+named some-plugin.so; it contains three arguments. The last argument,
+$proxy.config.http.cache.on, is actually a configuration variable.
+Traffic Server will look up the specified configuration variable
+and substitute its value.
+
+Plugins are loaded and initialized by Traffic Server in the order
+they appear in the :file:`plugin.config` file.
+
+Plugin initialization
+=====================
+
+Each plugin must define an initialization function named
+:func:`TSPluginInit` that Traffic Server invokes when the
+plugin is loaded. :func:`TSPluginInit` is commonly used to
+read configuration information and register hooks for event
+notification.
+
+Files
+=====
+:file:`{CONFIG_DIR}/plugin.config`, :file:`{CONFIG_DIR}/records.config`
+
+See also
+========
+:manpage:`TSPluginInit(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/api/TSDebug.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSDebug.en.rst b/doc/reference/api/TSDebug.en.rst
new file mode 100644
index 0000000..6471fa5
--- /dev/null
+++ b/doc/reference/api/TSDebug.en.rst
@@ -0,0 +1,83 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+.. default-domain:: c
+
+==========
+`TSDebug`
+==========
+
+Library
+=======
+Apache Traffic Server plugin API
+
+Synopsis
+========
+`#include <ts/ts.h>`
+
+.. function:: void TSDebug(const char * tag, const char * format, ...)
+.. function:: void TSError(const char * tag, const char * format, ...)
+.. function:: int TSIsDebugTagSet(const char * tag)
+.. function:: void TSDebugSpecific(int debug_flag, const char * tag, const char * format, ...)
+.. function:: void TSHttpTxnDebugSet(TSHttpTxn txnp, int on)
+.. function:: void TSHttpSsnDebugSet(TSHttpSsn ssn, int on)
+.. function:: int TSHttpTxnDebugGet(TSHttpTxn txnp)
+.. function:: int TSHttpSsnDebugGet(TSHttpSsn ssn)
+.. macro:: void TSAssert(expression)
+.. macro:: void TSReleaseAssert(expression)
+
+Description
+===========
+
+:func:`TSError` is similar to :func:`printf` except that instead
+of writing the output to the C standard output, it writes output
+to the Traffic Server error log.
+
+:func:`TSDebug` is the same as :func:`TSError` except that it only
+logs the debug message if the given debug tag is enabled. It writes
+output to the Traffic Server debug log.
+
+:func:`TSIsDebugTagSet` returns non-zero if the given debug tag is
+enabled.
+
+In debug mode, :macro:`TSAssert` Traffic Server to prints the file
+name, line number and expression, and then aborts. In release mode,
+the expression is not removed but the effects of printing an error
+message and aborting are. :macro:`TSReleaseAssert` prints an error
+message and aborts in both release and debug mode.
+
+:func:`TSDebugSpecific` emits a debug line even if the debug tag
+is turned off, as long as debug flag is enabled. This can be used
+in conjuction with :func:`TSHttpTxnDebugSet`, :func:`TSHttpSsnDebugSet`,
+:func:`TSHttpTxnDebugGet` and :func:`TSHttpSsnDebugGet` to enable
+debugging on specific session and transaction objects.
+
+Examples
+========
+
+This example uses :func:`TSDebugSpecific` to log a message when a specific
+debugging flag is enabled::
+
+ #include <ts/ts.h>
+
+ // Emit debug message if "tag" is enabled or the txn debug
+ // flag is set.
+ TSDebugSpecifc(TSHttpTxnDebugGet(txn), "tag" ,
+ "Hello World from transaction %p", txn);
+
+SEE ALSO
+========
+:manpage:`TSAPI(3ts)`, :manpage:`printf(3)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/api/TSHttpHookAdd.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpHookAdd.en.rst b/doc/reference/api/TSHttpHookAdd.en.rst
new file mode 100644
index 0000000..d791db5
--- /dev/null
+++ b/doc/reference/api/TSHttpHookAdd.en.rst
@@ -0,0 +1,120 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+.. default-domain:: c
+
+===============
+`TSHttpHookAdd`
+===============
+
+Library
+=======
+Apache Traffic Server plugin API
+
+Synopsis
+========
+`#include <ts/ts.h>`
+
+.. function:: void TSHttpHookAdd(TSHttpHookID id, TSCont contp)
+.. function:: void TSHttpSsnHookAdd(TSHttpSsn ssnp, TSHttpHookID id, TSCont contp)
+.. function:: void TSHttpTxnHookAdd(TSHttpTxn txnp, TSHttpHookID id, TSCont contp)
+
+Description
+===========
+
+Hooks are points in Apache Traffic Server transaction HTTP processing
+where plugins can step in and do some work. Registering a plugin
+function for callback amounts to adding the function to a hook. You
+can register your plugin to be called back for every single
+transaction, or for specific transactions only.
+
+HTTP transaction hooks are set on a global basis using the function
+:func:`TSHttpHookAdd`. This means that the continuation specified
+as the parameter to :func:`TSHttpHookAdd` is called for every
+transaction. :func:`TSHttpHookAdd` is typically called from
+:func:`TSPluginInit` or :func:`TSRemapInit`.
+
+A session consists of a single client connection to Traffic Server.
+A session can consist of several transactions in succession. The
+session starts when the client connection opens, and ends when the
+connection closes. :func:`TSHttpSsnHookAdd` adds :data:`contp` to
+the end of the list of HTTP transaction hooks specified by :data:`id`.
+This means that :data:`contp` is called back for every transaction
+within the session, at the point specified by the hook ID. Since
+:data:`contp` is added to a session, it is not possible to call
+:func:`TSHttpSsnHookAdd` from the plugin initialization routine;
+the plugin needs a handle to an HTTP session.
+
+A transaction consists of a single HTTP request from a client and
+the response that Traffic Server sends to that client. A transaction
+begins when Traffic Server receives a request, and ends when Traffic
+Server sends the response. :func:`TSHttpTxnHookAdd` adds :data:`contp`
+to the end of the list of HTTP transaction hooks specified by
+:data:`id`. Since :data:`contp` is added to a transaction, it is
+not possible to call :func:`TSHttpTxnHookAdd` from the plugin
+initialization routine but only when the plugin has a handle to an
+HTTP transaction.
+
+Return values
+=============
+
+None. Adding hooks is always successful.
+
+Examples
+========
+
+The following example demonstrates how to add global, session and
+transaction hooks::
+
+ #include <ts/ts.h>
+
+ static int
+ handler(TSCont contp, TSEvent event, void *edata)
+ {
+ TSHttpSsn ssnp;
+ TSHttpTxn txnp;
+
+ switch (event){
+ case TS_EVENT_HTTP_SSN_START:
+ ssnp = (TSHttpSsn) edata;
+ // Add a session hook ...
+ TSHttpSsnHookAdd(ssnp, TS_HTTP_TXN_START_HOOK, contp);
+ TSHttpSsnReenable(ssnp, TS_EVENT_HTTP_CONTINUE);
+ return 0;
+ case TS_EVENT_HTTP_TXN_START:
+ txnp = (TSHttpTxn) edata;
+ // Add a transaction hook ...
+ TSHttpTxnHookAdd(ssnp, TS_HTTP_READ_REQUEST_HDR_HOOK, contp);
+ TSHttpTxnReenable(txnp, TS_EVENT_HTTP_CONTINUE);
+ return 0;
+ default:
+ break;
+ }
+
+ return 0;
+ }
+
+ void
+ TSPluginInit (int argc, const char *argv[])
+ {
+ TSCont contp;
+ contp = TSContCreate(handler, NULL);
+ TSHttpHookAdd(TS_HTTP_SSN_START_HOOK, contp);
+ }
+
+SEE ALSO
+========
+:manpage:`TSAPI(3ts)`, :manpage:`TSContCreate(3ts)`
[4/7] docs: split reference material into top-level pages
Posted by jp...@apache.org.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/api/TSHttpParserCreate.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpParserCreate.en.rst b/doc/reference/api/TSHttpParserCreate.en.rst
new file mode 100644
index 0000000..faa0a70
--- /dev/null
+++ b/doc/reference/api/TSHttpParserCreate.en.rst
@@ -0,0 +1,91 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+
+.. default-domain:: c
+
+===================
+TSHttpParserCreate
+===================
+
+Library
+=======
+
+Apache Traffic Server plugin API
+
+Synopsis
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSHttpParser TSHttpParserCreate(void)
+.. function:: void TSHttpParserClear(TSHttpParser parser)
+.. function:: void TSHttpParserDestroy(TSHttpParser parser)
+.. function:: TSParseResult TSHttpHdrParseReq(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)
+.. function:: TSParseResult TSHttpHdrParseResp(TSHttpParser parser, TSMBuffer bufp, TSMLoc offset, const char ** start, const char * end)
+
+Description
+===========
+
+:func:`TSHttpParserCreate` creates an HTTP parser object. The
+parser's data structure contains information about the header being
+parsed. A single HTTP parser can be used multiple times, though not
+simultaneously. Before being used again, the parser must be cleared
+by calling :func:`TSHttpParserClear`.
+
+:func:`TSHttpHdrParseReq` parses an HTTP request header. The HTTP
+header :data:`offset` must already be created, and must reside
+inside the marshal buffer :data:`bufp`. The :data:`start` argument
+points to the current position of the string buffer being parsed
+and the :data:`end` argument points to one byte after the end of
+the buffer to be parsed. On return, :data:`start` is modified to
+point past the last character parsed.
+
+It is possible to parse an HTTP request header a single byte at a
+time using repeated calls to :func:`TSHttpHdrParseReq`. As long as
+an error does not occur, the :func:`TSHttpHdrParseReq` function
+will consume that single byte and ask for more. :func:`TSHttpHdrParseReq`
+should be called after :data:`TS_HTTP_READ_REQUEST_HDR_HOOK`.
+
+:func:`TSHttpHdrParseResp` operates in the same manner as
+:func:`TSHttpHdrParseReq` except it parses an HTTP response header.
+It should be called after :data:`TS_HTTP_READ_RESPONSE_HDR_HOOK`.
+
+:func:`TSHttpParserClear` clears the specified HTTP parser so it
+may be used again.
+
+:func:`TSHttpParserDestroy` destroys the TSHttpParser object pointed
+to by :data:`parser`. The :data:`parser` pointer must not be NULL.
+
+Return values
+=============
+
+:func:`TSHttpHdrParseReq` and :func:`TSHttpHdrParseResp` both return
+a :type:`TSParseResult` value. :data:`TS_PARSE_ERROR` is returned
+on error, :data:`TS_PARSE_CONT` is returned if parsing of the header
+stopped because the end of the buffer was reached, and
+:data:`TS_PARSE_DONE` or :data:`TS_PARSE_OK` when a \\r\\n\\r\\n
+pattern is encountered, indicating the end of the header.
+
+Bugs
+====
+
+The distinction between the :data:`TS_PARSE_DONE` and :data:`TS_PARSE_OK`
+results is not well-defined. Plugins should expect both status codes and
+treat them equivalently.
+
+See also
+========
+:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/TSHttpTxnMilestoneGet.en.rst b/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
new file mode 100644
index 0000000..993d712
--- /dev/null
+++ b/doc/reference/api/TSHttpTxnMilestoneGet.en.rst
@@ -0,0 +1,76 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+
+.. default-domain:: c
+
+=====================
+TSHttpTxnMilestoneGet
+=====================
+
+LIBRARY
+=======
+
+Apache Traffic Server plugin API
+
+SYNOPSIS
+========
+
+`#include <ts/ts.h>`
+
+.. function:: TSReturnCode TSHttpTxnMilestoneGet(TSHttpTxn txnp, TSMilestonesType milestone, TSHRTime * time)
+
+DESCRIPTION
+===========
+
+:func:`TSHttpTxnMilestoneGet` will fetch a specific milestone timer
+value for the current request. These timers are calculated during
+the lifetime of a transaction, and are all in :type:`TSHRTime` units
+(nanoseconds), measured from the beginning of the transaction. The
+:data:`time` argument is a pointer to a valid :type:`TSHRtime`
+storage, and is set upon success.
+
+The supported :type:`TSMilestonesType` milestone types are:
+
+|
+|
+| :data:`TS_MILESTONE_UA_BEGIN`
+| :data:`TS_MILESTONE_UA_READ_HEADER_DONE`
+| :data:`TS_MILESTONE_UA_BEGIN_WRITE`
+| :data:`TS_MILESTONE_UA_CLOSE`
+| :data:`TS_MILESTONE_SERVER_FIRST_CONNECT`
+| :data:`TS_MILESTONE_SERVER_CONNECT`
+| :data:`TS_MILESTONE_SERVER_CONNECT_END`
+| :data:`TS_MILESTONE_SERVER_BEGIN_WRITE`
+| :data:`TS_MILESTONE_SERVER_FIRST_READ`
+| :data:`TS_MILESTONE_SERVER_READ_HEADER_DONE`
+| :data:`TS_MILESTONE_SERVER_CLOSE`
+| :data:`TS_MILESTONE_CACHE_OPEN_READ_BEGIN`
+| :data:`TS_MILESTONE_CACHE_OPEN_READ_END`
+| :data:`TS_MILESTONE_CACHE_OPEN_WRITE_BEGIN`
+| :data:`TS_MILESTONE_CACHE_OPEN_WRITE_END`
+| :data:`TS_MILESTONE_DNS_LOOKUP_BEGIN`
+| :data:`TS_MILESTONE_DNS_LOOKUP_END`
+| :data:`TS_MILESTONE_SM_START`
+| :data:`TS_MILESTONE_SM_FINISH`
+| :data:`TS_MILESTONE_LAST_ENTRY`
+
+RETURN VALUES
+=============
+
+:data:`TS_SUCCESS` or :data:`TS_ERROR`.
+
+SEE ALSO
+========
+:manpage:`TSAPI(3ts)`
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/api/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/api/index.en.rst b/doc/reference/api/index.en.rst
new file mode 100644
index 0000000..dcd34b3
--- /dev/null
+++ b/doc/reference/api/index.en.rst
@@ -0,0 +1,28 @@
+API Reference
+*************
+
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+.. toctree::
+ :maxdepth: 2
+
+ TSAPI.en
+ TSDebug.en
+ TSHttpHookAdd.en
+ TSHttpParserCreate.en
+ TSHttpTxnMilestoneGet.en
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/index.en.rst b/doc/reference/commands/index.en.rst
new file mode 100644
index 0000000..460f0fc
--- /dev/null
+++ b/doc/reference/commands/index.en.rst
@@ -0,0 +1,35 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+Command Reference
+=================
+
+.. toctree::
+ :maxdepth: 1
+
+ traffic_cop.en
+ traffic_line.en
+ traffic_logcat.en
+ traffic_logstats.en
+ traffic_manager.en
+ traffic_server.en
+ traffic_shell.en
+ tspush.en
+ tstop.en
+ tsxs.en
+
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_cop.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_cop.en.rst b/doc/reference/commands/traffic_cop.en.rst
new file mode 100644
index 0000000..366e292
--- /dev/null
+++ b/doc/reference/commands/traffic_cop.en.rst
@@ -0,0 +1,35 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+===========
+traffic_cop
+===========
+
+.. program:: traffic_cop
+
+Description
+===========
+
+.. option:: -stop
+
+ Kill children using ``SIGSTOP`` instead of ``SIGKILL``
+
+.. option:: -V
+
+ Print version information and exit.
+
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_line.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_line.en.rst b/doc/reference/commands/traffic_line.en.rst
new file mode 100644
index 0000000..11ad134
--- /dev/null
+++ b/doc/reference/commands/traffic_line.en.rst
@@ -0,0 +1,63 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+============
+traffic_line
+============
+
+.. program:: traffic_line
+
+Description
+===========
+
+.. option:: -q, --query_deadhosts
+
+.. option:: -r VAR, --read_var VAR
+
+.. option:: -s VAR, --set_var VAR
+
+.. option:: -v VALUE, --value VALUE
+
+.. option:: -x, --reread_config
+
+.. option:: -M, --restart_cluster
+
+.. option:: -L, --restart_local
+
+.. option:: -S, --shutdown
+
+.. option:: -U, --startup
+
+.. option:: -B, --bounce_cluster
+
+.. option:: -b, --bounce_local
+
+.. option:: -C, --clean_cluster
+
+.. option:: -c, --clear_node
+
+.. option:: -Z, --zero_cluster
+
+.. option:: -z, --zero_node
+
+.. option:: -h, --help
+
+ Print usage information and exit.
+
+.. option:: -V, --version
+
+ Print version information and exit.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_logcat.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_logcat.en.rst b/doc/reference/commands/traffic_logcat.en.rst
new file mode 100644
index 0000000..02f8575
--- /dev/null
+++ b/doc/reference/commands/traffic_logcat.en.rst
@@ -0,0 +1,53 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+==============
+traffic_logcat
+==============
+
+.. program:: traffic_logcat
+
+Description
+===========
+
+.. option:: -o PATH, --output_file PATH
+
+.. option:: -a, --auto_filename
+
+.. option:: -f, --follow
+
+.. option:: -C, --clf
+
+.. option:: -E, --elf
+
+.. option:: -S, --squid
+
+.. option:: -2, --elf2
+
+.. option:: -T, --debug_tags
+
+.. option:: -w, --overwrite_output
+
+.. option:: -h, --help
+
+ Print usage information and exit.
+
+.. option:: -V, --version
+
+ Print version information and exit.
+
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_logstats.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_logstats.en.rst b/doc/reference/commands/traffic_logstats.en.rst
new file mode 100644
index 0000000..2f59825
--- /dev/null
+++ b/doc/reference/commands/traffic_logstats.en.rst
@@ -0,0 +1,68 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+================
+traffic_logstats
+================
+
+.. program:: traffic_logstats
+
+Description
+===========
+
+.. option:: -f FILE, --log_file FILE
+
+.. option:: -o LIST, --origin_list LIST
+
+.. option:: -O FILE, --origin_file FILE
+
+.. option:: -M COUNT, --max_origins COUNT
+
+.. option:: -u COUNT, --urls COUNT
+
+.. option:: -U COUNT, --show_urls COUNT
+
+.. option:: --A, --as_object
+
+.. option:: -i, --incremental
+
+.. option:: -S FILE, --statetag FILE
+
+.. option:: -t, --tail
+
+.. option:: -s, --summary
+
+.. option:: -j, --json
+
+.. option:: -c, --cgi
+
+.. option:: -m, --min_hits
+
+.. option:: -a, --max_age
+
+.. option:: -l COUNT, --line_len COUNT
+
+.. option:: -T TAGS, --debug_tags TAGS
+
+.. option:: -h, --help
+
+ Print usage information and exit.
+
+.. option:: -V, --version
+
+ Print version information and exit.
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_manager.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_manager.en.rst b/doc/reference/commands/traffic_manager.en.rst
new file mode 100644
index 0000000..f602b2a
--- /dev/null
+++ b/doc/reference/commands/traffic_manager.en.rst
@@ -0,0 +1,50 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+===============
+traffic_manager
+===============
+
+.. program:: traffic_manager
+
+Description
+===========
+
+.. option:: proxyOff
+.. option:: -nosyslog
+.. option:: -aconfPort PORT
+.. option:: -clusterMCPort PORT
+.. option:: -groupAddr ADDRESS
+.. option:: -clusterRSPort PORT
+.. option:: -debug TAGS
+.. option:: -action TAGS
+.. option:: -path FILE
+.. option:: -recordsConf FILE
+.. option:: -tsArgs ARGUMENTS
+.. option:: -proxyPort PORT
+.. option:: -proxyBackDoor PORT
+.. option:: -schema FILE
+.. option:: -version
+
+Environment
+===========
+
+.. envvar:: MGMT_ACONF_PORT
+.. envvar:: MGMT_CLUSTER_MC_PORT
+.. envvar:: MGMT_CLUSTER_RS_PORT
+.. envvar:: MGMT_GROUP_ADDR
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_server.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_server.en.rst b/doc/reference/commands/traffic_server.en.rst
new file mode 100644
index 0000000..ad3aa73
--- /dev/null
+++ b/doc/reference/commands/traffic_server.en.rst
@@ -0,0 +1,82 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+==============
+traffic_server
+==============
+
+.. program:: traffic_server
+
+Description
+===========
+
+.. option:: -n COUNT, --net_threads COUNT
+
+.. option:: -Z COUNT, --cluster_threads COUNT
+
+.. option:: -U COUNT, --udp_threads COUNT
+
+.. option:: -a, --accepts_thread
+
+.. option:: -b, --accept_till_done
+
+.. option:: -p PORT, --httpport PORT
+
+.. option:: -P PORT, --cluster_port PORT
+
+.. option:: -o LEVEL, --dprintf_level LEVEL
+
+.. option:: -R LEVEL, --regression LEVEL
+
+.. option:: -r TEST, --regression_rest TEST
+
+.. option:: -T TAGS, --debug_tags TAGS
+
+.. option:: -B TAGS, --action_tags TAGS
+
+.. option:: -i COUNT, --interval COUNT
+
+.. option:: -M, --remote_management
+
+.. option:: -d DIR, --management_dir DIR
+
+.. option:: -C CMD, --command CMD
+
+.. option:: -k, --clear_hostdb
+
+.. option:: -K, --clear_cache
+
+.. option:: -c CORE, --read_core CORE
+
+.. option:: --accept_mss MSS
+
+.. option:: -t SECS, --poll_timeout SECS
+
+.. option:: -h, --help
+
+ Print usage information and exit.
+
+.. option:: -V, --version
+
+ Print version information and exit.
+
+Environment
+===========
+
+.. envvar:: PROXY_REMOTE_MGMT
+
+.. envvar:: PROXY_AUTO_EXIT
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/traffic_shell.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/traffic_shell.en.rst b/doc/reference/commands/traffic_shell.en.rst
new file mode 100644
index 0000000..7a56fd0
--- /dev/null
+++ b/doc/reference/commands/traffic_shell.en.rst
@@ -0,0 +1,29 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+=============
+traffic_shell
+=============
+
+.. program:: traffic_shell
+
+Description
+===========
+
+.. option:: -V, --version
+
+ Print version information and exit.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/tspush.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/tspush.en.rst b/doc/reference/commands/tspush.en.rst
new file mode 100644
index 0000000..e32c517
--- /dev/null
+++ b/doc/reference/commands/tspush.en.rst
@@ -0,0 +1,36 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+======
+tspush
+======
+
+.. program:: tspush
+
+Description
+===========
+
+.. option:: -f FILE, --file FILE
+
+.. option:: -u URL, --url URL
+
+.. option:: -v, --verbose
+
+.. option:: -h, --help
+
+ Print usage information and exit.
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/tstop.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/tstop.en.rst b/doc/reference/commands/tstop.en.rst
new file mode 100644
index 0000000..bf1237d
--- /dev/null
+++ b/doc/reference/commands/tstop.en.rst
@@ -0,0 +1,29 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+=====
+tstop
+=====
+
+.. program:: tstop
+
+Description
+===========
+
+.. option:: -s COUNT
+
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/commands/tsxs.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/commands/tsxs.en.rst b/doc/reference/commands/tsxs.en.rst
new file mode 100644
index 0000000..f274e64
--- /dev/null
+++ b/doc/reference/commands/tsxs.en.rst
@@ -0,0 +1,49 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+====
+tsxs
+====
+
+.. program:: tsxs
+
+Description
+===========
+
+.. option:: -q VAR, --query VAR
+
+.. option:: -I PATH
+
+.. option:: -L PATH
+
+.. option:: -l LIB
+
+.. option:: -o FILE
+
+.. option:: -i
+
+.. option:: -c FILE [FILE ...]
+
+.. option:: -C FILE [FILE ...]
+
+.. option:: -v, --verbose
+
+.. option:: -h, --help
+
+ Print usage information and exit.
+
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/cache.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/cache.config.en.rst b/doc/reference/configuration/cache.config.en.rst
new file mode 100644
index 0000000..042a048
--- /dev/null
+++ b/doc/reference/configuration/cache.config.en.rst
@@ -0,0 +1,135 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+============
+cache.config
+============
+
+.. configfile:: cache.config
+
+The :file:`cache.config` file defines how Traffic Server caches web objects. You
+can add caching rules to specify the following: - Not to cache objects
+from specific IP addresses - How long to pin particular objects in the
+cache - How long to consider cached objects as fresh - Whether to ignore
+no-cache directives from the server
+
+.. important::
+
+ After you modify the :file:`cache.config file`, navigate to
+ the Traffic Server bin directory; then run the :option:`traffic_line -x`
+ command to apply changes. When you apply the changes to a node in a
+ cluster, Traffic Server automatically applies the changes to all other
+ nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`cache.config` file contains a caching rule. Traffic
+Server recognizes three space-delimited tags::
+
+ primary_destination=value secondary_specifier=value action=value
+
+You can use more than one secondary specifier in a rule. However, you
+cannot repeat a secondary specifier. The following list shows the
+possible primary destinations with allowed values.
+
+*``dest_domain``* {#dest_domain}
+ A requested domain name. Traffic Server matches the domain name of
+ the destination from the URL in the request.
+
+*``dest_host``* {#dest_host}
+ A requested hostname. Traffic Server matches the hostname of the
+ destination from the URL in the request.
+
+*``dest_ip``* {#dest_ip}
+ A requested IP address. Traffic Server matches the IP address of the
+ destination in the request.
+
+*``url_regex``* {#url_regex}
+ A regular expression (regex) to be found in a URL.
+
+The secondary specifiers are optional in the :file:`cache.config` file. The
+following list shows possible secondary specifiers with allowed values.
+
+*``port``* {#port}
+ A requested URL port.
+
+*``scheme``* {#scheme}
+ A request URL protocol: http or https.
+
+*``prefix``* {#prefix}
+ A prefix in the path part of a URL.
+
+*``suffix``* {#suffix}
+ A file suffix in the URL.
+
+*``method``* {#method}
+ A request URL method: get, put, post, trace.
+
+*``time``* {#time}
+ A time range, such as 08:00-14:00.
+
+*``src_ip``* {#src_ip}
+ A client IP address.
+
+The following list shows possible actions and their allowed values.
+
+*``action``* {#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.
+
+*``pin-in-cache``* {#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
+
+*``revalidate``* {#revalidate}
+ The amount of time object(s) are to be considered fresh. Use the
+ same time formats as ``pin-in-cache``.
+
+*``ttl-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 .
+
+Examples
+========
+
+The following example configures Traffic Server to revalidate ``gif``
+and ``jpeg`` objects in the domain ``mydomain.com`` every 6 hours, and
+all other objects in ``mydomain.com`` every hour. The rules are applied
+in the order listed.
+
+::
+
+ dest_domain=mydomain.com suffix=gif revalidate=6h
+ dest_domain=mydomain.com suffix=jpeg revalidate=6h
+ dest_domain=mydomain.com revalidate=1h
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/congestion.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/congestion.config.en.rst b/doc/reference/configuration/congestion.config.en.rst
new file mode 100644
index 0000000..391ca0f
--- /dev/null
+++ b/doc/reference/configuration/congestion.config.en.rst
@@ -0,0 +1,197 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+=================
+congestion.config
+=================
+
+.. configfile:: congestion.config
+
+The :file:`congestion.config` file enables you to configure Traffic Server
+to stop forwarding HTTP requests to origin servers when they become
+congested, and then send the client a message to retry the congested
+origin server later. After you modify the :file:`congestion.config` file,
+navigate to the Traffic Server bin directory; then run the
+:option:`traffic_line -x` command to apply changes. When you apply the changes
+to a node in a cluster, Traffic Server automatically applies the changes
+to all other nodes in the cluster. Traffic Server uses the
+:file:`congestion.config` file only if you enable the `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.
+
+Format
+======
+
+Each line in :file:`congestion.config` must follow the format below. Traffic
+Server applies the rules in the order listed, starting at the top of the
+file. Traffic Server recognizes three space-delimited tags::
+
+ primary_destination=value secondary_specifier=value action=value
+
+The following list shows possible primary destinations with allowed
+values.
+
+*``dest_domain``* {#dest_domain}
+ A requested domain name.
+
+*``dest_host``* {#dest_host}
+ A requested hostname.
+
+*``dest_ip``* {#dest_ip}
+ A requested IP address.
+
+*``url_regex``* {#url_regex}
+ 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.
+You can use more than one secondary specifier in a rule; however, you
+cannot repeat a secondary specifier.
+
+*``port``* {#port}
+ A requested URL port or range of ports.
+
+*``prefix``* {#prefix}
+ A prefix in the path part of a URL.
+
+The following list shows the possible tags and their allowed values.
+
+*``max_connection_failures``* {#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.
+
+*``fail_window``* {#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.
+
+*``proxy_retry_interval``* {#proxy_retry_interval}
+ Default: ``10`` seconds.
+ The number of seconds that Traffic Server waits before contacting a
+ congested origin server again.
+
+*``client_wait_interval``* {#client_wait_interval}
+ Default: ``300`` seconds.
+ The number of seconds that the client is advised to wait before
+ retrying the congested origin server.
+
+*``wait_interval_alpha``* {#wait_interval_alpha}
+ Default: ``30`` seconds
+ The upper limit for a random number that is added to the wait
+ interval.
+
+*``live_os_conn_timeout``* {#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.
+
+*``live_os_conn_retries``* {#live_os_conn_retries}
+ Default: ``2``
+ The maximum number of retries allowed to the live (uncongested)
+ origin server.
+
+*``dead_os_conn_timeout``* {#dead_os_conn_timeout}
+ Default: ``15`` secondsj
+ The connection timeout to the congested origin server.
+
+*``dead_os_conn_retries``* {#dead_os_conn_retries}
+ Default: ``1``
+ The maximum number of retries allowed to the congested origin
+ server.
+
+*``max_connection``* {#max_connection}
+ Default: ``-1``
+ The maximum number of connections allowed from Traffic Server to the
+ origin server.
+
+*``error_page``* {#error_page}
+ Default: ``"congestion#retryAfter"``
+ The error page sent to the client when a server is congested. You
+ must enclose the value in quotes;
+
+*:file:`congestion.config`* {#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.
+
+Examples
+========
+
+The following :file:`congestion.config` rule configures Traffic Server to
+stop forwarding requests to the server ``www.host.com`` on port 80 (HTTP
+traffic) if the server is congested, according to the timeouts
+specified. Traffic Server uses the default tag values because no tag has
+been specified.
+
+::
+
+ dest_host=www.host.com port=80
+
+You can use one or more tags in a rule, but each tag must have one value
+only. If you specify no tags in the rule, then Traffic Server uses the
+default values.
+
+You can override any of the default tag values by adding configuration
+variables at the end of :file:`records.config` as follows:
+
+::
+
+ CONFIG proxy.config.http.congestion_control.default.tag INT|STRING value
+
+where tag is one of the tags described in the list under
+:file:`congestion.config` and value is the value you
+want to use.
+
+For example::
+
+ CONFIG proxy.config.http.congestion_control.default.congestion_scheme STRING per_host
+
+.. important::
+
+ Rules in the :file:`congestion.config` file override the
+ following variables in the :file:`records.config` file:
+
+::
+
+ proxy.config.http.connect_attempts_max_retries
+ proxy.config.http.connect_attempts_max_retries_dead_server
+ proxy.config.http.connect_attempts_rr_retries
+ proxy.config.http.connect_attempts_timeout
+ proxy.config.http.down_server.cache_time
+ proxy.config.http.down_server.abort_threshold
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/hosting.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/hosting.config.en.rst b/doc/reference/configuration/hosting.config.en.rst
new file mode 100644
index 0000000..73cae87
--- /dev/null
+++ b/doc/reference/configuration/hosting.config.en.rst
@@ -0,0 +1,98 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+==============
+hosting.config
+==============
+
+.. configfile:: hosting.config
+
+The :file:`hosting.config` file enables you to assign cache partitions to
+specific 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 <../configuring-cache#PartitoningCache>`_.
+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 :file:`volume.config`
+file. For step-by-step instructions about partitioning your cache, refer
+to `Partitioning the Cache <../configuring-cache#PartitioningCache>`_.
+
+After you modify hosting.config, navigate to the Traffic Server bin
+directory and run :option:`traffic_line -x` to apply your changes.
+
+When you apply the changes to a node in a cluster, Traffic Server
+automatically applies the changes to all other nodes in the cluster.
+
+.. important::
+
+ The :file:`volume.config` configuration must be the same on all nodes in a cluster.
+
+Format
+======
+
+Each line in the :file:`hosting.config` file must have one of the following
+formats::
+
+ hostname=HOST partition=NUMBERS
+ domain=DOMAIN partition=NUMBERS
+
+where ``HOST`` is the fully-qualified hostname of the origin server
+whose content you want to store on a particular partition (for example,
+``www.myhost.com``); ``DOMAIN`` is the domain whose content you
+want to store on a particular partition(for example, ``mydomain.com``);
+and ``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
+file:`volume.config`.
+
+**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
+:file:`hosting.config` file cannot contain multiple entries
+for the same origin server or domain.
+
+Generic Partition
+=================
+
+When configuring the :file:`hosting.config` file, you must assign a generic
+partition to use for content that does not belong to any of the origin
+servers or domains listed. If all partitions for a particular origin
+server become corrupt, Traffic Server will also use the generic
+partition to store content for that origin server.
+
+The generic partition must have the following format::
+
+ hostname=* partition=NUMBERS
+
+where ``NUMBERS`` is a comma-separated list of generic
+partitions.
+
+Examples
+========
+
+The following example configures Traffic Server to store content from
+the domain ``mydomain.com`` in partition 1 and content from
+``www.myhost.com`` in partition 2. Traffic Server stores content from
+all other origin servers in partitions 3 and 4.
+
+::
+
+ domain=mydomain.com partition=1
+ hostname=www.myhost.com partition=2
+ hostname=* partition=3,4
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/icp.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/icp.config.en.rst b/doc/reference/configuration/icp.config.en.rst
new file mode 100644
index 0000000..877e459
--- /dev/null
+++ b/doc/reference/configuration/icp.config.en.rst
@@ -0,0 +1,104 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+==========
+icp.config
+==========
+
+.. configfile:: icp.config
+
+.. warning::
+
+ The Traffic Server ICP feature is not functional in this release.
+
+The :file:`icp.config` file defines ICP peers (parent and sibling caches).
+
+.. important::
+
+ After you modify the icp.config file, navigate to the
+ Traffic Server bin directory and run the :option:`traffic_line -x` command to
+ apply the changes. When you apply the changes to a node in a cluster,
+ Traffic Server automatically applies the changes to all other nodes in
+ the cluster.
+
+Format
+======
+
+Each line in the icp.config file contains the name and configuration
+information for a single ICP peer in the following format::
+
+ host : host_IP : peer_type : proxy_port : icp_port : MC_on : MC_IP : MC_TTL :
+
+Each field is described in the following list.
+
+*``host``* {#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.
+
+*``host_IP``* {#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.
+
+*``ctype``* {#ctype}
+ Use the following options:
+
+ - 1 to indicate an ICP parent cache
+ - 2 to indicate an ICP sibling cache
+
+*``proxy_port``* {#proxy_port}
+ The port number of the TCP port used by the ICP peer for proxy
+ communication.
+
+*``icp_port``* {#icp_port}
+ The port number of the UDP port used by the ICP peer for ICP
+ communication.
+
+*``MC_on``* {#mc_on}
+ Enable or disable MultiCast:
+
+ - 0 if multicast is disabled
+ - 1 if multicast is enabled
+
+*``MC_ip``* {#mc_ip}
+ The MultiCast IP address.
+
+*``MC_ttl``* {#mc_ttl}
+ The multicast time to live. Use the following options:
+
+ - 1 if IP multicast datagrams will not be forwarded beyond a single
+ subnetwork
+ - 2 to allow delivery of IP multicast datagrams to more than one
+ subnet (if there are one or more multicast routers attached to
+ the first hop subnet).
+
+Examples
+========
+
+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
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/index.en.rst b/doc/reference/configuration/index.en.rst
new file mode 100644
index 0000000..0487109
--- /dev/null
+++ b/doc/reference/configuration/index.en.rst
@@ -0,0 +1,39 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+Configuration File Reference
+============================
+
+.. toctree::
+ :maxdepth: 2
+
+ cache.config.en
+ congestion.config.en
+ hosting.config.en
+ icp.config.en
+ ip_allow.config.en
+ log_hosts.config.en
+ logs_xml.config.en
+ parent.config.en
+ plugin.config.en
+ records.config.en
+ remap.config.en
+ splitdns.config.en
+ ssl_multicert.config.en
+ storage.config.en
+ update.config.en
+ volume.config.en
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/ip_allow.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/ip_allow.config.en.rst b/doc/reference/configuration/ip_allow.config.en.rst
new file mode 100644
index 0000000..49812a1
--- /dev/null
+++ b/doc/reference/configuration/ip_allow.config.en.rst
@@ -0,0 +1,77 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+===============
+ip_allow.config
+===============
+
+.. configfile:: ip_allow.config
+
+The :file:`ip_allow.config` file controls client access to the Traffic
+Server proxy cache. You can specify ranges of IP addresses that are
+allowed to use the Traffic Server as a web proxy cache. After you modify
+the :file:`ip_allow.config` file, navigate to the Traffic Server bin
+directory and run the :option:`traffic_line -x` command to apply changes. When
+you apply the changes to a node in a cluster, Traffic Server
+automatically applies the changes to all other nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`ip_allow.config` file must have the following
+format::
+
+ src_ip=<range of IP addresses> action=<action> [method=<list of methods separated by '|'>]
+
+where src_ip is the IP address or range of IP addresses of the
+client(s). The action ``ip_allow`` enables the specified client(s) to
+access the Traffic Server proxy cache, and ``ip_deny`` denies the
+specified client(s) to access the Traffic Server proxy cache. Multiple
+method keywords can be specified (method=GET method=HEAD), or multiple
+methods can be separated by an '\|' (method=GET\|HEAD). The method
+keyword is optional and it is defaulted to ALL. Available methods: ALL,
+GET, CONNECT, DELETE, HEAD, ICP_QUERY, OPTIONS, POST, PURGE, PUT,
+TRACE, PUSH
+
+By default, the :file:`ip_allow.config` file contains the following lines,
+which allows all methods to localhost to access the Traffic Server proxy
+cache and denies PUSH, PURGE and DELETE to all IPs (note this allows all
+other methods to all IPs)::
+
+ src_ip=127.0.0.1 action=ip_allow method=ALL
+ src_ip=::1 action=ip_allow method=ALL
+ src_ip=0.0.0.0-255.255.255.255 action=ip_deny method=PUSH|PURGE|DELETE
+ src_ip=::-ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff action=ip_deny method=PUSH|PURGE|DELETE
+
+Examples
+========
+
+The following example enables all clients to access the Traffic Server
+proxy cache::
+
+ 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::
+
+ 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::
+
+ src_ip=123.45.6.0-123.45.6.123 action=ip_deny
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/log_hosts.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/log_hosts.config.en.rst b/doc/reference/configuration/log_hosts.config.en.rst
new file mode 100644
index 0000000..dcb74e9
--- /dev/null
+++ b/doc/reference/configuration/log_hosts.config.en.rst
@@ -0,0 +1,66 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+================
+log_hosts.config
+================
+
+.. configfile:: log_hosts.config
+
+To record HTTP transactions for different origin servers in separate log
+files, you must list each origin server hostname in the
+:file:`log_hosts.config` file. In addition, you must enable the `HTTP Host
+Log Splitting <../working-log-files#HTTPHostLogSplitting>`_ option. You
+should use the same :file:`log_hosts.config` file on every Traffic Server
+node in your cluster. After you modify the :file:`log_hosts.config` file,
+run the :option:`traffic_line -x` command to apply the changes.
+When you apply the changes to a node in a cluster, Traffic Server automatically applies the
+changes to all other nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`log_hosts.config` file has the following format::
+
+ hostname
+
+where ``hostname`` is the hostname of the origin server.
+
+.. hint::
+
+ You can specify keywords in the :file:`log_hosts.config` file to
+ record all transactions from origin servers with the specified keyword
+ in their names in a separate log file. See the example below.
+
+Examples
+========
+
+The following example configures Traffic Server to create separate log
+files containing all HTTP transactions for the origin servers
+``webserver1``, ``webserver2``, and ``webserver3``::
+
+ webserver1
+ webserver2
+ webserver3
+
+The following example records all HTTP transactions from origin servers
+that contain ``sports`` in their names. For example:
+``sports.yahoo.com`` and ``www.foxsports.com`` in a log file called
+``squid-sport.log`` (the Squid format is enabled)::
+
+ sports
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/logs_xml.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/logs_xml.config.en.rst b/doc/reference/configuration/logs_xml.config.en.rst
new file mode 100644
index 0000000..e9ad379
--- /dev/null
+++ b/doc/reference/configuration/logs_xml.config.en.rst
@@ -0,0 +1,370 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+===============
+logs_xml.config
+===============
+
+.. configfile:: logs_xml.config
+
+The :file:`logs_xml.config` file defines the custom log file formats,
+filters, and processing options. The format of this file is modeled
+after XML, the Extensible Markup Language.
+
+Format
+======
+
+The :file:`logs_xml.config` file contains the specifications below:
+
+- ``LogFormat`` specifies the fields to be gathered from each protocol
+ event access.
+- ``LogFilter`` specifies the filters that are used to include or
+ exclude certain entries being logged based on the value of a field
+ within that entry.
+- ``LogObject`` specifies an object that contains a particular format,
+ a local filename, filters, and collation servers.
+
+The :file:`logs_xml.config` file ignores extra white space, blank lines, and
+all comments.
+
+LogFormat
+=========
+
+The following list shows ``LogFormat`` specifications.
+
+*``<Name = "valid_format_name"/>``* {#LogsXMLFormatName}
+ 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"/>``* {#LogsXMLFormat}
+ 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 <../event-logging-formats#CustomLoggingFields>`_.
+
+ 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 } container>
+
+ 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"/>``* {#LogsXMLInterval}
+ Optional
+ 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
+==========
+
+The following list shows the ``LogFilter`` specifications.
+
+*``<Name = "valid_filter_name"/>``* {#LogsXMLFilterName}
+ Required
+ All filters must be uniquely named.
+
+*``<Condition = "valid_log_field valid_operator valid_comparison_value"/>``*
+{#LogsXMLFilterCondition}
+ 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 <../event-logging-formats#LoggingFormatCrossReference>`_.
+
+ ``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``.
+
+ ``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"/>``* {#LogsXMLFilterAction}
+ Required: ``ACCEPT`` or ``REJECT`` .
+ This instructs Traffic Server to either accept or reject records
+ that satisfy the filter condition.
+
+LogObject
+=========
+
+The following list shows the ``LogObject`` specifications.
+
+*``<Format = "valid_format_name"/>``* {#LogsXMLObjectFormat}
+ 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"/>``* {#LogsXMLObjectFilename}
+ 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" <#LogsXMLOjbectMode>`_).
+
+ 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"/>``* {#LogsXMLOjbectMode}
+ Optional
+ 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.
+
+*``<Filters = "list_of_valid_filter_names"/>``*
+{#LogsXMLObjectFilters}
+ Optional
+ 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"/>``*
+{#LogsXMLObjectProtocols}
+ Optional
+ 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"/>``*
+{#LogsXMLObjectServerHosts}
+ Optional
+ 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"/>``*
+{#LogsXMLObjectCollationHosts}
+ Optional
+ 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"/>``* {#LogsXMLObjectHeader}
+ Optional
+ 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"/>``*
+{#LogsXMLObjectRollingEnabled}
+ Optional
+ Enables or disables log file rolling for the ``LogObject``. This
+ setting overrides the value for the
+ *``proxy.config.log.rolling_enabled``* variable in the
+ :file:`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"/>``*
+{#LogsXMLObjectRollingIntervalSec}
+ Optional
+ 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
+ :file:`records.config` file.
+
+*``<RollingOffsetHr = "hour"/>``* {#LogsXMLObjectRollingOffsetHr}
+ Optional
+ 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 :file:`records.config`
+ file.
+
+*``<RollingSizeMb = "size_in_MB"/>``*
+{#LogsXMLObjectRollingSizeMb}
+ Optional
+ The size at which log files are rolled.
+
+Examples
+========
+
+The following is an example of a ``LogFormat`` specification that
+collects information using three common fields:
+
+::
+
+ <LogFormat>
+ <Name="minimal"/>
+ <Format = "%<chi> : %<cqu> : %<pssc>"/>
+ </LogFormat>
+
+The following is an example of a ``LogFormat`` specification that
+uses aggregate operators:
+
+::
+
+ <LogFormat>
+ <Name = "summary"/>
+ <Format = "%<LAST(cqts)> : %<COUNT(*)> : %<SUM(psql)>"/>
+ <Interval = "10"/>
+ </LogFormat>
+
+The following is an example of a ``LogFilter`` that will cause only
+``REFRESH_HIT`` entries to be logged:
+
+::
+
+ <LogFilter>
+ <Name = "only_refresh_hits"/>
+ <Action = "ACCEPT"/>
+ <Condition = "%<pssc> MATCH REFRESH_HIT"/>
+ </LogFilter>
+
+.. note:
+
+ When specifying the field in the filter condition, you can
+ omit the\ ``%<>``. This means that the filter below is equivalent to the
+ example directly above:
+
+::
+
+ <LogFilter>
+ <Name = "only_refresh_hits"/>
+ <Action = "ACCEPT"/>
+ <Condition = "pssc MATCH REFRESH_HIT"/>
+ </LogFilter>
+
+The following is an example of a ``LogObject`` specification that
+creates a local log file for the minimal format defined earlier. The log
+filename will be ``minimal.log`` because this is an ASCII log file (the
+default).
+
+::
+
+ <LogObject>
+ <Format = "minimal"/>
+ <Filename = "minimal"/>
+ </LogObject>
+
+The following is an example of a ``LogObject`` specification that
+includes only HTTP requests served by hosts in the domain
+``company.com`` or by the specific server ``server.somewhere.com``. Log
+entries are sent to port 4000 of the collation host ``logs.company.com``
+and to port 5000 of the collation host ``209.131.52.129.``
+
+::
+
+ <LogObject>
+ <Format = "minimal"/>
+ <Filename = "minimal"/>
+ <ServerHosts = "company.com,server.somewhere.com"/>
+ <Protocols = "http"/>
+ <CollationHosts = "logs.company.com:4000,209.131.52.129:5000"/>
+ </LogObject>
+
+WELF
+====
+
+Traffic Server supports WELF (WebTrends Enhanced Log Format) so you can
+analyze Traffic Server log files with WebTrends reporting tools. A
+predefined ``<LogFormat>`` that is compatible with WELF is provided in
+the :file:`logs_xml.config` file (shown below). To create a WELF format log
+file, create a ``<LogObject>`` that uses this predefined format.
+
+::
+
+ <LogFormat>
+ <Name = "welf"/>
+ <Format = "id=firewall time=\"%<cqtd> %<cqtt>\" fw=%<phn> pri=6
+ proto=%<cqus> duration=%<ttmsf> sent=%<psql> rcvd=%<cqhl>
+ src=%<chi> dst=%<shi> dstname=%<shn> user=%<caun> op=%<cqhm>
+ arg=\"%<cqup>\" result=%<pssc> ref=\"%<{Referer}cqh>\"
+ agent=\"%<{user-agent}cqh>\" cache=%<crc>"/>
+ </LogFormat>
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/parent.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/parent.config.en.rst b/doc/reference/configuration/parent.config.en.rst
new file mode 100644
index 0000000..1391c7c
--- /dev/null
+++ b/doc/reference/configuration/parent.config.en.rst
@@ -0,0 +1,139 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+=============
+parent.config
+=============
+
+.. configfile:: parent.config
+
+The :file:`parent.config` file identifies the parent proxies used in an
+cache hierarchy. Use this file to perform the following configuration:
+
+- Set up parent cache hierarchies, with multiple parents and parent
+ failover
+- Configure selected URL requests to bypass parent proxies
+
+Traffic Server uses the :file:`parent.config` file only when the parent
+caching option is enabled (refer to `Configuring Traffic Server to Use a
+Parent Cache <../hierachical-caching>`_).
+
+After you modify the :file:`parent.config` file, run the :option:`traffic_line -x`
+command to apply your changes. When you apply the changes to one node in
+a cluster, Traffic Server automatically applies the changes to all other
+nodes in the cluster.
+
+Format
+======
+
+Each line in the :file:`parent.config` file must contain a parent caching
+rule. Traffic Server recognizes three space-delimited tags:
+
+ primary_destination=value secondary_specifier=value action=value
+
+The following list shows the possible primary destinations and their
+allowed values.
+
+*``dest_domain``* {#dest_domain}
+ A requested domain name.
+
+*``dest_host``* {#dest_host}
+ A requested hostname.
+
+*``dest_ip``* {#dest_ip}
+ A requested IP address or range of IP addresses separated by a dash
+ (-).
+
+*``url_regex``* {#url_regex}
+ A regular expression (regex) to be found in a URL
+
+The secondary specifiers are optional in the :file:`parent.config` file. The
+following list shows the possible secondary specifiers and their allowed
+values.
+
+*``port``* {#port}
+ A requested URL port.
+
+*``scheme``* {#scheme}
+ A request URL protocol: ``http`` or ``https``.
+
+*``prefix``* {#prefix}
+ A prefix in the path part of a URL.
+
+*``suffix``* {#suffix}
+ A file suffix in the URL.
+
+*``method``* {#method}
+ A request URL method. It can be one of the following:
+
+ - get
+ - post
+ - put
+ - trace
+
+*``time``* {#time}
+ A time range, such as 08:00-14:00, during which the parent cache is
+ used to serve requests.
+
+*``src_ip``* {#src_ip}
+ 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.
+
+``round_robin``
+ 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.
+
+``go_direct``
+ One of the following values:
+
+ - ``true`` - requests bypass parent hierarchies and go directly to
+ the origin server.
+ - ``false`` - requests do not bypass parent hierarchies.
+
+Examples
+========
+
+The following rule configures a parent cache hierarchy consisting of
+Traffic Server (which is the child) and two parents, ``p1.x.com`` and
+``p2.x.com``. Traffic Server forwards the requests it cannot serve to
+the parent servers ``p1.x.com`` and ``p2.x.com`` in a round-robin
+fashion::
+
+ round_robin=true
+ dest_domain=. method=get parent="p1.x.com:8080; p2.y.com:8080" round_robin=true
+
+The following rule configures Traffic Server to route all requests
+containing the regular expression ``politics`` and the path
+``/viewpoint`` directly to the origin server (bypassing any parent
+hierarchies): ``url_regex=politics prefix=/viewpoint go_direct=true``
+
+Every line in the :file:`parent.config` file must contain either a
+``parent=`` or ``go_direct=`` directive.
+
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/c2eb7363/doc/reference/configuration/plugin.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/reference/configuration/plugin.config.en.rst b/doc/reference/configuration/plugin.config.en.rst
new file mode 100644
index 0000000..9a5afa6
--- /dev/null
+++ b/doc/reference/configuration/plugin.config.en.rst
@@ -0,0 +1,51 @@
+.. Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+=============
+plugin.config
+=============
+
+.. configfile:: plugin.config
+
+The :file:`plugin.config` file controls run-time loadable plugins available
+to the Traffic Server, as well as their configuration.
+
+Example
+=======
+
+::
+
+ # Comments start with a '#' and continue to the end of the line
+ # Blank lines are ignored
+ #
+ # test-plugin.so arg1 arg2 arg3
+ #
+ plugins/iwx/iwx.so
+ plugins/abuse/abuse.so etc/trafficserver/abuse.config
+ plugins/icx/icx.so etc/trafficserver/icx.config
+
+Each configuration line consists of a path to an ``.so`` file. This path
+can either be absolute, or relative to the plugin-directory (usually
+``/usr/local/libexec/trafficserver``). Such a line tells Traffic Server
+to load said plugin.
+
+A plugin can have any number of configuration parameters listed. Please
+refer to our `plugins' documentation <../plugins>`_ for their reference.
+
+Plugins should only be listed *once*. The order in which the plugins are
+listed is also the order in which they are chained for the processing.
+