mod_bw/contribs8/mod_bw-0.8.conf

# This is the Apache server configuration file for the mod_bw bandwidth
# administration module

LoadModule bw_module modules/mod_bw.so

# You need to set this to On, for the mod to work.. By default, the mod is
# disabled, and wont limit anything.
# 
# Example :
#           BandWidthModule On
# 
# BandWidthModule [On|Off]

BandWidthModule On

# When enabled (disabled by default) the log will output lots of data to the
# error log. This data is for debugging purposes, and is usually not needed.
# If you are curious, you can enable. Please note, that this will make your
# logs grow a LOT.
#    
# Example :
#           BandWidthDebug On
# 
# BandWidthDebug [On|Off]
 
# By default, the mod will catch every request. This was done because it is
# easier to configure.
# if you disable it, you will have to add the output filter by hand. This is
# useful is you want only some request being processed by bw_mod.
#    
# Example :
#           ForceBandWidthModule Off
#           AddOutputFilterByType BW_MOD text/html text/plain
# 
# ForceBandWidthModule [On|Off]

# This takes 2 parameters. From is the origin of the connections. It could
# be a full host, part of a domain, an ip address, a network mask (i.e
# 192.168.0.0/24 or 192.168.0.0/255.255.255.0) or all.
# The second parameter indicates the total speed available to the Origin.
# If speed is 0, there is no limit.
# 
# Example :
#         BandWidth localhost 10240
#         BandWidth 192.168.218.5 0
# 
#         ( Order is relevant. First entries have precedence )
# 
# BandWidth [From] [bytes/s]

# This takes 2 parameters. From is the origin of the connections. It could
# be a full host, part of a domain, an ip address, a network mask (i.e
# 192.168.0.0/24 or 192.168.0.0/255.255.255.0) or all.
# The second parameter indicates the minimun speed each client will have.
# What does this mean ? If you have a total of 100kbytes speed, and you put
# MinBandWidth at 50kbytes, it doesnt matter how many clients you have, all
# of them will have at minimun 50kbytes of total speed to download.
# If speed is 0, you will be using the default minimun (256 bytes/s).
# There is a special value of -1. This value means that each client, will
# have a top speed determined by the BandWidth directive. See the examples.
# 
# Examples :
#           BandWidth    all 102400
#           MinBandWidth all 50000
#  
#          The example above, will have a top speed of 100kb for the 1°
#         client. If more clients come, it will be splitted accordingly but
#         everyone will have at least 50kb (even if you have 50 clients)
# 
#           BandWidth    all 50000
#           MinBandWidth all -1
# 
#          This example, makes everyone have 50kb as top speed.
# 
# MinBandWidth [From] [bytes/s]

# Type, is the last part of a file, or * for all. You can use .tgz to match 
# only tar-compressed files, .avi to match video files, or * to match all.
# Minimum Size, is the size (in kbytes) of the file, to be matched. That way
# you can match huge video files that hog your bandwidth.
# The last parameter... is obvious. The speed allowed.
# 
# Example :
#          LargeFileLimit .avi 500 10240
# 
#          This limits .avi files over (or equal to) 500kb to 10kbytes/s
# 
# LargeFileLimit [Type] [Minimum Size] [bytes/s]

# Probably you never need to touch this. It defaults to 8192 which is good
# for almost any speed.
# It must be a size between 1024 and 131072. A Small packet will cause the
# top speed to be lower, and the mod using more time splitting. If you use
# a Size too big, the mod will adjust it to lower speeds.
# 
# BandWidthPacket [Size]

# This directives is useful to deliver a personalized error code.
# At default, when maxconnections is reached, the mod will issue a 503 
# HTTP_SERVICE_UNAVAILABLE code. For some users, it is annoying to have an
# error message, and dont knowing why. You could use an ErrorDocument to 
# point error 503 to a page explaining that you are under a heavy load of
# connections, but sometimes 503 isn't issued by the mod.
# So, with this directive, you can set the error code to return when
# maxconnections is reached. You can use any error code between 300 and 599.
# Please note, that some of the error codes are already used, so before using
# any number, take a look to a list of the codes (search for http error codes
# in google). 
# When testing, i've used the error code 510, which hasn't been defined yet.
# 
# And Example, with Personalized Error Page :
# 
#   ErrorDocument 510 /errors/maxconexceeded.html
#   BandWidthError 510
# 
# Note : Sometimes, the personalized page didn't appear. I'm not sure, but
#       in many cases, it got fixed, by making the page size over 1024bytes.
#        Anyways, if you need help using ErrorDocument, refer to the apache
#       Documentation.
# 
# BandWidthError [Error]

# This takes 2 parameters. From is the origin of the connections. It could
# be a full host, part of a domain, an ip address, a network mask (i.e
# 192.168.0.0/24 or 192.168.0.0/255.255.255.0) or all.
# The second parameter, is the max connections allowed from the origin. Any
# connection over Max, will get a 503 Service Temporarily Unavailable
# 
# There is a catch. You NEED to have a BandWidth limit for the same origin.
# It doesnt need to be a low limit. You can use an unlimited setting.
# You might wonder why. It's because im using them same memory space of the
# bandwidth limit, to count the connections, so i can save memory space.
# If you dont put a BandWidth using the same origin, MaxConnections will be
# ignored.
# 
# Example :
#           BandWidth all 0
#           MaxConnection all 20
# or
#           BandWidth all 0
#           BandWidth 192.168.0.0/24 10240
#           MaxConnection all 20
#           MaxConnection 192.168.0.0/24 5
# 
# 
# Please, rememeber that every speed, will depend mostly on your connection.
# You cant get more speed if you dont have it.
# 
# Remember also.. if you dont follow the instructions, and get some weird 
# results, recheck your config before sending me an email.
# 
# MaxConnection [From] [Max]

# <VirtualHost *>
#     BandWidthModule On
#     BandWidth all 16384
#     LargeFileLimit * 500 4096
#       <Directory />
#           LargeFileLimit * 100 1024
#       </Directory>
# </VirtualHost>
# 
# This wont limit Directory / to 16384. The Directory wont "inherit" the
# settings from the vhost if you use some of the mod's directives.

# VirtualHost example with bandwidth limitation:
# For more information, look at bw_mod documentation.
# In this example, we restrict the bandwidth to 10kb 
# for the connections coming from localhost.
# And we set the bandwidth unlimited for any other
# connections.
# We set maximum amount of concurrent connections as 40.
# When the bandwidth is exceeded, the visitors see the 
# personalized error code no 510. 
#
#<VirtualHost *>
#    ServerAdmin webmaster@dummy-host.example.com
#    DocumentRoot /www/docs/dummy-host.example.com
#    ServerName dummy-host.example.com
#    ErrorLog logs/dummy-host.example.com-error_log
#    CustomLog logs/dummy-host.example.com-access_log common
#    <IfModule mod_bw.c>   
#        BandWidthModule On
#        BandWidthDebug Off
#        BandWidth localhost 10240
#        BandWidth all 0
#        MaxConnection all 40
#        BandWidthError 510
#    </IfModule>
#</VirtualHost>

1	slords	1.1	# This is the Apache server configuration file for the mod_bw bandwidth
2			# administration module
3
4			LoadModule bw_module modules/mod_bw.so
5
6			# You need to set this to On, for the mod to work.. By default, the mod is
7			# disabled, and wont limit anything.
8			#
9			# Example :
10			# BandWidthModule On
11			#
12			# BandWidthModule [On\|Off]
13
14			BandWidthModule On
15
16			# When enabled (disabled by default) the log will output lots of data to the
17			# error log. This data is for debugging purposes, and is usually not needed.
18			# If you are curious, you can enable. Please note, that this will make your
19			# logs grow a LOT.
20			#
21			# Example :
22			# BandWidthDebug On
23			#
24			# BandWidthDebug [On\|Off]
25
26			# By default, the mod will catch every request. This was done because it is
27			# easier to configure.
28			# if you disable it, you will have to add the output filter by hand. This is
29			# useful is you want only some request being processed by bw_mod.
30			#
31			# Example :
32			# ForceBandWidthModule Off
33			# AddOutputFilterByType BW_MOD text/html text/plain
34			#
35			# ForceBandWidthModule [On\|Off]
36
37			# This takes 2 parameters. From is the origin of the connections. It could
38			# be a full host, part of a domain, an ip address, a network mask (i.e
39			# 192.168.0.0/24 or 192.168.0.0/255.255.255.0) or all.
40			# The second parameter indicates the total speed available to the Origin.
41			# If speed is 0, there is no limit.
42			#
43			# Example :
44			# BandWidth localhost 10240
45			# BandWidth 192.168.218.5 0
46			#
47			# ( Order is relevant. First entries have precedence )
48			#
49			# BandWidth [From] [bytes/s]
50
51			# This takes 2 parameters. From is the origin of the connections. It could
52			# be a full host, part of a domain, an ip address, a network mask (i.e
53			# 192.168.0.0/24 or 192.168.0.0/255.255.255.0) or all.
54			# The second parameter indicates the minimun speed each client will have.
55			# What does this mean ? If you have a total of 100kbytes speed, and you put
56			# MinBandWidth at 50kbytes, it doesnt matter how many clients you have, all
57			# of them will have at minimun 50kbytes of total speed to download.
58			# If speed is 0, you will be using the default minimun (256 bytes/s).
59			# There is a special value of -1. This value means that each client, will
60			# have a top speed determined by the BandWidth directive. See the examples.
61			#
62			# Examples :
63			# BandWidth all 102400
64			# MinBandWidth all 50000
65			#
66			# The example above, will have a top speed of 100kb for the 1°
67			# client. If more clients come, it will be splitted accordingly but
68			# everyone will have at least 50kb (even if you have 50 clients)
69			#
70			# BandWidth all 50000
71			# MinBandWidth all -1
72			#
73			# This example, makes everyone have 50kb as top speed.
74			#
75			# MinBandWidth [From] [bytes/s]
76
77			# Type, is the last part of a file, or * for all. You can use .tgz to match
78			# only tar-compressed files, .avi to match video files, or * to match all.
79			# Minimum Size, is the size (in kbytes) of the file, to be matched. That way
80			# you can match huge video files that hog your bandwidth.
81			# The last parameter... is obvious. The speed allowed.
82			#
83			# Example :
84			# LargeFileLimit .avi 500 10240
85			#
86			# This limits .avi files over (or equal to) 500kb to 10kbytes/s
87			#
88			# LargeFileLimit [Type] [Minimum Size] [bytes/s]
89
90			# Probably you never need to touch this. It defaults to 8192 which is good
91			# for almost any speed.
92			# It must be a size between 1024 and 131072. A Small packet will cause the
93			# top speed to be lower, and the mod using more time splitting. If you use
94			# a Size too big, the mod will adjust it to lower speeds.
95			#
96			# BandWidthPacket [Size]
97
98			# This directives is useful to deliver a personalized error code.
99			# At default, when maxconnections is reached, the mod will issue a 503
100			# HTTP_SERVICE_UNAVAILABLE code. For some users, it is annoying to have an
101			# error message, and dont knowing why. You could use an ErrorDocument to
102			# point error 503 to a page explaining that you are under a heavy load of
103			# connections, but sometimes 503 isn't issued by the mod.
104			# So, with this directive, you can set the error code to return when
105			# maxconnections is reached. You can use any error code between 300 and 599.
106			# Please note, that some of the error codes are already used, so before using
107			# any number, take a look to a list of the codes (search for http error codes
108			# in google).
109			# When testing, i've used the error code 510, which hasn't been defined yet.
110			#
111			# And Example, with Personalized Error Page :
112			#
113			# ErrorDocument 510 /errors/maxconexceeded.html
114			# BandWidthError 510
115			#
116			# Note : Sometimes, the personalized page didn't appear. I'm not sure, but
117			# in many cases, it got fixed, by making the page size over 1024bytes.
118			# Anyways, if you need help using ErrorDocument, refer to the apache
119			# Documentation.
120			#
121			# BandWidthError [Error]
122
123			# This takes 2 parameters. From is the origin of the connections. It could
124			# be a full host, part of a domain, an ip address, a network mask (i.e
125			# 192.168.0.0/24 or 192.168.0.0/255.255.255.0) or all.
126			# The second parameter, is the max connections allowed from the origin. Any
127			# connection over Max, will get a 503 Service Temporarily Unavailable
128			#
129			# There is a catch. You NEED to have a BandWidth limit for the same origin.
130			# It doesnt need to be a low limit. You can use an unlimited setting.
131			# You might wonder why. It's because im using them same memory space of the
132			# bandwidth limit, to count the connections, so i can save memory space.
133			# If you dont put a BandWidth using the same origin, MaxConnections will be
134			# ignored.
135			#
136			# Example :
137			# BandWidth all 0
138			# MaxConnection all 20
139			# or
140			# BandWidth all 0
141			# BandWidth 192.168.0.0/24 10240
142			# MaxConnection all 20
143			# MaxConnection 192.168.0.0/24 5
144			#
145			#
146			# Please, rememeber that every speed, will depend mostly on your connection.
147			# You cant get more speed if you dont have it.
148			#
149			# Remember also.. if you dont follow the instructions, and get some weird
150			# results, recheck your config before sending me an email.
151			#
152			# MaxConnection [From] [Max]
153
154			# <VirtualHost *>
155			# BandWidthModule On
156			# BandWidth all 16384
157			# LargeFileLimit * 500 4096
158			# <Directory />
159			# LargeFileLimit * 100 1024
160			# </Directory>
161			# </VirtualHost>
162			#
163			# This wont limit Directory / to 16384. The Directory wont "inherit" the
164			# settings from the vhost if you use some of the mod's directives.
165
166			# VirtualHost example with bandwidth limitation:
167			# For more information, look at bw_mod documentation.
168			# In this example, we restrict the bandwidth to 10kb
169			# for the connections coming from localhost.
170			# And we set the bandwidth unlimited for any other
171			# connections.
172			# We set maximum amount of concurrent connections as 40.
173			# When the bandwidth is exceeded, the visitors see the
174			# personalized error code no 510.
175			#
176			#<VirtualHost *>
177			# ServerAdmin webmaster@dummy-host.example.com
178			# DocumentRoot /www/docs/dummy-host.example.com
179			# ServerName dummy-host.example.com
180			# ErrorLog logs/dummy-host.example.com-error_log
181			# CustomLog logs/dummy-host.example.com-access_log common
182			# <IfModule mod_bw.c>
183			# BandWidthModule On
184			# BandWidthDebug Off
185			# BandWidth localhost 10240
186			# BandWidth all 0
187			# MaxConnection all 40
188			# BandWidthError 510
189			# </IfModule>
190			#</VirtualHost>
191