← Back to branch summary

~ubuntu-branches/ubuntu/wily/trafficserver/wily

« back to all changes in this revision

Viewing changes to doc/reference/plugins/gzip.en.rst

  • Committer: Package Import Robot
  • Author(s): Arno Töll
  • Date: 2014-01-29 03:01:12 UTC
  • mfrom: (1.2.3)
  • mto: (5.2.3 sid)
  • mto: This revision was merged to the branch mainline in revision 15.
  • Revision ID: package-import@ubuntu.com-20140129030112-z48a4g1pg5gctz7z
Tags: upstream-4.1.2
Import upstream version 4.1.2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/plugins/gzip.en.rst
 
1
gzip / deflate Plugin
 
2
*********************
 
3
 
 
4
.. Licensed to the Apache Software Foundation (ASF) under one
 
5
   or more contributor license agreements.  See the NOTICE file
 
6
  distributed with this work for additional information
 
7
  regarding copyright ownership.  The ASF licenses this file
 
8
  to you under the Apache License, Version 2.0 (the
 
9
  "License"); you may not use this file except in compliance
 
10
  with the License.  You may obtain a copy of the License at
 
11
 
 
12
   http://www.apache.org/licenses/LICENSE-2.0
 
13
 
 
14
  Unless required by applicable law or agreed to in writing,
 
15
  software distributed under the License is distributed on an
 
16
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 
17
  KIND, either express or implied.  See the License for the
 
18
  specific language governing permissions and limitations
 
19
  under the License.
 
20
 
 
21
 
 
22
This plugin gzips or deflates responses, whichever is applicable. It can
 
23
compress origin respones as well as cached responses. The plugin is built
 
24
and installed as part of the normal Apache Traffic Server installation
 
25
process.
 
26
 
 
27
Installation
 
28
============
 
29
 
 
30
Add the following line to
 
31
```plugin.config`` <../../configuration-files/plugin.config>`_::
 
32
 
 
33
    gzip.so
 
34
 
 
35
In this case, the plugin will use the default behaviour:
 
36
 
 
37
-  Enable caching
 
38
-  Compress text/\* for every origin
 
39
-  Don't hide accept encoding from origin servers (for an offloading
 
40
   reverse proxy)
 
41
-  No urls are disallowed from compression
 
42
 
 
43
Configuration
 
44
=============
 
45
 
 
46
Alternatively, a configuration can also be specified::
 
47
 
 
48
    gzip.so <path-to-plugin>/sample.gzip.config
 
49
 
 
50
After modifying plugin.cofnig, restart traffic server (sudo
 
51
traffic_line -L) the configuration is re-read when a management update
 
52
is given (sudo traffic_line -x)
 
53
 
 
54
Options
 
55
=======
 
56
 
 
57
Flags and options are:
 
58
 
 
59
``enabled``: (``true`` or ``false``) Enable or disable compression for a
 
60
host.
 
61
 
 
62
``remove-accept-encoding``: (``true`` or ``false``) Sets whether the
 
63
plugin should hide the accept encoding from origin servers:
 
64
 
 
65
-  To ease the load on the origins.
 
66
-  For when the proxy parses responses, and the resulting
 
67
   compression/decompression is wasteful.
 
68
 
 
69
``cache``: (``true`` or ``false``) When set, the plugin stores the
 
70
uncompressed and compressed response as alternates.
 
71
 
 
72
``compressible-content-type``: Wildcard pattern for matching
 
73
compressible content types.
 
74
 
 
75
``disallow``: Wildcard pattern for disabling compression on urls.
 
76
 
 
77
Options can be set globally or on a per-site basis, as such::
 
78
 
 
79
    # Set some global options first
 
80
    cache true
 
81
    enabled true
 
82
    remove-accept-encoding false
 
83
    compressible-content-type text/*
 
84
 
 
85
    # Now set a configuration for www.example.com
 
86
    [www.example.com]
 
87
    cache false
 
88
    remove-accept-encoding true
 
89
    disallow /notthis/*.js
 
90
 
 
91
See example.gzip.config for example configurations.