TS-2117 editing hipes plugin documentation
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/a701121f Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/a701121f Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/a701121f Branch: refs/heads/5.0.x Commit: a701121fcc0fa44611a5413239a17de1f98be28d Parents: 65630cd Author: Kit Chan <kic...@apache.org> Authored: Thu Dec 26 09:24:58 2013 -0800 Committer: Kit Chan <kic...@apache.org> Committed: Thu Dec 26 09:24:58 2013 -0800 ---------------------------------------------------------------------- doc/reference/plugins/hipes.en.rst | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/trafficserver/blob/a701121f/doc/reference/plugins/hipes.en.rst ---------------------------------------------------------------------- diff --git a/doc/reference/plugins/hipes.en.rst b/doc/reference/plugins/hipes.en.rst index 2d6daa5..e74a58a 100644 --- a/doc/reference/plugins/hipes.en.rst +++ b/doc/reference/plugins/hipes.en.rst @@ -66,7 +66,7 @@ HTTP Pipes (aka HIPES and pronounced "Hippies") allows data services to be pipel Example ======= -1. ATS is run on port 80 and apache HTTP web server is run on port 8080 +1. ATS is run on port 80 and apache HTTP web server is run on port 8080 on localhost (127.0.0.1) 2. The HIPES plugin is used in ``remap.config`` :: @@ -74,23 +74,23 @@ Example map http://127.0.0.1/svc_reverse http://nosuchhost @plugin=hipes.so @pparam=service:127.0.0.1:8080 @pparam=path:svc_reverse.php @pparam=server:127.0.0.1 map http://127.0.0.1/test.txt http://127.0.0.1:8080/test.txt -3. The plugin remaps the incoming URL such as +3. The plugin remaps the incoming URL such as :: - ``http://127.0.0.1/svc_reverse/svc_case;case=u/test.txt`` + http://127.0.0.1/svc_reverse/svc_case;case=u/test.txt -to the following +to the following :: - ``http://127.0.0.1:8080/svc_reverse?url=http%3A%2F%2F127.0.0.1%2Fsvc_case%3Bcase%3Du%2Ftest.txt`` + http://127.0.0.1:8080/svc_reverse?url=http%3A%2F%2F127.0.0.1%2Fsvc_case%3Bcase%3Du%2Ftest.txt -3. The service ``svc_reverse.php`` fetches the ``url`` from the ATS again and the plugin remaps the URL +4. The service ``svc_reverse.php`` fetches the ``url`` from the ATS again and the plugin remaps the URL :: - ``http://127.0.0.1/svc_case;case=u/test.txt`` + http://127.0.0.1/svc_case;case=u/test.txt -to this URL +to this URL :: - ``http://127.0.0.1:8080/svc_case.php?case=u&url=http%3A%2F%2F127.0.0.1%2Ftest.txt`` + http://127.0.0.1:8080/svc_case.php?case=u&url=http%3A%2F%2F127.0.0.1%2Ftest.txt -4. In this example, the service ``svc_case.php`` fetches and transforms the response of ``http://127.0.0.1/test.txt`` (which ATS proxies the request to a local file) to upper case. And subsequently the service ``svc_reverse.php`` receives the response and reverse the order before the response is sent back to the client by ATS. +5. In this example, the service ``svc_case.php`` fetches and transforms the response of ``http://127.0.0.1/test.txt`` (which ATS proxies the request to a local file) to upper case. And subsequently the service ``svc_reverse.php`` receives the response and reverse the order before the response is sent back to the client by ATS. Notes on reducing traffic ========================= @@ -102,13 +102,13 @@ Modification to above example to reduce traffic using redirect 1. The service ``svc_reverse.php`` is modified to add a header of ``X-HIPES-Redirect: 2`` to the request made against ``url``. -2. HIPES plugin will instruct ATS to return a redirect response to this url +2. HIPES plugin will instruct ATS to return a redirect response to this url :: - ``http://127.0.0.1:8080/svc_case.php?case=u&url=http%3A%2F%2F127.0.0.1%2Ftest.txt`` + http://127.0.0.1:8080/svc_case.php?case=u&url=http%3A%2F%2F127.0.0.1%2Ftest.txt for the following request - ``http://127.0.0.1/svc_case;case=u/test.txt`` + http://127.0.0.1/svc_case;case=u/test.txt -3. The service ``svc_reverse.php`` is also modified to follow the redirect. Thus the response of the service of ``svc_case`` will not pass through ATS and will pass to ``svc_reverse`` service instead. +3. The service ``svc_reverse.php`` is also modified to follow the redirect. Thus the response of the service of ``svc_case.php`` will not pass through ATS and will pass to ``svc_reverse.php`` service instead.