Repository: trafficserver Updated Branches: refs/heads/master 67a95c776 -> 93f332a0d
update docs with the new config format Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/93f332a0 Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/93f332a0 Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/93f332a0 Branch: refs/heads/master Commit: 93f332a0d53dc7c118c85fc617c98376884c3c9a Parents: 67a95c7 Author: Sudheer Vinukonda <[email protected]> Authored: Fri Oct 31 20:53:29 2014 +0000 Committer: Sudheer Vinukonda <[email protected]> Committed: Fri Oct 31 20:53:29 2014 +0000 ---------------------------------------------------------------------- doc/reference/plugins/background_fetch.en.rst | 26 +++++++++------------- 1 file changed, 11 insertions(+), 15 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/93f332a0/doc/reference/plugins/background_fetch.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/plugins/background_fetch.en.rst b/doc/reference/plugins/background_fetch.en.rst index 364468e..6b91585 100644 --- a/doc/reference/plugins/background_fetch.en.rst +++ b/doc/reference/plugins/background_fetch.en.rst @@ -30,22 +30,20 @@ is not able to cache request / responses with byte ranges. Using the plugin ---------------- -This plugin functions as either a global or per remap plugin, and -it takes an optional argument for specifying a config file with exclusion -criteria. The config file can be specified both via an absolute path or -via a relative path to the install dir +This plugin functions as either a global or per remap plugin, and it takes +an optional argument for specifying a config file with inclusion or +exclusion criteria. The config file can be specified both via an absolute +path or via a relative path to the install dir To activate the plugin in global mode, in :file:`plugin.config`, simply add:: - background_fetch.so --exclude <config-file> + background_fetch.so --config <config-file> To activate the plugin in per remap mode, in :file:`remap.config`, simply append the below to the specific remap line:: @plugin=background_fetch.so @pparam=<config-file> -Note that the config file argument with exclusion is optional - Functionality ------------- @@ -69,20 +67,18 @@ Only one background fetch per URL is ever performed, making sure we do not accidentally put pressure on the origin servers. The plugin now supports a config file that can specify exclusion of background -fetch based on the below criteria: -1. Client-IP -2. Content-Type -3. User-Agent +fetch based on a header or client-ip. To specify the exclusion criteria, the plugin needs to be activated as below: -background_fetch.so --exclude <config-file> +background_fetch.so --config <config-file> The contents of the config-file could be as below: -Client-IP 127.0.0.1 -User-Agent ABCDEF -Content-Type text +exclude Client-IP 127.0.0.1 +include User-Agent ABCDEF +exclude Content-Type text +exclude X-Foo-Bar text The plugin also now supports per remap activation. To activate the plugin for a given remap, add the below on the remap line:
