1 # qwebirc configuration file
3 # This a Python program that is imported, so feel free to use any
6 # Note that some changes to this configuration file require re-running
7 # compile.py and others require restarting qwebirc (and some require
9 # If in doubt always re-compile and restart.
11 # The following line is required, don't remove it!
12 from qwebirc.config_options import *
15 # ---------------------------------------------------------------------
18 # Hostname (or IP address) of IRC server to connect to.
20 # Port of IRC server to connect to.
21 IRCSERVER, IRCPORT = "irc.myserver.com", 6667
24 # SSL port of IRC server to connect to.
25 # If this option is uncommented it will override IRCPORT.
29 # The realname field of IRC clients will be set to this value.
30 REALNAME = "http://moo.com/"
33 # ident to use on irc, possible values include:
34 # - a string, e.g. IDENT = "webchat"
35 # - the literal value IDENT_HEX, this will set the ident to the
36 # a hexadecimal version of the users IP address, e.g
38 # - the literal value IDENT_NICKNAME, this will use the users
39 # supplied nickname as their ident.
43 # The IP address to bind to when connecting to the IRC server.
45 # This will not change the IP address that qwebirc listens on.
46 # You will need to call run.py with the --ip/-i option if you
48 #OUTGOING_IP = "127.0.0.1"
51 # This option controls how the IP/hostname of the connecting
52 # browser will be sent to IRC.
54 # Possible values include:
55 # - the string "webirc", i.e. WEBIRC_MODE = "webirc"
56 # Use WEBIRC type blocks, with a server configuration of
57 # the following style:
61 # hostname <qwebirc's ip address>;
62 # password <password>;
65 # Remember to set the WEBIRC_PASSWORD value to be the
67 # - the string "cgiirc", i.e. WEBIRC_MODE = "cgiirc"
68 # old style CGIIRC command, set CGIIRC_STRING to be the
69 # command used to set the ip/hostname, and set
70 # WEBIRC_PASSWORD to be the password used in the server's
72 # - the literal value None, i.e. WEBIRC_MODE = None
73 # Send the IP and hostname in the realname field, overrides
74 # the REALNAME option.
77 # OPTION: WEBIRC_PASSWORD
78 # Used for WEBIRC_MODE webirc and cgiirc, see WEBIRC_MODE
79 # option documentation.
80 #WEBIRC_PASSWORD = "fish"
82 # OPTION: CGIIRC_STRING
83 # Command sent to IRC server in for cgiirc WEBIRC_MODE.
84 # See WEBIRC_MODE option documentation.
85 #CGIIRC_STRING = "CGIIRC"
88 # ---------------------------------------------------------------------
91 # URL that this qwebirc instance will be available at, add the
92 # port number if your instance runs on a port other than 80.
93 BASE_URL = "http://foo.foo.org/"
95 # OPTION: NETWORK_NAME
96 # The name of your IRC network, displayed throughout the
98 NETWORK_NAME = "FooNet"
100 # OPTION: ANALYTICS_HTML
101 # If you have an analytics service, you can paste the HTML
102 # between the triple quotes.
103 #ANALYTICS_HTML = """
107 # The title of the application in the web browser.
108 APP_TITLE = NETWORK_NAME + " Web IRC"
110 # NICKNAME VALIDATION OPTIONS
111 # ---------------------------------------------------------------------
113 # OPTION: NICKNAME_VALIDATE
114 # If True then user nicknames will be validated according to
115 # the configuration below, otherwise they will be passed
116 # directly to the ircd.
117 NICKNAME_VALIDATE = True
119 # OPTION: NICKNAME_VALID_FIRST_CHAR
120 # A string containing valid characters for the first letter of
122 # Default is as in RFC1459.
124 NICKNAME_VALID_FIRST_CHAR = string.letters + "_[]{}`^\\|"
126 # OPTION: NICKNAME_VALID_SUBSEQUENT_CHAR
127 # A string containing valid characters for the rest of the
129 NICKNAME_VALID_SUBSEQUENT_CHARS = NICKNAME_VALID_FIRST_CHAR + string.digits + "-"
131 # OPTION: NICKNAME_MINIMUM_LENGTH
132 # Minimum characters permitted in a nickname on your network.
133 NICKNAME_MINIMUM_LENGTH = 2
135 # OPTION: NICKNAME_MAXIMUM_LENGTH
136 # Maximum characters permitted in a nickname on your network.
137 # Ideally we'd extract this from the ircd, but we need to know
139 NICKNAME_MAXIMUM_LENGTH = 15
142 # ---------------------------------------------------------------------
144 # These options control the feedback module, which allows users to
145 # send feedback directly from qwebirc (via email).
147 # OPTION: FEEDBACK_FROM
148 # E-mail address that feedback will originate from.
149 FEEDBACK_FROM = "moo@moo.com"
151 # OPTION: FEEDBACK_TO:
152 # E-mail address that feedback will be sent to.
153 FEEDBACK_TO = "moo@moo.com"
155 # OPTION: FEEDBACK_SMTP_HOST
156 # Hostname/IP address of SMTP server feedback will be sent
158 # OPTION: FEEDBACK_SMTP_PORT
159 # Port of SMTP server feedback will be sent through.
160 FEEDBACK_SMTP_HOST, FEEDBACK_SMTP_PORT = "127.0.0.1", 25
162 # ADMIN ENGINE OPTIONS
163 # ---------------------------------------------------------------------
165 # OPTION: ADMIN_ENGINE_HOSTS:
166 # List of IP addresses to allow onto the admin engine at
167 # http://instance/adminengine
168 ADMIN_ENGINE_HOSTS = ["127.0.0.1"]
171 # ---------------------------------------------------------------------
173 # OPTION: FORWARDED_FOR_HEADER
174 # If you're using a proxy that passes through a forwarded-for
175 # header set this option to the header name, also set
177 #FORWARDED_FOR_HEADER="x-forwarded-for"
179 # OPTION: FORWARDED_FOR_IPS
180 # This option specifies the IP addresses that forwarded-for
181 # headers will be accepted from.
182 #FORWARDED_FOR_IPS=["127.0.0.1"]
185 # ---------------------------------------------------------------------
187 # OPTION: ARGS (optional)
188 # These arguments will be used as if qwebirc was run directly
189 # with them, see run.py --help for a list of options.
192 # OPTION: SYSLOG_ADDR (optional)
193 # Used in conjunction with util/syslog.py and -s option.
194 # This option specifies the address and port that syslog
195 # datagrams will be sent to.
196 #SYSLOG_ADDR = "127.0.0.1", 514
199 # ---------------------------------------------------------------------
201 # You probably don't want to fiddle with these unless you really know
202 # what you're doing...
204 # OPTION: UPDATE_FREQ
205 # Maximum rate (in seconds) at which updates will be propagated
210 # Maximum client AJAX recieve buffer size (in bytes), if this
211 # buffer size is exceeded then the client will be disconnected.
212 # This value should match the client sendq size in your ircd's
216 # OPTION: MAXSUBSCRIPTIONS
217 # Maximum amount of 'subscriptions' to a specific AJAX channel,
218 # i.e. an IRC connection.
219 # In theory with a value greater than one you can connect more
220 # than one web IRC client to the same IRC connection, ala
225 # If the client sends a line greater than MAXLINELEN (in bytes)
226 # then they will be disconnected.
227 # Note that IRC normally silently drops messages >=512 bytes.
230 # OPTION: DNS_TIMEOUT
231 # DNS requests that do not respond within DNS_TIMEOUT seconds
235 # OPTION: HTTP_AJAX_REQUEST_TIMEOUT
236 # Connections made to the AJAX engine are closed after this
238 # Note that this value is intimately linked with the client
239 # AJAX code at this time, changing it will result in bad
241 HTTP_AJAX_REQUEST_TIMEOUT = 295
243 # OPTION: HTTP_REQUEST_TIMEOUT
244 # Connections made to everything but the AJAX engine will
245 # be closed after this many seconds, including connections
246 # that haven't started/completed an HTTP request.
247 HTTP_REQUEST_TIMEOUT = 5
249 # OPTION: STATIC_BASE_URL
250 # This value is used to build the URL for all static HTTP
252 # You'd find this useful if you're running multiple qwebirc
253 # instances on the same host.
256 # OPTION: DYNAMIC_BASE_URL
257 # This value is used to build the URL for all dynamic HTTP
259 # You'd find this useful if you're running multiple qwebirc
260 # instances on the same host.
261 DYNAMIC_BASE_URL = ""
263 # OPTION: CONNECTION_RESOLVER
264 # A list of (ip, port) tuples of resolvers to use for looking
265 # the SRV record(s) used for connecting to the name set in
267 # The default value is None, and in this case qwebirc will use
268 # the system's default resolver(s).
269 CONNECTION_RESOLVER = None
271 # QUAKENET SPECIFIC VALUES
272 # ---------------------------------------------------------------------
274 # These values are of no interest if you're not QuakeNet.
275 # At present they still need to be set, this will change soon.
278 # Shared key to use with hmac WEBIRC_MODE.
281 # OPTION: HMACTEMPORAL
282 # Divisor used for modulo HMAC timestamp generation.
285 # OPTION: AUTHGATEDOMAIN
286 # Domain accepted inside authgate tickets.
287 AUTHGATEDOMAIN = "webchat_test"
290 # Key shared with the authgate that is used to decrypt
294 # OPTION: AUTH_SERVICE
295 # Service that auth commands are sent to. Also used to check
296 # responses from said service.
297 AUTH_SERVICE = "Q!TheQBot@CServe.quakenet.org"
299 # OPTION: AUTH_OK_REGEX
300 # JavaScript regular expression that should match when
301 # AUTH_SERVICE has returned an acceptable response to
303 AUTH_OK_REGEX = "^You are now logged in as [^ ]+\\.$"
305 # OPTION: AUTHGATEPROVIDER
306 # Authgate module to use, normally imported directly.
307 # dummyauthgate does nothing.
308 import dummyauthgate as AUTHGATEPROVIDER