module config file including usage documentation

10_mod_slotlimit.conf (text/plain), 2.76 KB, created by Guido Jäkel on 2012-03-28 13:38:56 UTC

<IfDefine SLOTLIMIT>
LoadModule slotlimit_module modules/mod_slotlimit.so

# AvailableSlotsPercent
#     Syntax:   AvailableSlotsPercent number
#     Default:  0
# 
#     Percentage of apache slots available in order to set any restrictions.
#     Setting it to 0 dynamic slot allocation algorithm will be deactivated.
#     When has remained free the specified percentage of apache slots, module
#     start to manage incoming connections, penalizing sites that are monopolizing
#     the resources of the server.
# 
#     N.B. Before activating this option check that the apache scoreboard display
#          correct vhost name of the running sites. In order to make this you can
#          activate (momentarily) mod_status and connect to http://yourserver/server-status.
#          If Vhost hostname do not display correctly the name of the sites visited
#          sets up to "On" the directive "ForceVhostName" before using "AvailableSlotsPercent".
# 
# MaxConnectionsPerSite
#     Syntax:   MaxConnectionsPerSite number
#     Default:  No Limit
# 
#     Max connections for each running site
# 
#     N.B. Like for "AvailableSlotsPercent" if Vhost hostname do not display correctly
#          the name of the sites visited sets up to "On" the directive "ForceVhostName".
# 
# ClientIpLimit
#     Syntax:   ClientIpLimit number
#     Default:  40
# 
#     Number of maximum simultaneous connection per IP.
# 
# ForceVhostName
#     Syntax:   ForceVhostName On|Off
#     Default:  Off
# 
#     Force vhost hostname in scoreboard. Vhost hostname do not match site
#     visited under some conditions, for example with some mass virtual hosting technique.
#     In order to check that this is not your case you can use mod_status.
#     Setting this directive to On, mod_slotlimit will overwrite vhost hostname
#     in apache scoreboard.
# 
# CustomErrMsg
#     Syntax:   CustomErrMsg "My custom error message"
#     Default:  "Blocked by mod_slotlimit. More information about this error may be available in the server error log."
# 
#     A custom error message that allows you to replace default error message with one you create
# 
# CustomLimitsFile
#     Syntax: CustomLimitsFile /path/to/file
#     Default:  No Value
# 
#     Using this directive you can specify limits customized for each running site,
#     penalizing or privileged it. In the file should be stored (line by line) the
#     site name and the number of usable slots. You can add comments by using the '#'
#     character. The file format is as follows:
# 
#     ..
#     ..
#     www.sitename1.it 10
#     # this is a comment
#     www.site2.com 35
#     ..
#     ..

# Example:
# AvailableSlotsPercent 13
# MaxConnectionsPerSite 20
# ClientIpLimit 20
# CustomLimitsFile /etc/apache2/mod_slotlimit.rules

</IfDefine>

# vim: ts=4 filetype=apache