This is an automated email from the ASF dual-hosted git repository.
amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git
The following commit(s) were added to refs/heads/master by this push:
new f75f538 Doc: Minor tweaks to clear up doc build errors.
f75f538 is described below
commit f75f538f390e2f849b9ddc6d2c543332aa2f4f5c
Author: Alan M. Carroll <[email protected]>
AuthorDate: Thu May 17 16:38:08 2018 -0500
Doc: Minor tweaks to clear up doc build errors.
---
.../monitoring/statistics/core-statistics.en.rst | 1 -
doc/admin-guide/plugins/compress.en.rst | 108 ++++++++++-----------
doc/admin-guide/plugins/index.en.rst | 4 +-
doc/appendices/command-line/traffic_layout.en.rst | 12 ++-
.../api/types/TSOverridableConfigKey.en.rst | 1 +
5 files changed, 68 insertions(+), 58 deletions(-)
diff --git a/doc/admin-guide/monitoring/statistics/core-statistics.en.rst
b/doc/admin-guide/monitoring/statistics/core-statistics.en.rst
index 2947ec7..cd75fa8 100644
--- a/doc/admin-guide/monitoring/statistics/core-statistics.en.rst
+++ b/doc/admin-guide/monitoring/statistics/core-statistics.en.rst
@@ -47,7 +47,6 @@ component to which they're related.
core/http-document-size.en
core/http-header.en
core/bandwidth.en
- core/congestion.en
core/socks.en
core/websocket.en
core/misc.en
diff --git a/doc/admin-guide/plugins/compress.en.rst
b/doc/admin-guide/plugins/compress.en.rst
index 29f6b2a..e80ea2d 100644
--- a/doc/admin-guide/plugins/compress.en.rst
+++ b/doc/admin-guide/plugins/compress.en.rst
@@ -20,7 +20,7 @@
.. _admin-plugins-compress:
Compress Plugin
-***********
+***************
This plugin adds compression and decompression options to both origin and cache
responses.
@@ -60,31 +60,31 @@ This plugin can be used as either global plugin or remap
plugin.
It can be enabled globally for |TS| by adding the following to your
:file:`plugin.config`::
- compress.so
+ compress.so
With no further options, this will enable the following default behavior:
-- Enable caching of both compressed and uncompressed versions of origin
+* Enable caching of both compressed and uncompressed versions of origin
responses as :term:`alternates <alternate>`.
-- Compress objects with `text/*` content types for every origin.
+* Compress objects with `text/*` content types for every origin.
-- Don't hide `Accept` encoding headers from origin servers (for an offloading
+* Don't hide `Accept` encoding headers from origin servers (for an offloading
reverse proxy).
-- No URLs are disallowed from compression.
+* No URLs are disallowed from compression.
-- Disable flush (flush compressed content to client).
+* Disable flush (flush compressed content to client).
Alternatively, a configuration may be specified (shown here using the sample
configuration provided with the plugin's source)::
- compress.so <path-to-plugin>/sample.compress.config
+ compress.so <path-to-plugin>/sample.compress.config
This can be used as remap plugin by pointing to config file in remap rule
:file:`remap.config`:: (relative to the ts:cv:`proxy.config.config_dir`)
- @plugin=compress.so @pparam=sample.compress.config
+ @plugin=compress.so @pparam=sample.compress.config
The following sections detail the options you may specify in the plugin's
configuration file. Options may be used globally, or may be specified on a
@@ -138,10 +138,10 @@ When set to ``true`` this option causes the plugin to
strip the request's
``Accept-Encoding`` header when contacting the origin server. Setting this
option to ``false``
will leave the header intact if the client provided it.
-- To ease the load on the origins.
+* To ease the load on the origins.
-- For when the proxy parses responses, and the resulting compression and
- decompression is wasteful.
+* For when the proxy parses responses, and the resulting compression and
+ decompression is wasteful.
supported-algorithms
----------------------
@@ -162,53 +162,53 @@ To establish global defaults for all site requests
passing through |TS|, while
overriding just a handful for requests to content at ``www.example.com``, you
might create a configuration with the following options::
- # Set some global options first
- cache true
- remove-accept-encoding false
- compressible-content-type text/*
- compressible-content-type application/json
- flush false
-
- # Now set a configuration for www.example.com
- [www.example.com]
- cache false
- remove-accept-encoding true
- allow !/notthis/*.js
- allow /this/*.js
- flush true
-
- # Allows brotli encoded response from origin but is not capable of brotli
compression
- [brotli.allowed.com]
- enabled true
- compressible-content-type text/*
- compressible-content-type application/json
- flush true
- supported-algorithms gzip,deflate
-
- # Supports brotli compression
- [brotli.compress.com]
- enabled true
- compressible-content-type text/*
- compressible-content-type application/json
- flush true
- supported-algorithms br,gzip
-
- # This origin does it all
- [bar.example.com]
- enabled false
+ # Set some global options first
+ cache true
+ remove-accept-encoding false
+ compressible-content-type text/*
+ compressible-content-type application/json
+ flush false
+
+ # Now set a configuration for www.example.com
+ [www.example.com]
+ cache false
+ remove-accept-encoding true
+ allow !/notthis/*.js
+ allow /this/*.js
+ flush true
+
+ # Allows brotli encoded response from origin but is not capable of brotli
compression
+ [brotli.allowed.com]
+ enabled true
+ compressible-content-type text/*
+ compressible-content-type application/json
+ flush true
+ supported-algorithms gzip,deflate
+
+ # Supports brotli compression
+ [brotli.compress.com]
+ enabled true
+ compressible-content-type text/*
+ compressible-content-type application/json
+ flush true
+ supported-algorithms br,gzip
+
+ # This origin does it all
+ [bar.example.com]
+ enabled false
Assuming the above options are in a file at
``/etc/trafficserver/compress.config``
the plugin would be enabled for |TS| in :file:`plugin.config` as::
- compress.so /etc/trafficserver/compress.config
+ compress.so /etc/trafficserver/compress.config
Alternatively, the compress plugin can be used as a remap plugin: ::
- map http://www.example.com http://origin.example.com \
- @plugin=compress.so @pparam=compress.config
+ map http://www.example.com http://origin.example.com \
+ @plugin=compress.so @pparam=compress.config
- $ cat /etc/trafficserver/compress.config
- enabled true
- cache true
- compressible-content-type *xml
- supported-algorithms
+ $ cat /etc/trafficserver/compress.config
+ enabled true
+ cache true
+ compressible-content-type *xml
+ supported-algorithms
diff --git a/doc/admin-guide/plugins/index.en.rst
b/doc/admin-guide/plugins/index.en.rst
index 203f826..7b535cd 100644
--- a/doc/admin-guide/plugins/index.en.rst
+++ b/doc/admin-guide/plugins/index.en.rst
@@ -95,9 +95,11 @@ Plugins that are considered stable are installed by default
in |TS| releases.
:doc:`Generator <generator.en>`
Generate arbitrary response data.
-:doc:`GZip <gzip.en>`
+:doc:`Compress <compress.en>`
Compress or deflate cache responses.
+ .. sidebar: Formerly "gzip".
+
:doc:`Header Rewrite <header_rewrite.en>`
Modify requests and responses based on incoming and outgoing headers and
other transaction attributes.
diff --git a/doc/appendices/command-line/traffic_layout.en.rst
b/doc/appendices/command-line/traffic_layout.en.rst
index 8704b58..e9eca56 100644
--- a/doc/appendices/command-line/traffic_layout.en.rst
+++ b/doc/appendices/command-line/traffic_layout.en.rst
@@ -18,7 +18,7 @@
.. include:: ../../common.defs
traffic_layout
-*****************
+**************
Synopsis
========
@@ -36,6 +36,13 @@ Options
Print version information and exit.
+Environment
+===========
+
+.. envvar:: TS_RUNROOT
+
+ The path to the run root file. It has the same effect as the command line
option :option:`--run-root`.
+
Description
=============
Document for the special functionality of ``runroot`` inside
:program:`traffic_layout`. This feature
@@ -82,7 +89,8 @@ Subcommands
Verify the permission of the sandbox.
Subcommands options
---------------
+-------------------
+
- Force option: ::
traffic_layout init --force (--path /path/to/sandbox)
diff --git a/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
b/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
index 10c9cd7..a2d7cea 100644
--- a/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
+++ b/doc/developer-guide/api/types/TSOverridableConfigKey.en.rst
@@ -147,6 +147,7 @@ Enumeration Members
.. c:macro:: TS_CONFIG_HTTP_NORMALIZE_AE
.. c:macro:: TS_CONFIG_HTTP_INSERT_FORWARDED
.. c:macro:: TS_CONFIG_HTTP_ALLOW_MULTI_RANGE
+ .. c:macro:: TS_CONFIG_HTTP_ALLOW_HALF_OPEN
Description
===========
--
To stop receiving notification emails like this one, please contact
[email protected].
