You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by zw...@apache.org on 2013/06/04 18:46:16 UTC
[22/50] [abbrv] Separate the Admin and SDK guides.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a782694b/doc/source/admin/configuration-files/remap.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/configuration-files/remap.config.en.rst b/doc/source/admin/configuration-files/remap.config.en.rst
deleted file mode 100644
index f2887e8..0000000
--- a/doc/source/admin/configuration-files/remap.config.en.rst
+++ /dev/null
@@ -1,284 +0,0 @@
-remap.config
-************
-
-.. 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
-
-
-The ``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.
-
-**IMPORTANT:** After you modify the ``remap.config`` run the
-``traffic_line -x`` command 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 ``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:
-
- ::
-
- :::text
- 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
-``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:
-
-::
-
- :::text
- 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:
-
-::
-
- :::text
- 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 ``remap.config``
-file.
-
-The following example shows a mapping with a path prefix specified in
-the target and replacement:
-
-::
-
- :::text
- map http://www.h.com/a/b/ http://server.h.com/customers/x/y
- 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:
-
-::
-
- :::text
- map http://www.x.com/ http://server.hoster.com/x/
- reverse_map http://server.hoster.com/x/ http://www.x.com/
-
-These rules result in the following translations.
-
-Client Request \| Translated Request
----------------\|------------------- ``http://www.x.com/Widgets`` \|
-``http://server.hoster.com/x/Widgets`` \|
-
-
-
-Client Request \| 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
-``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/a782694b/doc/source/admin/configuration-files/splitdns.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/configuration-files/splitdns.config.en.rst b/doc/source/admin/configuration-files/splitdns.config.en.rst
deleted file mode 100644
index e1e9013..0000000
--- a/doc/source/admin/configuration-files/splitdns.config.en.rst
+++ /dev/null
@@ -1,124 +0,0 @@
-splitdns.config
-***************
-
-.. 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 ``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
-
-**IMPORTANT:** After you modify the ``splitdns.config`` file, navigate
-to the Traffic Server\ ``bin`` directory and run the ``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 ``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``
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a782694b/doc/source/admin/configuration-files/ssl_multicert.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/configuration-files/ssl_multicert.config.en.rst b/doc/source/admin/configuration-files/ssl_multicert.config.en.rst
deleted file mode 100644
index 7aea5e9..0000000
--- a/doc/source/admin/configuration-files/ssl_multicert.config.en.rst
+++ /dev/null
@@ -1,78 +0,0 @@
-ssl_multicert.config
-********************
-
-.. 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 ``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 ``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 ```records.config`` <../records.config>`_'s
-```proxy.config.ssl.CA.cert.filename`` <../records.config#proxy.config.ssl.CA.cert.filename>`_.
-
-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/a782694b/doc/source/admin/configuration-files/storage.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/configuration-files/storage.config.en.rst b/doc/source/admin/configuration-files/storage.config.en.rst
deleted file mode 100644
index f4326fe..0000000
--- a/doc/source/admin/configuration-files/storage.config.en.rst
+++ /dev/null
@@ -1,135 +0,0 @@
-storage.config
-**************
-
-.. 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 ``storage.config`` file lists all the files, directories, and/or
-hard disk partitions that make up the Traffic Server cache. After you
-modify the ``storage.config`` file, you must restart Traffic Server.
-
-Format
-======
-
-The format of the ``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 :doc:`volume.config.en`
-and :doc:`hosting.config.en`. 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 ``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:
-
-::
-
- :::text
- /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``:
-
-::
-
- :::text
- # 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/a782694b/doc/source/admin/configuration-files/update.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/configuration-files/update.config.en.rst b/doc/source/admin/configuration-files/update.config.en.rst
deleted file mode 100644
index cbe9d19..0000000
--- a/doc/source/admin/configuration-files/update.config.en.rst
+++ /dev/null
@@ -1,200 +0,0 @@
-update.config
-*************
-
-.. 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 ``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
-
-**IMPORTANT:** After you modify the ``update.config`` file, navigate to
-the Traffic Serve ``bin`` directory and run the ``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 ``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/a782694b/doc/source/admin/configuration-files/volume.config.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/configuration-files/volume.config.en.rst b/doc/source/admin/configuration-files/volume.config.en.rst
deleted file mode 100644
index 89d22c5..0000000
--- a/doc/source/admin/configuration-files/volume.config.en.rst
+++ /dev/null
@@ -1,72 +0,0 @@
-volume.config
-*************
-
-.. 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
-
-The ``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
-`hosting.config <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/a782694b/doc/source/admin/configuring-cache.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/configuring-cache.en.rst b/doc/source/admin/configuring-cache.en.rst
deleted file mode 100644
index 72ed7a1..0000000
--- a/doc/source/admin/configuring-cache.en.rst
+++ /dev/null
@@ -1,365 +0,0 @@
-Configuring the Cache
-*********************
-
-.. 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 Traffic Server cache consists of a high-speed object database called
-the **object store** that indexes objects according to URLs and their
-associated headers.
-
-.. toctree::
- :maxdepth: 2
-
-The Traffic Server Cache
-========================
-
-The Traffic Server cache consists of a high-speed object database called
-the **object store**. The object store indexes objects according to URLs
-and associated headers. This enables Traffic Server to store, retrieve,
-and serve not only web pages, but also parts of web pages - which
-provides optimum bandwidth savings. Using sophisticated object
-management, the object store can cache alternate versions of the same
-object (versions may differ because of dissimilar language or encoding
-types). It can also efficiently store very small and very large
-documents, thereby minimizing wasted space. When the cache is full,
-Traffic Server removes stale data to ensure the most requested objects
-are kept readily available and fresh.
-
-Traffic Server is designed to tolerate total disk failures on any of the
-cache disks. If the disk fails completely, then Traffic Server marks the
-entire disk as corrupt and continues using the remaining disks. An alarm
-is then created to indicate which disk failed. If all of the cache disks
-fail, then Traffic Server goes into proxy-only mode.
-
-You can perform the following cache configuration tasks:
-
-- Change the total amount of disk space allocated to the cache: refer
- to `Changing Cache Capacity <#ChangingCacheCapacity>`_.
-- Partition the cache by reserving cache disk space for specific
- protocols and origin servers/domains: refer to `Partitioning the
- Cache <#PartitioningCache>`_.
-- Delete all data in the cache: refer to `Clearing the
- Cache <#ClearingCache>`_.
-
-The RAM Cache
-=============
-
-Traffic Server maintains a small RAM cache of extremely popular objects.
-This RAM cache serves the most popular objects as quickly as possible
-and reduces load on disks, especially during temporary traffic peaks.
-You can configure the RAM cache size to suit your needs, as described in
-`Changing the Size of the RAM Cache <#ChangingSizeRAMCache>`_ below.
-
-Changing the Size of the RAM Cache
-==================================
-
-Traffic Server provides a dedicated RAM cache for fast retrieval of
-popular small objects. The default RAM cache size is automatically
-calculated based on the number and size of the cache partitions you have
-configured. If you've partitioned your cache according to protocol
-and/or hosts, then the size of the RAM cache for each partition is
-proportional to the size of that partition.
-
-You can increase the RAM cache size for better cache hit performance.
-However, if you increase the size of the RAM cache and observe a
-decrease in performance (such as increased latencies), then it's
-possible that the operating system requires more memory for network
-resources. In such instances, you should return the RAM cache size to
-its previous value.
-
-To change the RAM cache size:
-
-1. Stop Traffic Server.
-2. Set the variable
- `*``proxy.config.cache.ram_cache.size``* <../configuration-files/records.config#proxy.config.cache.ram_cache.size>`_
- to specify the size of the RAM cache. The default value of -1 means
- that the RAM cache is automatically sized at approximately 1MB per
- gigabyte of disk.
-3. Restart Traffic Server. If you increase the RAM cache to a size or
- 1GB or more, then restart with the ``start_traffic_server`` command
- (refer to `Starting Traffic
- Server <../getting-started#StartingTS>`_).
-
-
-
-Changing Cache Capacity
-=======================
-
-You can increase or reduce the total amount of disk space allocated to
-the cache without clearing the content. To check the size of the cache
-(in bytes), enter the command
-``traffic_line -r proxy.process.cache.bytes_total``.
-
-Increasing Cache Capacity
--------------------------
-
-To increase the total amount of disk space allocated to the cache on
-existing disks or to add new disks to a Traffic Server node, follow the
-steps below:
-
-1. Stop Traffic Server.
-2. Add hardware, if necessary.
-3. Edit the Traffic Server
- ```storage.config`` <../configuration-files/storage.config>`_ file:
- increase the amount of disk space allocated to the cache on existing
- disks or describe the new hardware you are adding.
-4. Restart Traffic Server.
-
-Reducing Cache Capacity
------------------------
-
-To reduce the total amount of disk space allocated to the cache on an
-existing disk or to remove disks from a Traffic Server node, follow the
-steps below:
-
-1. Stop Traffic Server.
-2. Remove hardware, if necessary.
-3. Edit the Traffic Server
- ```storage.config`` <../configuration-files/storage.config>`_ file:
- reduce the amount of disk space allocated to the cache on existing
- disks or delete the reference to the hardware you're removing.
-4. Restart Traffic Server.
-
-**IMPORTANT:** In the ``storage.config`` file, a formatted or raw disk
-must be at least 128 MB.
-
-Partitioning the Cache
-======================
-
-You can manage your cache space more efficiently and restrict disk usage
-by creating cache volumes with different sizes for specific protocols.
-You can further configure these volumes to store data from specific
-origin servers and/or domains. The volume configuration must be the same
-on all nodes in a cluster.
-
-Creating Cache Partitions for Specific Protocols
-------------------------------------------------
-
-You can create separate volumes for your cache that vary in size to
-store content according to protocol. This ensures that a certain amount
-of disk space is always available for a particular protocol. Traffic
-Server currently supports the **http** partition type for HTTP objects.
-
-To partition the cache according to protocol:
-
-1. Enter a line in the
- ```volume.config`` <../configuration-files/volume.config>`_ file for
- each volume you want to create
-2. Restart Traffic Server.
-
-Making Changes to Partition Sizes and Protocols
------------------------------------------------
-
-After you've configured your cache volumes based on protocol, you can
-make changes to the configuration at any time. Before making changes,
-note the following:
-
-- You must stop Traffic Server before you change the cache volume size
- and protocol assignment.
-- When you increase the size of a volume, the contents of the volume
- are *not* deleted. However, when you reduce the size of a volume, the
- contents of the volume *are* deleted.
-- When you change the volume number, the volume is deleted and then
- recreated, even if the size and protocol type remain the same.
-- When you add new disks to your Traffic Server node, volume sizes
- specified in percentages will increase proportionately.
-- A lot of changes to volume sizes might result in disk fragmentation,
- which affects performance and hit rate. You should clear the cache
- before making many changes to cache volume sizes (refer to `Clearing
- the Cache <#ClearingCache>`_).
-
-Partitioning the Cache According to Origin Server or Domain
------------------------------------------------------------
-
-After you have partitioned the cache according to size and protocol, you
-can assign the volumes you created to specific origin servers and/or
-domains. You can assign a volumes to a single origin server or to
-multiple origin servers. However, if a volumes is assigned to multiple
-origin servers, then there is no guarantee on the space available in the
-volumes for each origin server. Content is stored in the volumes
-according to popularity. In addition to assigning volumes to specific
-origin servers and domains, you must assign a generic volume to store
-content from all origin servers and domains that are not listed. This
-generic volume is also used if the partitions for a particular origin
-server or domain become corrupt. If you do not assign a generic volume,
-then Traffic Server will run in proxy-only mode.
-
-**Note:** You do *not* need to stop Traffic Server before you assign
-volumes to particular hosts or domains. However, this type of
-configuration is time-consuming and can cause a spike in memory usage.
-Therefore, it's best to configure partition assignment during periods of
-low traffic.
-
-To partition the cache according to hostname and domain:
-
-1. Configure the cache volumes according to size and protocol, as
- described in `Creating Cache Partitions for Specific
- Protocols <#CreatingCachePartitionsSpecificProtocols>`_.
-2. Create a separate volume based on protocol for each host and domain,
- as well as an additional generic partition to use for content that
- does not belong to these origin servers or domains. The volumes do
- not need to be the same size.
-3. Enter a line in the
- ```hosting.config`` <../configuration-files/hosting.config>`_ file to
- allocate the volume(s) used for each origin server and/or domain
-4. Assign a generic volume to use for content that does not belong to
- any of the origin servers or domains listed in the file. If all
- volumes for a particular origin server become corrupt, then Traffic
- Server will also use the generic volume to store content for that
- origin server as per
- `hosting.config <../configuration-files/hosting.config>`_.
-5. Run the command ``traffic_line -x`` to apply the configuration
- changes.
-
-Configuring the Cache Object Size Limit
-=======================================
-
-By default, Traffic Server allows objects of any size to be cached. You
-can change the default behavior and specify a size limit for objects in
-the cache via the steps below:
-
-1. Set
- `*``proxy.config.cache.max_doc_size``* <../configuration-files/records.config#proxy.config.cache.max_doc_size>`_
- to specify the maximum size allowed for objects in the cache in
- bytes. ``0`` (zero) if you do not want a size limit.
-2. Run the command ``traffic_line -x`` to apply the configuration
- changes.
-
-Clearing the Cache
-==================
-
-When you clear the cache, you remove all data from the entire cache -
-including data in the host database. You should clear the cache before
-performing certain cache configuration tasks, such as partitioning. You
-cannot clear the cache when Traffic Server is running.
-
-To clear the cache:
-
-1. Stop Traffic Server (refer to `Stopping Traffic
- Server <../getting-started#StoppingTS>`_).
-2. Enter the following command to clear the cache:
-
- ::
-
- traffic_server -Cclear
-
- The ``clear`` command deletes all data in the object store and the
- host database. Traffic Server does not prompt you to confirm the
- deletion.
-
-3. Restart Traffic Server (refer to `Starting Traffic
- Server <../getting-started#StoppingTS>`_).
-
-Removing an Object From the Cache
-=================================
-
-Traffic Server accepts the custom HTTP request method ``PURGE`` when
-removing a specific object from cache. If the object is found in the
-cache and is successfully removed, then Traffic Server responds with a
-``200 OK`` HTTP message; otherwise, a ``404 File Not Found`` message is
-returned.
-
-In the following example, Traffic Server is running on the domain
-*``example.com``* and you want to remove the image ``remove_me.jpg``
-from cache. Because by default we do not permit ``PURGE`` requests from
-any other IP, we connect to the daemon via localhost:
-
-::
-
- $ curl -X PURGE -H 'Host: example.com' -v "http://localhost/remove_me.jpg"
- * About to connect() to localhost port 80 (#0)
- * Trying 127.0.0.1... connected
- * Connected to localhost (127.0.0.1) port 80 (#0)
-
- > PURGE /remove_me.jpg HTTP/1.1
- > User-Agent: curl/7.19.7
- > Host: example.com
- > Accept: */*
- >
- < HTTP/1.1 200 Ok
- < Date: Thu, 08 Jan 2010 20:32:07 GMT
- < Connection: keep-alive
-
-The next time Traffic Server receives a request for the removed object,
-it will contact the origin server to retrieve it (i.e., it has been
-purged from the Traffic Server cache).
-
-Note: The procedure above only removes an object from a *specific*
-Traffic Server cache. Users may still see the old (removed) content if
-it was cached by intermediary caches or by the end-users' web browser.
-
-Inspecting the Cache
-====================
-
-Traffic Server provides a Cache Inspector utility that enables you to
-view, delete, and invalidate URLs in the cache (HTTP only). The Cache
-Inspector utility is a powerful tool that's capable of deleting *all*
-the objects in your cache; therefore, make sure that only authorized
-administrators are allowed to access this utility, see `Controlling Host
-Access to Traffic
-Manager <../security-options#ControllingHostAccessTrafficManager>`_.
-
-Accessing the Cache Inspector Utility
--------------------------------------
-
-To access the Cache Inspector utility, follow the steps below:
-
-1. In the ```records.config`` <../configuration-files/records.config>`_
- file add the following variable:
-2. `*``CONFIG proxy.config.http_ui_enabled INT 1``* <../configuration-files/records.config#proxy.config.http_ui_enabled>`_
-3. To access the cache inspector in reverse proxy mode, you must add a
- remap rule to ``remap.config`` to expose the URL For example:
- ``map http://yourhost.com/myCI http://{cache} @action=allow @src_ip=corp_internal_address``
-4. From the Traffic Server ``bin`` directory, enter the following
- command to re-read the configuration file: ``traffic_line -x``
-5. Open your web browser and configure it to use your Traffic Server as
- a proxy server. Type the following URL: ``http://yourhost/myCI``
-6. The Cache page opens (see `Using the Cache Page <#UsingCachePage>`_
- below).
-
-Using the Cache Page
---------------------
-
-The **Cache page** provides several options that enable you to view and
-delete the contents of your cache:
-
-- Click **Lookup url** to search for a particular URL in the cache.
- When Traffic Server finds the URL in the cache, it displays details
- about the object that corresponds to the URL (such as the header
- length and the number of alternates). From the display page, you can
- delete the URL from the cache.
-- Click **Delete url** to delete a particular URL or list of URLs from
- the cache. Traffic Server indicates if a delete is successful.
-- Click **Regex lookup** to search for URLs that match one or more
- regular expressions. From the display page, you can delete the URLs
- listed. For example, enter the following to search for all URLs that
- end in html and are prefixed with http://www.dianes.com:
- ``http://www.dianes.com/.*\.html$``
-- Click **Regex delete** to delete all URLs that match a specified
- regular expression. For example, enter the following to delete all
- HTTP URLs that end in ``html``: ``http://.*\.html$``
-- Click **Regex invalidate** to invalidate URLs that match a specified
- regular expression. When you invalidate a URL, Traffic Server marks
- the object that corresponds to the URL as stale in the cache. Traffic
- Server then contacts the origin server to check if the object is
- still fresh (revalidates) before serving it from the cache.
-
-**Note:** Only one administrator should delete and invalidate cache
-entries from the Cache page at any point in time. Changes made by
-multiple administrators at the same time can lead to unpredictable
-results.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a782694b/doc/source/admin/configuring-traffic-server.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/configuring-traffic-server.en.rst b/doc/source/admin/configuring-traffic-server.en.rst
deleted file mode 100644
index 93bf985..0000000
--- a/doc/source/admin/configuring-traffic-server.en.rst
+++ /dev/null
@@ -1,88 +0,0 @@
-Configuring Traffic Server
-**************************
-
-.. 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 provides several options for configuring the system.
-
-This chapter discusses the following topics:
-
-.. toctree::
- :maxdepth: 2
-
-Configure Traffic Server Using Traffic Line
-===========================================
-
-Traffic Line enables you to quickly and easily change your Traffic
-Server configuration via command-line interface. Alternatively, you can
-also use `Traffic Shell <../getting-started#StartingTrafficShell>`_ to
-configure Traffic Server.
-
-View Configuration Options in Traffic Line
-------------------------------------------
-
-To view a configuration setting, enter the following command:
-
-::
- traffic_line -r var
-
-where *``var``* is the variable associated with the configuration
-option. For a list of variables, refer to `Configuration
-Variables <../configuration-files/records.config>`_.
-
-Change Configuration Options in Traffic Line
---------------------------------------------
-
-To change the value of a configuration setting, enter the following
-command:
-
-::
- traffic_line -s var -v value
-
-where *``var``* is the variable associated with the configuration option
-and *``value``* is the value you want to use. For a list of the
-variables, see `Configuration
-Variables <../configuration-files/records.config>`_.
-
-Configure Traffic Server Using Configuration Files
-==================================================
-
-As an alternative to using Traffic Line or Traffic Shell, you can change
-Traffic Server configuration options by manually editing specific
-variables in the
-```records.config`` <../configuration-files/records.config>`_ file.
-After modifying the
-```records.config`` <../configuration-files/records.config>`_ file,
-Traffic Server must reread the configuration files: enter the Traffic
-Line command ``traffic_line -x``. You may need to restart Traffic Server
-to apply some of the configuration changes.
-
-The following is a sample portion of the
-```records.config`` <../configuration-files/records.config>`_ file:
-
-.. figure:: ../_static/images/admin/records.jpg
- :align: center
- :alt: Sample records.config file
-
- Sample records.config file
-
-In addition to the
-```records.config`` <../configuration-files/records.config>`_ file,
-Traffic Server provides other configuration files that are used to
-configure specific features. You can manually edit all configuration
-files as described in `Configuration Files <../configuration-files>`_.
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a782694b/doc/source/admin/event-logging-formats.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/event-logging-formats.en.rst b/doc/source/admin/event-logging-formats.en.rst
deleted file mode 100644
index 2176dba..0000000
--- a/doc/source/admin/event-logging-formats.en.rst
+++ /dev/null
@@ -1,364 +0,0 @@
-Event Logging Formats
-*********************
-
-.. 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.
-
-
-- `Custom Logging Fields <#CustomLoggingFields>`_ provides descriptions
- of logging fields.
-- `Logging Format Cross-Reference <#LoggingFormatCrossReference>`_
- provides cross-references between Trafic Server logging fields and
- Netscape & Squid logging fields (including Netscape Extended and
- Extended-2 fields).
-- You may also try our `online event log builder </logbuilder/>`_ for
- an interactive way of building and understanding log formats.
-
-Custom Logging Fields
-=====================
-
-The following list describes Traffic Server custom logging fields.
-
-``{HTTP header field name}cqh``
- Logs the information in the requested field of the client request
- HTTP header. For example, ``%<{Accept-Language}cqh>`` logs the
- ``Accept-Language:``\ field in client request headers.
-
-``{HTTP header field name}pqh``
- Logs the information in the requested field of the proxy request
- HTTP header. For example, ``%<{Authorization}pqh>`` logs
- the\ ``Authorization:`` field in proxy request headers.
-
-``{HTTP header field name}psh``
- Logs the information in the requested field of the proxy response
- HTTP header. For example, ``%<{Retry-After}psh>`` logs the
- ``Retry-After:`` field in proxy response headers.
-
-``{HTTP header field name}ssh``
- Logs the information in the requested field of the server response
- HTTP header. For example, ``%<{Age}ssh>`` logs the ``Age:`` field in
- server response headers.
-
-``caun``
- The client authenticated username; result of the RFC931/ident lookup
- of the client username.
-
-``cfsc``
- The client finish status code; specifies whether the client request
- to Traffic Server was successfully completed (``FIN``) or
- interrupted (``INTR``).
-
-``chi``
- The IP address of the client's host machine.
-
-``chih``
- The IP address of the client's host machine in hexadecimal.
-
-``cqbl``
- The client request transfer length; the body length in the client
- request to Traffic Server (in bytes).
-
-``cqhl``
- The client request header length; the header length in the client
- request to Traffic Server.
-
-``cqhm``
- The HTTP method in the client request to Traffic Server: ``GET``,
- ``POST``, and so on (subset of ``cqtx``).
-
-``cqhv``
- The client request HTTP version.
-
-``cqtd``
- The client request timestamp. Specifies the date of the client
- request in the format yyyy-mm-dd, where yyyy is the 4-digit year, mm
- is the 2-digit month, and dd is the 2-digit day.
-
-``cqtn``
- The client request timestamp; date and time of the client's request
- (in the Netscape timestamp format).
-
-``cqtq``
- The client request timestamp, with millisecond resolution.
-
-``cqts``
- The client-request timestamp in Squid format; the time of the client
- request since January 1, 1970 UTC. Time is expressed in seconds,
- with millisecond resolution.
-
-``cqtt``
- The client request timestamp. The time of the client request in the
- format hh:mm:ss, where hh is the two-digit hour in 24-hour format,
- mm is the two-digit minutes value, and ss is the 2-digit seconds
- value (for example, 16:01:19).
-
-``cqtx``
- The full HTTP client request text, minus headers; for example,
-
- ::
-
- GET http://www.company.com HTTP/1.0
-
- In reverse proxy mode, Traffic Server logs the rewritten/mapped URL
- (according to the rules in the
- ```remap.config`` <../configuration-files/remap.config>`_ file),
- _not_ the pristine/unmapped URL.
-
-``cqu``
- The universal resource identifier (URI) of the request from client
- to Traffic Server (subset of ``cqtx`` ).
-
- In reverse proxy mode, Traffic Server logs the rewritten/mapped URL
- (according to the rules in the
- ```remap.config`` <../configuration-files/remap.config>`_ file),
- _not_ the pristine/unmapped URL.
-
-``cquc``
- The client request canonical URL. This differs from ``cqu`` in that
- blanks (and other characters that might not be parsed by log
- analysis tools) are replaced by escape sequences. The escape
- sequence is a percentage sign followed by the ASCII code number in
- hex.
-
- See `cquuc`_.
-
-``cqup``
- The client request URL path; specifies the argument portion of the
- URL (everything after the host). For example, if the URL is
- ``http://www.company.com/images/x.gif``, then this field displays
- ``/images/x.gif``
-
- See `cquup`_.
-
-``cqus``
- The client request URL scheme.
-
-.. _cquuc:
-
-``cquuc``
- The client request unmapped URL canonical. This field records a URL
- before it is remapped (reverse proxy mode).
-
-.. _cquup:
-
-``cquup``
- The client request unmapped URL path. This field records a URL path
- before it is remapped (reverse proxy mode).
-
-.. _cquuh:
-
-``cquuh``
- The client request unmapped URL host. This field records a URL's
- host before it is remapped (reverse proxy mode).
-
-``crat``
- The Retry-After time in seconds, if specified by the origin server.
-
-``crc``
- The cache result code; specifies how the cache responded to the
- request (``HIT``, ``MISS``, and so on).
-
-``csscl``
- The cached response length (in bytes) from origin server to Traffic
- Server.
-
-``csshl``
- The cached header length in the origin server response to Traffic
- Server (in bytes).
-
-``csshv``
- The cached server response HTTP version (1.0, 1.1, etc.).
-
-``csssc``
- The cached HTTP response status code from origin server to Traffic
- Server.
-
-``cwr``
- The cache write result (``-``, ``FIN``, ``ERR`` and so on)
-
-``cwtr``
- The cache write transform result
-
-``fsiz``
- The size of the file (*n* bytes) as seen by the origin server.
-
-``pfsc``
- The proxy finish status code; specifies whether the Traffic Server
- request to the origin server was successfully completed (``FIN``) or
- interrupted (``INTR``).
-
-``phn``
- The hostname of the Traffic Server that generated the log entry in
- collated log files.
-
-``phi``
- The IP of the Traffic Server that generated the log entry in
- collated log files.
-
-``phr``
- The proxy hierarchy route; the route Traffic Server used to retrieve
- the object.
-
-``pqbl``
- The proxy request transfer length; the body length in Traffic
- Server's request to the origin server.
-
-``pqhl``
- The proxy request header length; the header length in Traffic
- Server's request to the origin server.
-
-``pqsi``
- The proxy request server IP address (0 on cache hits and parent-ip
- for requests to parent proxies).
-
-``pqsn``
- The proxy request server name; the name of the server that fulfilled
- the request.
-
-``prcb``
- The number of proxy response bytes to the client from the cache.
-
-``prob``
- The number of proxy response bytes to the client from the origin
- server.
-
-``pscl``
- The length of the Traffic Server response to the client (in bytes).
-
-``psct``
- The content type of the document from server response header: (for
- example, ``img/gif`` ).
-
-``pshl``
- The header length in Traffic Server's response to the client.
-
-``psql``
- The proxy response transfer length in Squid format (includes header
- and content length).
-
-``pssc``
- The HTTP response status code from Traffic Server to the client.
-
-``shi``
- The IP address resolved from the DNS name lookup of the host in the
- request. For hosts with multiple IP addresses, this field records
- the IP address resolved from that particular DNS lookup.
-
- This can be misleading for cached documents. For example: if the
- first request was a cache miss and came from **``IP1``** for server
- **``S``** and the second request for server **``S``** resolved to
- **``IP2``** but came from the cache, then the log entry for the
- second request will show **``IP2``**.
-
-``shn``
- The hostname of the origin server.
-
-``sscl``
- The response length (in bytes) from origin server to Traffic Server.
-
-``sshl``
- The header length in the origin server response to Traffic Server
- (in bytes).
-
-``sshv``
- The server response HTTP version (1.0, 1.1, etc.).
-
-``sssc``
- The HTTP response status code from origin server to Traffic Server.
-
-``ttms``
- The time Traffic Server spends processing the client request; the
- number of milliseconds between the time the client establishes the
- connection with Traffic Server and the time Traffic Server sends the
- last byte of the response back to the client.
-
-``ttmsh``
- Same as ``ttms`` but in hexadecimal.
-
-``ttmsf``
- The time Traffic Server spends processing the client request as a
- fractional number of seconds. Time is specified in millisecond
- resolution; however, instead of formatting the output as an integer
- (as with ``ttms``), the display is formatted as a floating-point
- number representing a fractional number of seconds.
-
- For example: if the time is 1500 milliseconds, then this field
- displays 1.5 while the ``ttms`` field displays 1500 and the ``tts``
- field displays 1.
-
-``tts``
- The time Traffic Server spends processing the client request; the
- number of seconds between the time at which the client establishes
- the connection with Traffic Server and the time at which Traffic
- Server sends the last byte of the response back to the client.
-
-Logging Format Cross-Reference
-==============================
-
-The following sections illustrate the correspondence between Traffic
-Server logging fields and standard logging fields for the Squid and
-Netscape formats.
-
-Squid Logging Formats
----------------------
-
-The following is a list of the Squid logging fields and the
-corresponding logging field symbols.
-
-Squid \| Field Symbols ------\|-------------- ``time`` \| ``cqts``
-``elapsed`` \| ``ttms`` ``client`` \| ``chi`` ``action/code`` \|
-``crc/pssc`` ``size`` \| ``psql`` ``method`` \| ``cqhm`` ``url`` \|
-``cquc`` ``ident`` \| ``caun`` ``hierarchy/from`` \| ``phr/pqsn``
-``content`` \| ``psct``
-
-Netscape Common Logging Formats
--------------------------------
-
-The following is a list of the Netscape Common logging fields and the
-corresponding Traffic Server logging field symbols.
-
-Netscape Common \| Field Symbols ----------------\|--------------
-``host`` \| ``chi`` ``usr`` \| ``caun`` ``[time]`` \| ``[cqtn]``
-``"req"`` \| ``"cqtx"`` ``s1`` \| ``pssc`` ``c1`` \| ``pscl``
-
-Netscape Extended Logging Formats
----------------------------------
-
-The following table lists the Netscape Extended logging fields and the
-corresponding Traffic Server logging field symbols.
-
-Netscape Extended \| Field Symbols ------------------\|--------------
-``host`` \| ``chi`` ``usr`` \| ``caun`` ``[time]`` \| ``[cqtn]``
-``"req"`` \| ``"cqtx"`` ``s1`` \| ``pssc`` ``c1`` \| ``pscl`` ``s2`` \|
-``sssc`` ``c2`` \| ``sscl`` ``b1`` \| ``cqbl`` ``b2`` \| ``pqbl`` ``h1``
-\| ``cqhl`` ``h2`` \| ``pshl`` ``h3`` \| ``pqhl`` ``h4`` \| ``sshl``
-``xt`` \| ``tts``
-
-Netscape Extended-2 Logging Formats
------------------------------------
-
-The following is a list of the Netscape Extended-2 logging fields and
-the corresponding Traffic Server logging field symbols.
-
-Netscape Extended-2 \| Field Symbols
---------------------\|--------------- ``host`` \| ``chi`` ``usr`` \|
-``caun`` ``[time]`` \| ``[cqtn]`` ``"req"`` \| ``"cqtx"`` ``s1`` \|
-``pssc`` ``c1`` \| ``pscl`` ``s2`` \| ``sssc`` ``c2`` \| ``sscl`` ``b1``
-\| ``cqbl`` ``b2`` \| ``pqbl`` ``h1`` \| ``cqhl`` ``h2`` \| ``pshl``
-``h3`` \| ``pqhl`` ``h4`` \| ``sshl`` ``xt`` \| ``tts`` ``route`` \|
-``phr`` ``pfs`` \| ``cfsc`` ``ss`` \| ``pfsc`` ``crc`` \| ``crc``
-
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a782694b/doc/source/admin/explicit-proxy-caching.en.rst
----------------------------------------------------------------------
diff --git a/doc/source/admin/explicit-proxy-caching.en.rst b/doc/source/admin/explicit-proxy-caching.en.rst
deleted file mode 100644
index 7eb61cc..0000000
--- a/doc/source/admin/explicit-proxy-caching.en.rst
+++ /dev/null
@@ -1,93 +0,0 @@
-Explicit Proxy Caching
-**********************
-
-.. 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
-
-If you want to use Traffic Server as an explicit proxy cache, you must
-configure client software (i.e., browsers) to send requests directly to
-Traffic Server.
-
-If you do not configure Traffic Server to use the transparency option
-(with which client requests are intercepted en route to origin servers
-by a switch/router and rerouted to the Traffic Server machine), then
-clients must configure their web browsers to send HTTP requests to the
-Traffic Server proxy cache by configuring their browsers to download
-proxy configuration instructions from a `PAC file <#UsingPACFile>`_
-(Proxy Auto-Configuration file).
-
-Configuring Browsers Manually
-=============================
-
-To manually configure a browser to send HTTP requests to Traffic Server,
-clients must provide the following information:
-
-- The fully-qualified hostname or IP address of the Traffic Server node
-- The Traffic Server proxy server port (port 8080)
-
-In addition, clients can specify *not* to use Traffic Server for certain
-sites - in such cases, requests to the listed sites go directly to the
-origin server. The procedures for manual configuration vary among
-browser versions; refer to specific browser documentation for complete
-proxy configuration instructions. You do not need to set any special
-configuration options on Traffic Server if you want to accept requests
-from manually-configured browsers.
-
-Using a PAC File
-================
-
-A **PAC file** is a specialized JavaScript function definition that a
-browser calls to determine how requests are handled. Clients must
-specify (in their browser settings) the URL from which the PAC file is
-loaded. You can store a PAC file on Traffic Server (or on any server in
-your network) and then provide the URL for this file to your clients.
-
-If you want to store a PAC file on the Traffic Server system, then you
-must perform the following configuration:
-
-- Either copy an existing PAC file into the Traffic Server ``config``
- directory or enter a script that defines the proxy server
- configuration settings in the ``proxy.pac`` file provided. The file
- is empty by default. A sample script is provided in `Sample PAC
- File <#SamplePACFile>`_.
-- Specify the port Traffic Server uses to serve the PAC file. The
- default port is
- `8083 <../configuration-files/records.config#proxy.config.admin.autoconf_port>`_.
-
-Sample PAC File
----------------
-
-The following sample PAC file instructs browsers to connect directly to
-all hosts without a fully-qualified domain name and to all hosts in the
-local domain. All other requests go to the Traffic Server named
-``myproxy.company.com``.
-
-::
-
- function FindProxyForURL(url, host)
- {
- if (isPlainHostName(host)) || (localHostOrDomainIs(host, ".company.com")) {
- return "DIRECT";
- }
- else
- return "PROXY myproxy.company.com:8080; DIRECT";
- }
-
-