Skip to content

Commit

Permalink
updated README to reflect recent changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
agentzh committed Jun 2, 2010
1 parent 00c986f commit 75b1bfa
Show file tree
Hide file tree
Showing 2 changed files with 52 additions and 15 deletions.
39 changes: 30 additions & 9 deletions README
Expand Up @@ -6,9 +6,9 @@ Name
installation instructions.

Version
This document describes headers-more-nginx-module v0.08
(<http://github.com/agentzh/headers-more-nginx-module/downloads >)
released on March 12, 2010.
This document describes headers-more-nginx-module v0.09
(<http://github.com/agentzh/headers-more-nginx-module/tarball/v0.09 >)
released on June 2, 2010.

Synopsis
# set the Server output header
Expand Down Expand Up @@ -158,6 +158,14 @@ Directives

See more_set_headers for more details.

Wildcard "*" can also be used to specify a header name pattern. For
example, the following directive effectively clears *any* output headers
starting by ""X-Hidden-"":

more_clear_headers 'X-Hidden-*';

The "*" wildcard support was first introduced in v0.09.

more_set_input_headers
syntax: *more_set_input_headers [-r] [-t <content-type list>]...
<new-header>...*
Expand Down Expand Up @@ -231,9 +239,9 @@ Installation
Compatibility
The following versions of Nginx should work with this module:

* 0.8.x (last tested version is 0.8.34)
* 0.8.x (last tested version is 0.8.39)

* 0.7.x >= 0.7.44 (last tested version is 0.7.64)
* 0.7.x >= 0.7.44 (last tested version is 0.7.65)

Earlier versions of Nginx like 0.6.x and 0.5.x will *not* work.

Expand All @@ -256,6 +264,15 @@ Source Repository
(<http://github.com/agentzh/headers-more-nginx-module >).

ChangeLog
v0.09
* fixed a memory initialization issue for more_set_input_headers
without the "-r" option, we should always initialize "hv.replace"
even when replace == 0. This may result in server segfaults and was
introduced in v0.08.

* implemented wildcard support in more_clear_headers. Thanks Bernd
Dorn.

v0.08
* applied the patch from Bernd Dorn to add the "-r" option to the
more_set_input_headers directive.
Expand Down Expand Up @@ -310,20 +327,24 @@ Getting involved
You'll be very welcomed to submit patches to the author or just ask for
a commit bit to the source repository on GitHub.

Author
Authors
agentzh (章亦春) *<agentzh@gmail.com>*

Bernd Dorn ( http://www.lovelysystems.com/ )

This wiki page is also maintained by the author himself, and everybody
is encouraged to improve this page as well.

Copyright & License
The code base is borrowed directly from the standard headers module in
Nginx 0.8.24. This part of code is copyrighted by Igor Sysoev.

Copyright (c) 2009, Taobao Inc., Alibaba Group ( http://www.taobao.com
).
Copyright (c) 2009-2010, Taobao Inc., Alibaba Group (
http://www.taobao.com ).

Copyright (c) 2009-2010, agentzh <agentzh@gmail.com>.

Copyright (c) 2009, agentzh <agentzh@gmail.com>.
Copyright (c) 2010, Bernd Dorn.

This module is licensed under the terms of the BSD license.

Expand Down
28 changes: 22 additions & 6 deletions doc/readme.wiki
Expand Up @@ -6,7 +6,7 @@

= Version =

This document describes headers-more-nginx-module [http://github.com/agentzh/headers-more-nginx-module/downloads v0.08] released on March 12, 2010.
This document describes headers-more-nginx-module [http://github.com/agentzh/headers-more-nginx-module/tarball/v0.09 v0.09] released on June 2, 2010.

= Synopsis =

Expand Down Expand Up @@ -169,6 +169,14 @@ or

See [[#more_set_headers|more_set_headers]] for more details.

Wildcard <code>*</code> can also be used to specify a header name pattern. For example, the following directive effectively clears ''any'' output headers starting by "<code>X-Hidden-</code>":

<geshi lang="nginx">
more_clear_headers 'X-Hidden-*';
</geshi>

The <code>*</code> wildcard support was first introduced in [[#v0.09|v0.09]].

== more_set_input_headers ==
'''syntax:''' ''more_set_input_headers [-r] [-t <content-type list>]... <new-header>...''

Expand Down Expand Up @@ -239,8 +247,8 @@ Download the latest version of the release tarball of this module from [http://g

The following versions of Nginx should work with this module:

* '''0.8.x''' (last tested version is 0.8.34)
* '''0.7.x >= 0.7.44''' (last tested version is 0.7.64)
* '''0.8.x''' (last tested version is 0.8.39)
* '''0.7.x >= 0.7.44''' (last tested version is 0.7.65)
Earlier versions of Nginx like 0.6.x and 0.5.x will ''not'' work.

Expand All @@ -259,6 +267,10 @@ Available on github at [http://github.com/agentzh/headers-more-nginx-module agen

= ChangeLog =

== v0.09 ==
* fixed a memory initialization issue for [[#more_set_input_headers|more_set_input_headers]] without the <code>-r</code> option, we should always initialize <code>hv.replace</code> even when replace == 0. This may result in server segfaults and was introduced in [[#v0.08|v0.08]].
* implemented wildcard support in [[#more_clear_headers|more_clear_headers]]. Thanks Bernd Dorn.
== v0.08 ==
* applied the patch from Bernd Dorn to add the <code>-r</code> option to the [[#more_set_input_headers|more_set_input_headers]] directive.
Expand Down Expand Up @@ -301,19 +313,23 @@ Some parts of the test suite requires modules [[NginxHttpProxyModule|proxy]], [[

You'll be very welcomed to submit patches to the [[#Author|author]] or just ask for a commit bit to the [[#Source Repository|source repository]] on GitHub.

= Author =
= Authors =

agentzh (章亦春) ''<agentzh@gmail.com>''

Bernd Dorn ( http://www.lovelysystems.com/ )

This wiki page is also maintained by the author himself, and everybody is encouraged to improve this page as well.

= Copyright & License =

The code base is borrowed directly from the standard [[NginxHttpHeadersModule|headers]] module in Nginx 0.8.24. This part of code is copyrighted by Igor Sysoev.

Copyright (c) 2009, Taobao Inc., Alibaba Group ( http://www.taobao.com ).
Copyright (c) 2009-2010, Taobao Inc., Alibaba Group ( http://www.taobao.com ).

Copyright (c) 2009-2010, agentzh <agentzh@gmail.com>.

Copyright (c) 2009, agentzh <agentzh@gmail.com>.
Copyright (c) 2010, Bernd Dorn.

This module is licensed under the terms of the BSD license.

Expand Down

0 comments on commit 75b1bfa

Please sign in to comment.