diff README @ 0:6535d94ae07d

Compose filter module skeleton, currently does nothing.
author Maxim Dounin <mdounin@mdounin.ru>
date Sat, 12 Jul 2008 19:23:17 +0400
parents
children
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/README
@@ -0,0 +1,18 @@
+Compose module for nginx.
+
+This module allows compose several subrequests into one reply.  The
+same thing may be achieved by SSI, but unlike SSI this module will also
+set Content-Length and allow range requests.
+
+Basically it grabs X-Compose and X-Compose-Length headers from original
+reply and does the following:
+
+    1. If X-Compose-Length present, sets Content-Length to it's value.
+    2. Composes multiple subrequests from X-Compose headers.
+
+When used without X-Compose-Length it's basically identical to SSI and
+not needed.  The X-Compose-Length header must be calculated correctly by
+somebody.
+
+To compile nginx with compose module, use "--add-module <path>" option to
+nginx configure.