trafficserver-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From osch...@apache.org
Subject svn commit: r1379868 - /trafficserver/site/trunk/content/docs/trunk/admin/plugins/gzip/index.en.mdtext
Date Sat, 01 Sep 2012 22:02:11 GMT
Author: oschaaf
Date: Sat Sep  1 22:02:11 2012
New Revision: 1379868

URL: http://svn.apache.org/viewvc?rev=1379868&view=rev
Log:
update the gzip documentation


Modified:
    trafficserver/site/trunk/content/docs/trunk/admin/plugins/gzip/index.en.mdtext

Modified: trafficserver/site/trunk/content/docs/trunk/admin/plugins/gzip/index.en.mdtext
URL: http://svn.apache.org/viewvc/trafficserver/site/trunk/content/docs/trunk/admin/plugins/gzip/index.en.mdtext?rev=1379868&r1=1379867&r2=1379868&view=diff
==============================================================================
--- trafficserver/site/trunk/content/docs/trunk/admin/plugins/gzip/index.en.mdtext (original)
+++ trafficserver/site/trunk/content/docs/trunk/admin/plugins/gzip/index.en.mdtext Sat Sep
 1 22:02:11 2012
@@ -18,15 +18,60 @@ Notice:    Licensed to the Apache Softwa
            under the License.
 Navigation: [*](*)
 
-this plugin performs real time compression on textual content streaming in from origin servers
-usage is simple:
+this plugin gzips or deflates or deflates responses, whichever is applicable
+it can compress origin respones as well as cached responses
 
+Usage:
      :::text
-     make
-     make install
+     make && sudo make install
+     add a line to [`plugin.config`](../configuration-files/plugin.config):
+     gzip.so
 
-and add it to [`plugin.config`](../configuration-files/plugin.config). 
+In this case, the plugin will use a default behaviour:
+- use caching
+- compress text/* for every origin
+- don't hide accept encoding from origin servers (for an offloading reverse proxy)
+- no urls are disallowed from compression
 
-Content should now be compressed after restarting traffic server:
+Alternatively, a configuration can also be specified:
+gzip.so <path-to-plugin>/sample.gzip.config
 
-    traffic_server -x
+After modifying plugin.cofnig, restart traffic server (sudo traffic_line -L)
+the configuration is re-read when a management update is given (sudo traffic_line -x)
+
+A sample configuration (sample.gzip.config):
+
+######################################################################
+#flags and options are:
+#
+# remove-accept-encoding: this sets if the plugin should hide the accept encoding from origin
servers
+# - to ease the load on the origins
+# - for when the proxy parses responses, and the resulting compression/decompression
+#   is wastefull
+#
+# cache: when set, the plugin stores the uncompressed and compressed response as alternates
+#
+# compressible-content-type: wildcard pattern for matching compressible content types
+#
+# disallow: wildcard pattern for disablign compression on urls
+######################################################################
+
+#first, we configure the default/global plugin behaviour
+remove-accept-encoding true
+cache false
+
+compressible-content-type text/*
+compressible-content-type *javascript*
+disallow /notthis/*.js
+disallow /notthat*
+disallow */bla*
+
+#override the global configuration for a host.
+#www.foo.nl does NOT inherit anything
+[www.foo.nl]
+remove-accept-encoding true
+compressible-content-type text/*
+
+cache false
+disallow /notthis/*.js
+disallow /notthat*



Mime
View raw message