This is a module that is distributed with [http://tengine.taobao.org Tengine] which is a distribution of Nginx that is used by the e-commerce/auction site [http://en.wikipedia.org/wiki/Taobao Taobao.com]. This distribution contains some modules that are new on the Nginx scene. The ''ngx_http_slice_module'' module is one of them.

This is a module that is distributed with [http://tengine.taobao.org Tengine] which is a distribution of Nginx that is used by the e-commerce/auction site [http://en.wikipedia.org/wiki/Taobao Taobao.com]. This distribution contains some modules that are new on the Nginx scene. The ''ngx_http_slice_module'' module is one of them.

−

This module can be thought out as a *reverse byte-range* request header. It's main utility is to allow Nginx to slice a big file in small pieces (byte-ranges) while permitting to use on-the-fly gzip compression.

+

This module can be thought out as a '''reverse byte-range''' request header. It's main utility is to allow Nginx to slice a big file in small pieces (byte-ranges) while permitting to use on-the-fly gzip compression.

A typical example is for allowing someone to download a large video file while keeping the bandwith usage minimal. This might also be used

A typical example is for allowing someone to download a large video file while keeping the bandwith usage minimal. This might also be used

Line 12:

Line 12:

most intuitive for such.

most intuitive for such.

−

Note also that using arguments is more **useful** than byte-ranges in the sense that they can be set in a normal link, while byte ranges

+

Note also that using arguments is more '''useful''' than byte-ranges in the sense that they can be set in a normal link, while byte ranges

require a special [https://en.wikipedia.org/wiki/Byte_serving HTTP header].

require a special [https://en.wikipedia.org/wiki/Byte_serving HTTP header].

Synopsis

This is a module that is distributed with Tengine which is a distribution of Nginx that is used by the e-commerce/auction site Taobao.com. This distribution contains some modules that are new on the Nginx scene. The ngx_http_slice_module module is one of them.

This module can be thought out as a reverse byte-range request header. It's main utility is to allow Nginx to slice a big file in small pieces (byte-ranges) while permitting to use on-the-fly gzip compression.

A typical example is for allowing someone to download a large video file while keeping the bandwith usage minimal. This might also be used
as device for selling a video file by pieces where each link points to different zones of the file splitted by file ranges.

Other use would be to use a generic CSS file and use only part of it for each section of a site. Granted that byte-range slicing isn't the
most intuitive for such.

Note also that using arguments is more useful than byte-ranges in the sense that they can be set in a normal link, while byte ranges
require a special HTTP header.

Installation

2. Add the module to the build configuration by adding
--add-module=/path/to/nginx-http-slice.

3. Build the nginx binary.
4. Install the nginx binary.
5. Configure contexts where concat is enabled.
6. Build your links such that the above format, i.e., all URIs that
correspond to specific ranges. As example here's how to link to
the first 4k of a file.
<a href="http://example.com/datadumps/dump0.sql?start=0&end=4096" />db dump</a>
7. Done.

Tagging releases

Other tengine modules on Github

+ [http concat](https://github.com/taobao/nginx-http-concat):
allows to concatenate a given set of files and ship a single
response from the server. It's particularly useful for **aggregating**
CSS and Javascript files.

+ [footer filter](https://github.com/taobao/nginx-http-footer-filter):
allows to add some extra data (markup or not) at the end of a
request body. It's pratical for things like adding time stamps or
other miscellaneous stuff without having to tweak your application.

Other builds

1. As referred at the outset this module is part of the
[tengine](http://tengine.taobao.org) Nginx distribution. So you
might want to save yourself some work and just build it from
scratch using tengine in lieu if the official Nginx source.

2. If you fancy a bleeding edge Nginx package (from the dev releases)
for Debian made to measure then you might be interested in my
[debian](http://debian.taobao.net/unstable) Nginx
package. Instructions for using the repository and making the
package live happily inside a stable distribution installation are
[provided](http://debian.taobao.net).

License

Copyright (C) 2010-2012 Alibaba Group Holding Limited

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:

1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS "AS IS" AND ANY
EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.