Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README

  • Loading branch information...
commit 2f3e6b0331cb00aa6e5c57c15b770fabc94d02da 1 parent 667da70
@evanmiller authored
Showing with 23 additions and 2 deletions.
  1. +23 −2 README → README.markdown
View
25 README → README.markdown
@@ -1,16 +1,25 @@
mod_zip
--------
+=======
mod_zip assembles ZIP archives dynamically. It can stream component files from
upstream servers with nginx's native proxying code, so that the process never
takes up more than a few KB of RAM at a time, even while assembling archives that
are (potentially) hundreds of megabytes.
+
+Installation
+------------
+
To install, compile nginx with the following option:
--add-module=/path/to/this/directory
-nginx 0.7.25 or later is required.
+nginx 0.7.25 or later is required. If libiconv is present, support for the
+"X-Archive-Charset" header is enabled; see below.
+
+
+Usage
+-----
The module is activated when the original response (presumably from an
upstream) includes the following HTTP header:
@@ -33,6 +42,18 @@ request returns any sort of error, the download is aborted.
The CRC-32 is optional. Put "-" if you don't know the CRC-32; note that in this
case mod_zip will disable support for the "Range" header.
+To re-encode the filenames as UTF-8, add the following header to the upstream
+response:
+
+ X-Archive-Charset: <insert original charset name>
+
+The original charset name should be something that iconv understands. (This feature
+only works if iconv is present.)
+
+
+Tips
+----
+
Tip: Add a header "Content-Disposition: attachment; filename=foobar.zip" in the
upstream response if you would like the client to name the file "foobar.zip"
Please sign in to comment.
Something went wrong with that request. Please try again.