annotate README @ 1:a23404790f33 default tip

Whitespace cleanup, no functional changes.
author Maxim Dounin <mdounin@mdounin.ru>
date Tue, 24 Nov 2009 13:52:31 +0300
parents 18515436c0f1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
1 IP TOS module for nginx.
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
2
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
3 This module was designed to allow setting of ip_tos ip header byte on
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
4 outgoing packets sent by nginx. It may be used to implement smart QoS
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
5 and traffic shaping at firewall/router level.
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
6
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
7 Note that it doesn't try to impose any limits on TOS field and should be used
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
8 with care. At least you probably shouldn't touch two lower bits related
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
9 to ECN.
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
10
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
11 Some TOS related info may be found here:
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
12
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
13 http://en.wikipedia.org/wiki/Type_of_Service
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
14 http://en.wikipedia.org/wiki/Differentiated_services
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
15 http://en.wikipedia.org/wiki/Quality_of_Service
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
16
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
17 Configuration directives:
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
18
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
19 ip_tos (off|0xHH)
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
20
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
21 Context: http, server, location
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
22 Default: off
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
23
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
24 Switches ip tos setting and specifies value to use.
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
25
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
26 Usage:
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
27
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
28 ip_tos 0x00;
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
29
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
30 location /video/ {
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
31 ip_tos 0x10;
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
32 }
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
33
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
34 Note that setting TOS happens at request start and only if configured, so
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
35 keepalive connections may inherit TOS from previous request. It is good
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
36 idea to explicitly set default TOS value at server level (or even at http
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
37 level if the same listening socket used by more than one server).
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
38
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
39 To compile nginx with ip tos module use "--add-module <path>" option to nginx
18515436c0f1 Ip tos filter module.
Maxim Dounin <mdounin@mdounin.ru>
parents:
diff changeset
40 configure.