You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by ig...@apache.org on 2013/07/29 12:30:17 UTC
[1/2] format all of records.config to amc's ts:confvar
Updated Branches:
refs/heads/master ac4cc372d -> ecbf8f1d6
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/ecbf8f1d/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
index 6dbf593..b2f94ff 100644
--- a/doc/admin/configuration-files/records.config.en.rst
+++ b/doc/admin/configuration-files/records.config.en.rst
@@ -136,7 +136,7 @@ System Variables
The name of the executable that runs the ``traffic_server`` process.
-.. ts:confvar:: CONFIG _proxy.config.proxy_binary_opts STRING -M
+.. ts:confvar:: CONFIG proxy.config.proxy_binary_opts STRING -M
The command-line options for starting Traffic Server.
@@ -168,7 +168,7 @@ System Variables
The directory used for Traffic Server temporary files.
.. ts:confvar:: CONFIG proxy.config.alarm_email STRING
- :Reloadable:
+ :reloadable:
The email address to which Traffic Server sends alarm messages.
@@ -184,68 +184,44 @@ otherwise, Traffic Server uses the Traffic Server user account name as the defau
The signal sent to ``traffic_cop``'s managed processes to stop them.
-A value of ``0`` means no signal will be setn.
-
-.. _proxy.config.cop.linux_min_swapfree_kb:
-:``proxy.config.cop.linux_min_swapfree_kb``:
-:Type: ``INT``
-:Default: ``10240``
-:Description: 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.
-
-.. _proxy.config.output.logfile:
-:``proxy.config.output.logfile``:
-:Type: ``STRING``
-:Default: ``traffic.out``
-:Description: 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.
-
-.. _proxy.config.snapshot_dir:
-:``proxy.config.snapshot_dir``:
-:Type: ``STRING``
-:Default: ``snapshots``
-:Description: The directory in which Traffic Server stores configuration snapshots
- on the local system. Unless you specify an absolute path, this
+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.
-.. _proxy.config.exec_thread.autoconfig:
-:``proxy.config.exec_thread.autoconfig``:
-:Type: ``INT``
-:Default: ``1``
-:Description: When enabled (the default, ``1``), Traffic Server scales threads
- according to the available CPU cores. See the config option below.
-
-.. _proxy.config.exec_thread.autoconfig.scale:
-:``proxy.config.exec_thread.autoconfig.scale``:
-:Type: ``FLOAT``
-:Default: ``1.5``
-:Description: Factor by which Traffic Server scales the number of threads. The
- multiplier is usually the number of available CPU cores. By default
+.. 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 ultiplier is usually the number of available CPU cores. By default
this is scaling factor is ``1.5``.
-.. _proxy.config.exec_thread.limit:
-:``proxy.config.exec_thread.limit``:
-:Type: ``INT``
-:Default: ``2``
-:Description: What does this do?
-
-.. _proxy.config.accept_threads:
-:``proxy.config.accept_threads``:
-:Type: ``INT``
-:Default: ``0``
-:Description: When enabled (``1``), runs a separate thread for accept processing.
- If disabled (``0``), then only 1 thread can be created.
-
-.. _proxy.config.thread.default.stacksize:
-:``proxy.config.thread.default.stacksize``:
-:Type: ``INT``
-:Default: ``1096908``
-:Description: The new default thread stack size, for all threads. The original
- default is set at 1 MB.
+.. 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
=======
@@ -305,45 +281,34 @@ Value Effect
3 no clustering
===== ====================
-``proxy.config.cluster.rsport`` {#proxy.config.cluster.rsport}
- ``INT``
- Default: ``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.rsport INT 8088
-``proxy.config.cluster.threads`` {#proxy.config.cluster.threads}
- ``INT``
- Default: ``1``
- The number of threads for cluster communication. On heavy cluster,
- the number should be adjusted. It is recommend that take the thread
+ 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
=============
-``proxy.config.lm.sem_id`` {#proxy.config.lm.sem_id}
- ``INT``
- Default: ``11452``
+.. ts:confvar:: CONFIG proxy.config.lm.sem_id INT 11452
+
The semaphore ID for the local manager.
-``proxy.config.admin.autoconf_port``
-{#proxy.config.admin.autoconf_port}
- ``INT``
- Default: ``8083``
+.. ts:confvar:: CONFIG proxy.config.admin.autoconf_port INT 8083
+
The autoconfiguration port.
-``proxy.config.admin.number_config_bak``
-{#proxy.config.admin.number_config_bak}
- ``INT``
- Default: ``3``
+.. ts:confvar:: CONFIG proxy.config.admin.number_config_bak INT 3
+
The maximum number of copies of rolled configuration files to keep.
-``proxy.config.admin.user_id`` {#proxy.config.admin.user_id}
- ``STRING``
- Default: ``nobody``
- Option used to specify who to run the ``traffic_server`` process as;
- also used to specify ownership of config and log files.
+.. 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.
@@ -363,29 +328,21 @@ Local Manager
Process Manager
===============
-``proxy.config.process_manager.mgmt_port``
-{#proxy.config.process_manager.mgmt_port}
- ``INT``
- Default: ``8084``
- The port used for internal communication between the
- ``traffic_manager`` and ``traffic_server`` processes.
+.. 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
===================
-``proxy.config.alarm.bin`` {#proxy.config.alarm.bin}
- ``STRING``
- Default: ``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
- edit the script to suit your needs.
+.. 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
-``proxy.config.alarm.abs_path`` {#proxy.config.alarm.abs_path}
- ``STRING``
- Default: ``NULL``
- The full path to the script file that sends email to alert someone
- about Traffic Server problems.
+ The full path to the script file that sends email to alert someone bout Traffic Server problems.
HTTP Engine
===========
@@ -516,7 +473,7 @@ Value Effect
.. 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:
+ :reloadable:
Set how the ``Via`` field is handled on the response to the client.
@@ -528,65 +485,46 @@ Value Effect
2 some extra information is added.
===== ======================
-``proxy.config.http.response_server_enabled``
-{#proxy.config.http.response_server_enabled}
- ``INT``
- Default: ``1``
- Reloadable.
+.. 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
- Origin does not have one already.
+ - ``2`` the Server: header is added only if the response from rigin does not have one already.
-``proxy.config.http.insert_age_in_response``
-{#proxy.config.http.insert_age_in_response}
- ``INT``
- Default: ``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.
+.. 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
-``proxy.config.http.response_server_str``
-{#proxy.config.http.response_server_str}
- ``STRING``
- Default: ``ATS/``
- Reloadable.
- The Server: string that ATS will insert in a response header (if
- requested, see above). Note that the current version number is
+.. 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.
-``proxy.config.http.enable_url_expandomatic``
-{#proxy.config.http.enable_url_expandomatic}
- ``INT``
- Default: ``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``.
-
-``proxy.config.http.chunking_enabled``
-{#proxy.config.http.chunking_enabled}
- ``INT``
- Default: ``1``
- Reloadable.
+.. 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
+ - ``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
@@ -595,26 +533,18 @@ Value Effect
Server can use ``keep-alive`` connections without pipelining to
origin servers.
-``proxy.config.http.share_server_sessions``
-{#proxy.config.http.share_server_sessions}
- ``INT``
- Default: ``1``
+.. ts:confvar:: CONFIG proxy.config.http.share_server_sessions INT 1
+
Enables (``1``) or disables (``0``) the reuse of server sessions.
-``proxy.config.http.record_heartbeat``
-{#proxy.config.http.record_heartbeat}
- ``INT``
- Default: ``0``
- Reloadable.
- Enables (``1``) or disables (``0``) ``traffic_cop`` heartbeat
- logging.
+.. ts:confvar:: CONFIG proxy.config.http.record_heartbeat INT 0
+ :reloadable:
+
+ Enables (``1``) or disables (``0``) ``traffic_cop`` heartbeat ogging.
-.. _proxy.config.http.use_client_target_addr:
+.. ts:confvar:: proxy.config.http.use_client_target_addr INT 0
-:Name: proxy.config.http.use_client_target_addr
-:Type: INT
-:Default: 0
-:Description: For fully transparent ports use the same origin server address as the client.
+ 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
@@ -666,270 +596,174 @@ specific domains.
Parent Proxy Configuration
==========================
-``proxy.config.http.parent_proxy_routing_enable``
-{#proxy.config.http.parent_proxy_routing_enable}
- ``INT``
- Default: ``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_routing_enable INT 0
+ :reloadable:
-``proxy.config.http.parent_proxy.retry_time``
-{#proxy.config.http.parent_proxy.retry_time}
- ``INT``
- Default: ``300``
- Reloadable.
- The amount of time allowed between connection retries to a parent
- cache that is unavailable.
+ Enables (``1``) or disables (``0``) the parent caching option. Refer to Hierarchical Caching <../hierachical-caching>_.
-``proxy.config.http.parent_proxy.fail_threshold``
-{#proxy.config.http.parent_proxy.fail_threshold}
- ``INT``
- Default: ``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.retry_time INT 300
+ :reloadable:
-``proxy.config.http.parent_proxy.total_connect_attempts``
-{#proxy.config.http.parent_proxy.total_connect_attempts}
- ``INT``
- Default: ``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 ``bypass.config``
- file).
-
-``proxy.config.http.parent_proxy.per_parent_connect_attempts``
-{#proxy.config.http.parent_proxy.per_parent_connect_attempts}
- ``INT``
- Default: ``2``
- Reloadable.
- The total number of connection attempts allowed per parent, if
- multiple parents are used.
+ 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 ``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:
-``proxy.config.http.parent_proxy.connect_attempts_timeout``
-{#proxy.config.http.parent_proxy.connect_attempts_timeout}
- ``INT``
- Default: ``30``
- Reloadable.
The timeout value (in seconds) for parent cache connection attempts.
-``proxy.config.http.forward.proxy_auth_to_parent``
-{#proxy.config.http.forward.proxy_auth_to_parent}
- ``INT``
- Default: ``0``
- Reloadable.
- Configures Traffic Server to send proxy authentication headers on to
- the parent cache.
+.. 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
========================
-``proxy.config.http.keep_alive_no_activity_timeout_in``
-{#proxy.config.http.keep_alive_no_activity_timeout_in}
- ``INT``
- Default: ``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_in INT 10
+ :reloadable:
-``proxy.config.http.keep_alive_no_activity_timeout_out``
-{#proxy.config.http.keep_alive_no_activity_timeout_out}
- ``INT``
- Default: ``10``
- Reloadable.
- Specifies how long Traffic Server keeps connections to origin
- servers open for a subsequent transfer of data after a transaction
- ends.
-
-``proxy.config.http.transaction_no_activity_timeout_in``
-{#proxy.config.http.transaction_no_activity_timeout_in}
- ``INT``
- Default: ``120``
- Reloadable.
- Specifies how long Traffic Server keeps connections to clients open
- if a transaction stalls.
+ Specifies how long Traffic Server keeps connections to clients open for a subsequent request after a transaction ends.
-``proxy.config.http.transaction_no_activity_timeout_out``
-{#proxy.config.http.transaction_no_activity_timeout_out}
- ``INT``
- Default: ``120``
- Reloadable.
- Specifies how long Traffic Server keeps connections to origin
- servers open if the transaction stalls.
+.. ts:confvar:: CONFIG proxy.config.http.keep_alive_no_activity_timeout_out INT 10
+ :reloadable:
-``proxy.config.http.transaction_active_timeout_in``
-{#proxy.config.http.transaction_active_timeout_in}
- ``INT``
- Default: ``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
+ 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.
-``proxy.config.http.transaction_active_timeout_out``
-{#proxy.config.http.transaction_active_timeout_out}
- ``INT``
- Default: ``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.
+.. 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.
-``proxy.config.http.accept_no_activity_timeout``
-{#proxy.config.http.accept_no_activity_timeout}
- ``INT``
- Default: ``120``
- Reloadable.
- The timeout interval in seconds before Traffic Server closes a
- connection that has no activity.
+.. ts:confvar:: CONFIG proxy.config.http.accept_no_activity_timeout INT 120
+ :reloadable:
-``proxy.config.http.background_fill_active_timeout``
-{#proxy.config.http.background_fill_active_timeout}
- ``INT``
- Default: ``60``
- Reloadable.
- Specifies how long Traffic Server continues a background fill before
- giving up and dropping the origin server connection.
-
-``proxy.config.http.background_fill_completed_threshold``
-{#proxy.config.http.background_fill_completed_threshold}
- ``FLOAT``
- Default: ``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**).
+ 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
==============================
-``proxy.config.http.connect_attempts_max_retries``
-{#proxy.config.http.connect_attempts_max_retries}
- ``INT``
- Default: ``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 INT 6
+ :reloadable:
-``proxy.config.http.connect_attempts_max_retries_dead_server``
-{#proxy.config.http.connect_attempts_max_retries_dead_server}
- ``INT``
- Default: ``2``
- Reloadable.
- The maximum number of connection retries Traffic Server can make
- when the origin server is unavailable.
+ The maximum number of connection retries Traffic Server can make when the origin server is not responding.
-``proxy.config.http.server_max_connections``
-{#proxy.config.http.server_max_connections}
- ``INT``
- Default: ``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.connect_attempts_max_retries_dead_server INT 2
+ :reloadable:
-``proxy.config.http.origin_max_connections``
-{#proxy.config.http.origin_max_connections}
- ``INT``
- Default: ``0``
- Reloadable.
- Limits the number of socket connections per origin server to the
- value specified. To enable, set to one (``1``).
+ 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:
-``proxy.config.http.origin_min_keep_alive_connections``
-{#proxy.config.http.origin_min_keep_alive_connections}
- ``INT``
- Default: ``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``).
-
-``proxy.config.http.connect_attempts_rr_retries``
-{#proxy.config.http.connect_attempts_rr_retries}
- ``INT``
- Default: ``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.
-
-``proxy.config.http.connect_attempts_timeout``
-{#proxy.config.http.connect_attempts_timeout}
- ``INT``
- Default: ``30``
- Reloadable.
The timeout value (in seconds) for an origin server connection.
-``proxy.config.http.post_connect_attempts_timeout``
-{#proxy.config.http.post_connect_attempts_timeout}
- ``INT``
- Default: ``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.post_connect_attempts_timeout INT 1800
+ :reloadable:
-``proxy.config.http.down_server.cache_time``
-{#proxy.config.http.down_server.cache_time}
- ``INT``
- Default: ``900``
- Reloadable.
- Specifies how long (in seconds) Traffic Server remembers that an
- origin server was unreachable.
+ The timeout value (in seconds) for an origin server connection when the client request is a ``POST`` or ``PUT`` request.
-``proxy.config.http.down_server.abort_threshold``
-{#proxy.config.http.down_server.abort_threshold}
- ``INT``
- Default: ``10``
- Reloadable.
- The number of seconds before Traffic Server marks an origin server
- as unavailable after a client abandons a request because the origin
+.. 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
==================
-``proxy.config.http.congestion_control.enabled``
-{#proxy.config.http.congestion_control.enabled}
- ``INT``
- Default: ``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>``_.
+.. 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
=========================
-``proxy.config.http.negative_caching_enabled``
-{#proxy.config.http.negative_caching_enabled}
- ``INT``
- Default: ``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.
+.. ts:confvar:: CONFIG proxy.config.http.negative_caching_enabled INT 0
+ :reloadable:
- **Note**: ``Cache-Control`` directives from the server forbidding
- cache 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:
+ 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
@@ -946,103 +780,68 @@ Negative Response Caching
Proxy User Variables
====================
-``proxy.config.http.anonymize_remove_from``
-{#proxy.config.http.anonymize_remove_from}
- ``INT``
- Default: ``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_from INT 0
+ :reloadable:
-``proxy.config.http.anonymize_remove_referer``
-{#proxy.config.http.anonymize_remove_referer}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server removes the ``Referrer`` header
- to protect the privacy of your site and users.
+ When enabled (``1``), Traffic Server removes the ``From`` header to protect the privacy of your users.
-``proxy.config.http.anonymize_remove_user_agent``
-{#proxy.config.http.anonymize_remove_user_agent}
- ``INT``
- Default: ``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_referer INT 0
+ :reloadable:
-``proxy.config.http.anonymize_remove_cookie``
-{#proxy.config.http.anonymize_remove_cookie}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server removes the ``Cookie`` header
- to protect the privacy of your site and users.
+ When enabled (``1``), Traffic Server removes the ``Referrer`` header to protect the privacy of your site and users.
-``proxy.config.http.anonymize_remove_client_ip``
-{#proxy.config.http.anonymize_remove_client_ip}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server removes ``Client-IP`` headers
- for more privacy.
+.. ts:confvar:: CONFIG proxy.config.http.anonymize_remove_user_agent INT 0
+ :reloadable:
-``proxy.config.http.anonymize_insert_client_ip``
-{#proxy.config.http.anonymize_insert_client_ip}
- ``INT``
- Default: ``1``
- Reloadable.
- When enabled (``1``), Traffic Server inserts ``Client-IP`` headers
- to retain the client IP address.
+ 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:
-``proxy.config.http.append_xforwards_header``
-{#proxy.config.http.append_xforwards_header}
- ``INT``
- Default: ``0``
- When enabled (``1``), Traffic Server appends ``X-Forwards`` headers
- to outgoing requests.
-
-``proxy.config.http.anonymize_other_header_list``
-{#proxy.config.http.anonymize_other_header_list}
- ``STRING``
- Default: ``NULL``
- Reloadable.
The headers Traffic Server should remove from outgoing requests.
-``proxy.config.http.insert_squid_x_forwarded_for``
-{#proxy.config.http.insert_squid_x_forwarded_for}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server adds the client IP address to
- the ``X-Forwarded-For`` header.
+.. ts:confvar:: CONFIG proxy.config.http.insert_squid_x_forwarded_for INT 0
+ :reloadable:
-``proxy.config.http.normalize_ae_gzip``
-{#proxy.config.http.normalize_ae_gzip}
- ``INT``
- Default: ``0``
- Reloadable.
- Enable (``1``) to normalize all ``Accept-Encoding:`` headers to one
- of the following:
+ 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**
+ - ``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``.
+ 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
========
-``proxy.config.http.push_method_enabled``
-{#proxy.config.http.push_method_enabled}
- ``INT``
- Default: ``0``
- Reloadable.
- Enables (``1``) or disables (``0``) the HTTP ``PUSH`` option, which
- allows you to deliver content directly to the cache without a user
+.. 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
@@ -1052,58 +851,40 @@ Security
Cache Control
=============
-``proxy.config.cache.enable_read_while_writer``
-{#proxy.config.cache.enable_read_while_writer}
- ``INT``
- Default: ``0``
- Reloadable.
- Enables (``1``) or disables (``0``) ability to a read cached object
- while the another connection is completing the write to cache for
+.. 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.
-``proxy.config.cache.force_sector_size``
-{#proxy.config.cache.force_sector_size}
- ``INT``
- Default: ``512``
- Reloadable.
- Forces the use of a specific hardware sector size (512 - 8192
- bytes).
+.. 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:
-``proxy.config.http.cache.http`` {#proxy.config.http.cache.http}
- ``INT``
- Default: ``1``
- Reloadable.
Enables (``1``) or disables (``0``) caching of HTTP requests.
-``proxy.config.http.cache.ignore_client_no_cache``
-{#proxy.config.http.cache.ignore_client_no_cache}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server ignores client requests to
- bypass the cache.
+.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_client_no_cache INT 0
+ :reloadable:
-``proxy.config.http.cache.ims_on_client_no_cache``
-{#proxy.config.http.cache.ims_on_client_no_cache}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server issues a conditional request to
- the origin server if an incoming request has a ``No-Cache`` header.
+ When enabled (``1``), Traffic Server ignores client requests to bypass the cache.
-``proxy.config.http.cache.ignore_server_no_cache``
-{#proxy.config.http.cache.ignore_server_no_cache}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server ignores origin server 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:
-``proxy.config.http.cache.cache_responses_to_cookies``
-{#proxy.config.http.cache.cache_responses_to_cookies}
- ``INT``
- Default: ``3``
- Reloadable.
Specifies how cookies are cached:
- ``0`` = do not cache any responses to cookies
@@ -1111,38 +892,26 @@ Cache Control
- ``2`` = cache only for image types
- ``3`` = cache for all but text content-types
-``proxy.config.http.cache.ignore_authentication``
-{#proxy.config.http.cache.ignore_authentication}
- ``INT``
- Default: ``0``
- When enabled (``1``), Traffic Server ignores ``WWW-Authentication``
- headers in responses ``WWW-Authentication`` headers are removed and
+.. 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.
-``proxy.config.http.cache.cache_urls_that_look_dynamic``
-{#proxy.config.http.cache.cache_urls_that_look_dynamic}
- ``INT``
- Default: ``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>``_
-
-``proxy.config.http.cache.enable_default_vary_headers``
-{#proxy.config.http.cache.enable_default_vary_headers}
- ``INT``
- Default: ``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.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:
-``proxy.config.http.cache.when_to_revalidate``
-{#proxy.config.http.cache.when_to_revalidate}
- ``INT``
- Default: ``0``
- Reloadable.
Specifies when to revalidate content:
- ``0`` = use cache directives or heuristic (the default value)
@@ -1156,89 +925,60 @@ Cache Control
Traffic Server always revalidates the cached content and uses the
client's ``If-Modified-Since`` header for the proxy request.
-``proxy.config.http.cache.when_to_add_no_cache_to_msie_requests``
-{#proxy.config.http.cache.when_to_add_no_cache_to_msie_requests}
- ``INT``
- Default: 0
- Reloadable.
- Specifies when to add ``no-cache`` directives to Microsoft Internet
- Explorer requests. You can specify the following:
+.. 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
-``proxy.config.http.cache.required_headers``
-{#proxy.config.http.cache.required_headers}
- ``INT``
- Default: ``0``
- Reloadable.
- The type of headers required in a request for the request to be
- cacheable.
+.. 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``
-
-``proxy.config.http.cache.max_stale_age``
-{#proxy.config.http.cache.max_stale_age}
- ``INT``
- Default: ``604800``
- Reloadable.
- The maximum age allowed for a stale response before it cannot be
- cached.
+ - ``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``
-``proxy.config.http.cache.range.lookup``
-{#proxy.config.http.cache.range.lookup}
- ``INT``
- Default: ``1``
- When enabled (``1``), Traffic Server looks up range requests in the
- cache.
+.. ts:confvar:: CONFIG proxy.config.http.cache.max_stale_age INT 604800
+ :reloadable:
-``proxy.config.http.cache.enable_read_while_writer``
-{#proxy.config.http.cache.enable_read_while_writer}
- ``INT``
- Default: ``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.
+ The maximum age allowed for a stale response before it cannot be cached.
-``proxy.config.http.cache.fuzz.min_time``
-{#proxy.config.http.cache.fuzz.min_time}
- ``INT``
- Default: ``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``).
-
-``proxy.config.http.cache.ignore_accept_mismatch``
-{#proxy.config.http.cache.ignore_accept_mismatch}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server serves documents from cache
- with a ``Content-Type:`` header that does not match the ``Accept:``
+.. 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.
+ - 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.
-``proxy.config.http.cache.ignore_accept_language_mismatch``
-{#proxy.config.http.cache.ignore_accept_language_mismatch}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server serves documents from cache
- with a ``Content-Language:`` header that does not match the
+.. 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
@@ -1246,13 +986,10 @@ Cache Control
``Vary: Accept-Language`` when doing content negotiation with
``Accept-Language``.
-``proxy.config.http.cache.ignore_accept_charset_mismatch``
-{#proxy.config.http.cache.ignore_accept_charset_mismatch}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server serves documents from cache
- with a ``Content-Type:`` header that does not match the
+.. 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
@@ -1260,129 +997,89 @@ Cache Control
``Vary: Accept-Charset`` when doing content negotiation with
``Accept-Charset``.
-``proxy.config.http.cache.ignore_client_cc_max_age``
-{#proxy.config.http.cache.ignore_client_cc_max_age}
- ``INT``
- Default: ``1``
- Reloadable.
- When enabled (``1``), Traffic Server ignores any
- ``Cache-Control: max-age`` headers from the client.
+.. ts:confvar:: CONFIG proxy.config.http.cache.ignore_client_cc_max_age INT 1
+ :reloadable:
-``proxy.config.cache.permit.pinning``
-{#proxy.config.cache.permit.pinning}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), Traffic Server will keep certain HTTP objects
- in the cache for a certain time as specified in cache.config.
+ 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
====================
-``proxy.config.http.cache.heuristic_min_lifetime``
-{#proxy.config.http.cache.heuristic_min_lifetime}
- ``INT``
- Default: ``3600`` (1 hour)
- 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_min_lifetime INT 3600
+ :reloadable:
-``proxy.config.http.cache.heuristic_max_lifetime``
-{#proxy.config.http.cache.heuristic_max_lifetime}
- ``INT``
- Default: ``86400`` (1 day)
- 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.
-
-``proxy.config.http.cache.heuristic_lm_factor``
-{#proxy.config.http.cache.heuristic_lm_factor}
- ``FLOAT``
- Default: ``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
+ 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.
-``proxy.config.http.cache.fuzz.time``
-{#proxy.config.http.cache.fuzz.time}
- ``INT``
- Default: ``240``
- Reloadable.
- How often Traffic Server checks for an early refresh, during the
- period before the document stale time. The interval specified must
+.. 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.
-``proxy.config.http.cache.fuzz.probability``
-{#proxy.config.http.cache.fuzz.probability}
- ``FLOAT``
- Default: ``0.00500``
- Reloadable.
- The probability that a refresh is made on a document during the
- specified fuzz time.
+.. 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
=====================================
-``proxy.config.http.cache.vary_default_text``
-{#proxy.config.http.cache.vary_default_text}
- ``STRING``
- Default: ``NULL``
- Reloadable.
+.. 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.
-``proxy.config.http.cache.vary_default_images``
-{#proxy.config.http.cache.vary_default_images}
- ``STRING``
- Default: ``NULL``
- Reloadable.
+.. ts:confvar:: CONFIG proxy.config.http.cache.vary_default_images STRING NULL
+ :reloadable:
+
The header on which Traffic Server varies for images.
-``proxy.config.http.cache.vary_default_other``
-{#proxy.config.http.cache.vary_default_other}
- ``STRING``
- Default: ``NULL``
- Reloadable.
- The header on which Traffic Server varies for anything other than
- text and 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
================================
-``proxy.config.body_factory.enable_customizations``
-{#proxy.config.body_factory.enable_customizations}
- ``INT``
- Default: ``0``
+.. 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
+ - ``1`` = enable customizable user response pages in the default directory only
- ``2`` = enable language-targeted user response pages
-``proxy.config.body_factory.enable_logging``
-{#proxy.config.body_factory.enable_logging}
- ``INT``
- Default: ``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.
-
-``proxy.config.body_factory.template_sets_dir``
-{#proxy.config.body_factory.template_sets_dir}
- ``STRING``
- Default: ``config/body_factory``
+.. 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.
-``proxy.config.body_factory.response_suppression_mode``
-{#proxy.config.body_factory.response_suppression_mode}
- ``INT``
- Default: ``0``
+.. 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
@@ -1403,106 +1100,79 @@ 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``.
-``proxy.config.dns.splitDNS.enabled``
-{#proxy.config.dns.splitDNS.enabled}
- ``INT``
- Default: ``0``
- Reloadable.
- Enables (``1``) or disables (``0``) DNS server selection. When
- enabled, Traffic Server refers to the ``splitdns.config`` file for
- the selection specification. Refer to ``Configuring DNS Server
- Selection (Split
- DNS) <../security-options#ConfiguringDNSServerSelectionSplit>``_.
-
-``proxy.config.dns.url_expansions``
-{#proxy.config.dns.url_expansions}
- ``STRING``
- Default: ``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
+.. 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 ``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.
-
-``proxy.config.dns.resolv_conf`` {#proxy.config.dns.resolv_conf}
- ``STRING``
- Default: ``/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,
+ ``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.
-``proxy.config.dns.round_robin_nameservers``
-{#proxy.config.dns.round_robin_nameservers}
- ``INT``
- Default: ``0``
- Reloadable.
+.. ts:confvar:: CONFIG proxy.config.dns.round_robin_nameservers INT 0
+ :reloadable:
+
Enables (``1``) or disables (``0``) DNS server round-robin.
-``proxy.config.dns.nameservers`` {#proxy.config.dns.nameservers}
- ``STRING``
- Default: ``NULL``
- Reloadable.
+.. ts:confvar:: CONFIG proxy.config.dns.nameservers STRING NULL
+ :reloadable:
+
The DNS servers.
-``proxy.config.srv_enabled`` {#proxy.config.srv_enabled}
- ``INT``
- Default: ``0``
- Reloadable.
+.. ts:confvar:: CONFIG proxy.config.srv_enabled INT 0
+ :reloadable:
+
Indicates whether to use SRV records for orgin server lookup.
HostDB
======
-``proxy.config.hostdb.serve_stale_for``
-{#proxy.config.hostdb.serve_stale_for} : ``INT`` : Default: ``0`` :
-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.serve_stale_for INT
-``proxy.config.hostdb.storage_size``
-{#proxy.config.hostdb.storage_size} : ``INT`` : Default: ``33554432`` :
-The amount of space (in bytes) used to store ``hostdb``. Thevalue of
-this variable must be increased if you increase the sizeof the
-``proxy.config.hostdb.size`` variable.
+ The number of seconds for which to use a stale NS record while initiating a background fetch for the new data.
-``proxy.config.hostdb.size`` {#proxy.config.hostdb.size} : ``INT`` :
-Default: ``200000`` : The maximum number of entries allowed in the host
-database.
+.. ts:confvar:: proxy.config.hostdb.storage_size INT 200000
-**Note:** For values above ``200000``, you must increase the value ofthe
-``proxy.config.hostdb.storage_size`` variable by at least44 bytes per
-entry.
+ The amount of space (in bytes) used to store ``hostdb``. Thevalue of this variable must be increased if you increase the sizeof the
+ ``proxy.config.hostdb.size`` variable.
+
+ Default: ``200000`` : The maximum number of entries allowed in the host database.
+
+ **Note:** For values above ``200000``, you must increase the value ofthe ``proxy.config.hostdb.storage_size`` variable by at least 44 bytes per
+ entry.
+
+.. ts:confvar:: CONFIG proxy.config.hostdb.ttl_mode INT 0
+ :reloadable:
-``proxy.config.hostdb.ttl_mode`` {#proxy.config.hostdb.ttl_mode}
- ``INT``
- Default: ``0``
- Reloadable.
The host database time to live mode. You can specify one of the
following:
- ``0`` = obey
- - ``1``\ = ignore
+ - ``1`` = ignore
- ``2`` = min(X,ttl)
- ``3`` = max(X,ttl)
-``proxy.config.hostdb.timeout`` {#proxy.config.hostdb.timeout}
- ``INT``
- Default: ``1440``
- Reloadable.
+.. ts:confvar:: CONFIG proxy.config.hostdb.timeout INT 1440
+ :reloadable:
+
The foreground timeout (in minutes).
-``proxy.config.hostdb.strict_round_robin``
-{#proxy.config.hostdb.strict_round_robin}
- ``INT``
- Default: ``0``
- Reloadable.
+.. 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.
@@ -1510,11 +1180,9 @@ entry.
Logging Configuration
=====================
-``proxy.config.log.logging_enabled``
-{#proxy.config.log.logging_enabled}
- ``INT``
- Default: ``3``
- Reloadable.
+.. ts:confvar:: CONFIG proxy.config.log.logging_enabled INT 3
+ :reloadable:
+
Enables and disables event logging:
- ``0`` = logging disabled
@@ -1522,258 +1190,174 @@ Logging Configuration
- ``2`` = log transactions only
- ``3`` = full logging (errors + transactions)
- Refer to ``Working with Log Files <../working-log-files>``_.
+ Refer to `Working with Log Files <../working-log-files>`_.
-``proxy.config.log.max_secs_per_buffer``
-{#proxy.config.log.max_secs_per_buffer}
- ``INT``
- Default: ``5``
- Reloadable.
- The maximum amount of time before data in the buffer is flushed to
- disk.
+.. ts:confvar:: CONFIG proxy.config.log.max_secs_per_buffer INT 5
+ :reloadable:
-``proxy.config.log.max_space_mb_for_logs``
-{#proxy.config.log.max_space_mb_for_logs}
- ``INT``
- Default: ``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.
-
-``proxy.config.log.max_space_mb_for_orphan_logs``
-{#proxy.config.log.max_space_mb_for_orphan_logs}
- ``INT``
- Default: ``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.
-
-``proxy.config.log.max_space_mb_headroom``
-{#proxy.config.log.max_space_mb_headroom}
- ``INT``
- Default: ``10``
- Reloadable.
- The tolerance for the log space limit (in bytes). If the variable
- ``proxy.config.log.auto_delete_rolled_file`` 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 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_file`` 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.
-``proxy.config.log.hostname`` {#proxy.config.log.hostname}
- ``STRING``
- Default: ``localhost``
- Reloadable.
+.. ts:confvar:: CONFIG proxy.config.log.hostname STRING localhost
+ :reloadable:
+
The hostname of the machine running Traffic Server.
-``proxy.config.log.logfile_dir`` {#proxy.config.log.logfile_dir}
- ``STRING``
- Default: ``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.
-
-``proxy.config.log.logfile_perm`` {#proxy.config.log.logfile_perm}
- ``STRING``
- Default: ``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
+.. 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.
-``proxy.config.log.custom_logs_enabled``
-{#proxy.config.log.custom_logs_enabled}
- ``INT``
- Default: ``0``
- Reloadable.
+.. ts:confvar:: CONFIG proxy.config.log.custom_logs_enabled INT 0
+ :reloadable:
+
Enables (``1``) or disables (``0``) custom logging.
-``proxy.config.log.squid_log_enabled``
-{#proxy.config.log.squid_log_enabled}
- ``INT``
- Default: ``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_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:
-``proxy.config.log.squid_log_is_ascii``
-{#proxy.config.log.squid_log_is_ascii}
- ``INT``
- Default: ``1``
- Reloadable.
The squid log file type:
- ``1`` = ASCII
- ``0`` = binary
-``proxy.config.log.squid_log_name``
-{#proxy.config.log.squid_log_name}
- ``STRING``
- Default: ``squid``
- Reloadable.
- The ``squid log <../working-log-files/log-formats#SquidFormat>``_
- filename.
-
-``proxy.config.log.squid_log_header``
-{#proxy.config.log.squid_log_header} : ``STRING`` : Default: ``NULL``
-: The ``squid log <../working-log-files/log-formats#SquidFormat>``_ file
-header text.
-
-``proxy.config.log.common_log_enabled``
-{#proxy.config.log.common_log_enabled}
- ``INT``
- Default: ``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.squid_log_name STRING squid
+ :reloadable:
-``proxy.config.log.common_log_is_ascii``
-{#proxy.config.log.common_log_is_ascii}
- ``INT``
- Default: ``1``
- Reloadable.
- The ``Netscape common
- log <../working-log-files/log-formats#NetscapeFormats>``_ file type:
+ 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
-``proxy.config.log.common_log_name``
-{#proxy.config.log.common_log_name}
- ``STRING``
- Default: ``common``
- Reloadable.
- The ``Netscape common
- log <../working-log-files/log-formats#NetscapeFormats>``_ filename.
-
-``proxy.config.log.common_log_header``
-{#proxy.config.log.common_log_header}
- ``STRING``
- Default: ``NULL``
- Reloadable.
- The ``Netscape common
- log <../working-log-files/log-formats#NetscapeFormats>``_ file header
- text.
-
-``proxy.config.log.extended_log_enabled``
-{#proxy.config.log.extended_log_enabled}
- ``INT``
- Default: ``0``
- Reloadable.
- Enables (``1``) or disables (``0``) the ``Netscape extended log file
- format <../working-log-files/log-formats#NetscapeFormats>``_.
+.. ts:confvar:: CONFIG proxy.config.log.common_log_name STRING common
+ :reloadable:
-``proxy.confg.log.extended_log_is_ascii``
-{#proxy.confg.log.extended_log_is_ascii}
- ``INT``
- Default: ``1``
- The ``Netscape extended
- log <../working-log-files/log-formats#NetscapeFormats>``_ file type:
+ 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
-``proxy.config.log.extended_log_name``
-{#proxy.config.log.extended_log_name}
- ``STRING``
- Default: ``extended``
- The ``Netscape extended
- log <../working-log-files/log-formats#NetscapeFormats>``_ filename.
-
-``proxy.config.log.extended_log_header``
-{#proxy.config.log.extended_log_header}
- ``STRING``
- Default: ``NULL``
- Reloadable.
- The ``Netscape extended
- log <../working-log-files/log-formats#NetscapeFormats>``_ file header
- text.
-
-``proxy.config.log.extended2_log_enabled``
-{#proxy.config.log.extended2_log_enabled}
- ``INT``
- Default: ``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.extended_log_name STRING extended
-``proxy.config.log.extended2_log_is_ascii``
-{#proxy.config.log.extended2_log_is_ascii}
- ``INT``
- Default: ``1``
- Reloadable.
- The ``Netscape Extended-2
- log <../working-log-files/log-formats#NetscapeFormats>``_ file type:
+ 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
-``proxy.config.log.extended2_log_name``
-{#proxy.config.log.extended2_log_name}
- ``STRING``
- Default: ``extended2``
- Reloadable.
- The ``Netscape Extended-2
- log <../working-log-files/log-formats#NetscapeFormats>``_ filename.
-
-``proxy.config.log.extended2_log_header``
-{#proxy.config.log.extended2_log_header}
- ``STRING``
- Default: ``NULL``
- Reloadable.
- The ``Netscape Extended-2
- log <../working-log-files/log-formats#NetscapeFormats>``_ file header
- text.
-
-``proxy.config.log.separate_icp_logs``
-{#proxy.config.log.separate_icp_logs}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), configures Traffic Server to store ICP
- transactions in a separate log file.
+.. 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.
- - ``0`` = separation is disabled, all ICP transactions are recorded
- in the same file as HTTP transactions
+.. 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.
+ - ``-1`` = filter all ICP transactions from the default log files; ICP transactions are not logged anywhere.
-``proxy.config.log.separate_host_logs``
-{#proxy.config.log.separate_host_logs}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), configures Traffic Server to create a separate
- log file for HTTP transactions for each origin server listed in the
- ``log_hosts.config`` file. Refer to ``HTTP Host Log
- Splitting <../working-log-files#HTTPHostLogSplitting>``_.
+.. 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
+ ``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.
+ Set the log collation mode.
===== ======
Value Effect
@@ -1786,192 +1370,131 @@ Value Effect
===== ======
For information on sending XML-based custom formats to the collation
-server, refer to ``logs_xml.config <logs_xml.config>``_.
+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.
-``proxy.confg.log.collation_host`` {#proxy.confg.log.collation_host}
- ``STRING``
- Default: ``NULL``
- The hostname of the log collation server.
+.. 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:
-``proxy.config.log.collation_port``
-{#proxy.config.log.collation_port}
- ``INT``
- Default: ``8085``
- Reloadable.
- The port used for communication between the collation server and
- client.
-
-``proxy.config.log.collation_secret``
-{#proxy.config.log.collation_secret}
- ``STRING``
- Default: ``foobar``
- Reloadable.
- The password used to validate logging data and prevent the exchange
- of unauthorized information when a collation server is being used.
-
-``proxy.config.log.collation_host_tagged``
-{#proxy.config.log.collation_host_tagged}
- ``INT``
- Default: ``0``
- Reloadable.
- When enabled (``1``), configures Traffic Server to include the
- hostname of the collation client that generated the log entry in
- each entry.
-
-``proxy.config.log.collation_retry_sec``
-{#proxy.config.log.collation_retry_sec}
- ``INT``
- Default: ``5``
- Reloadable.
The number of seconds between collation server connection retries.
-``proxy.config.log.rolling_enabled``
-{#proxy.config.log.rolling_enabled}
- ``INT``
- Default: ``1``
- Reloadable.
- Specifies how log files are rolled. You can specify the following
- values:
+.. 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
+ - ``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)
-``proxy.config.log.rolling_interval_sec``
-{#proxy.config.log.rolling_interval_sec}
- ``INT``
- Default: ``86400``
- Reloadable.
- The log file rolling interval, in seconds. The minimum value is
- ``300`` (5 minutes). The maximum value is 86400 seconds (one day).
+.. ts:confvar:: CONFIG proxy.config.log.rolling_interval_sec INT 86400
+ :reloadable:
- **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.
+ The log file rolling interval, in seconds. The minimum value is ``300`` (5 minutes). The maximum, and default, value is 86400 seconds (one day).
-``proxy.config.log.rolling_offset_hr``
-{#proxy.config.log.rolling_offset_hr}
- ``INT``
- Default: ``0``
- Reloadable.
- The file rolling offset hour. The hour of the day that starts the
- log rolling period.
+ **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:
-``proxy.config.log.rolling_size_mb``
-{#proxy.config.log.rolling_size_mb}
- ``INT``
- Default: ``10``
- Reloadable.
The size that log files must reach before rolling takes place.
-``proxy.config.log.auto_delete_rolled_files``
-{#proxy.config.log.auto_delete_rolled_files}
- ``INT``
- Default: ``1``
- Reloadable.
- Enables (``1``) or disables (``0``) automatic deletion of rolled
- files.
+.. ts:confvar:: CONFIG proxy.config.log.auto_delete_rolled_files INT 1
+ :reloadable:
-``proxy.config.log.sampling_frequency``
-{#proxy.config.log.sampling_frequency}
- ``INT``
- Default: ``1``
- Reloadable.
- Configures Traffic Server to log only a sample of transactions
- rather than every transaction. You can specify the following values:
+ 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...
-``proxy.config.http.slow.log.threshold``
-{#proxy.config.http.slow.log.threshold}
- ``INT``
- Default: ``0``
- Reloadable.
- The number of milliseconds before a slow connection's debugging
- stats are dumped. Specify ``1`` to enable or ``0`` to disable.
+.. 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
================================
-``proxy.config.diags.output.diag`` {#proxy.config.diags.output.diag}
-``proxy.config.diags.output.debug`` {#proxy.config.diags.output.debug}
-``proxy.config.diags.output.status``
-{#proxy.config.diags.output.status} ``proxy.config.diags.output.note``
-{#proxy.config.diags.output.note}
-``proxy.config.diags.output.warning``
-{#proxy.config.diags.output.warning}
-``proxy.config.diags.output.error`` {#proxy.config.diags.output.error}
-``proxy.config.diags.output.fatal`` {#proxy.config.diags.output.fatal}
-``proxy.config.diags.output.alert`` {#proxy.config.diags.output.alert}
-``proxy.config.diags.output.emergency``
-{#proxy.config.diags.output.emergency} : ``STRING`` : These options
-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:
+.. 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
- For example, to log debug diagnostics to both syslog and diags.log:
+.. topic:: Example
+
+ To log debug diagnostics to both syslog and diags.log:::
proxy.config.diags.output.debug STRING SL
Reverse Proxy
=============
-``proxy.config.reverse_proxy.enabled``
-{#proxy.config.reverse_proxy.enabled}
- ``INT``
- Default: ``1``
- Reloadable.
+.. ts:confvar:: CONFIG proxy.config.reverse_proxy.enabled INT 1
+ :reloadable:
+
Enables (``1``) or disables (``0``) HTTP reverse proxy.
-``proxy.config.header.parse.no_host_url_redirect``
-{#proxy.config.header.parse.no_host_url_redirect}
- ``STRING``
- Default: ``NULL``
- Reloadable.
+.. 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
===============
-``proxy.config.url_remap.default_to_server_pac``
-{#proxy.config.url_remap.default_to_server_pac}
- ``INT``
- Default: ``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``.
-
-``proxy.config.url_remap.default_to_server_pac_port``
-{#proxy.config.url_remap.default_to_server_pac_port}
- ``INT``
- Default: ``-1``
- Reloadable.
- Sets the PAC port so that PAC requests made to the Traffic Server
+.. 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
@@ -1983,46 +1506,
<TRUNCATED>
[2/2] git commit: format all of records.config to amc's ts:confvar
Posted by ig...@apache.org.
format all of records.config to amc's ts:confvar
We're now using ts:confvar in all of the records.config.
The formatting looks mostly reasonable, except for some of the links.
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/ecbf8f1d
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/ecbf8f1d
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/ecbf8f1d
Branch: refs/heads/master
Commit: ecbf8f1d60d0994b10433edfe462d79dd4ec2acd
Parents: ac4cc37
Author: Igor Galić <i....@brainsware.org>
Authored: Mon Jul 29 12:23:47 2013 +0200
Committer: Igor Galić <i....@brainsware.org>
Committed: Mon Jul 29 12:23:47 2013 +0200
----------------------------------------------------------------------
.../configuration-files/records.config.en.rst | 2067 +++++++-----------
1 file changed, 758 insertions(+), 1309 deletions(-)
----------------------------------------------------------------------