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"
101 # URL to your logo (max height 68 pixels).
102 # If not set the default network name will shown in text.
103 #LOGO_URL="images/logo.png"
105 # OPTION: ANALYTICS_HTML
106 # If you have an analytics service, you can paste the HTML
107 # between the triple quotes.
108 #ANALYTICS_HTML = """
112 # The title of the application in the web browser.
113 APP_TITLE = NETWORK_NAME + " Web IRC"
115 # NICKNAME VALIDATION OPTIONS
116 # ---------------------------------------------------------------------
118 # OPTION: NICKNAME_VALIDATE
119 # If True then user nicknames will be validated according to
120 # the configuration below, otherwise they will be passed
121 # directly to the ircd.
122 NICKNAME_VALIDATE = True
124 # OPTION: NICKNAME_VALID_FIRST_CHAR
125 # A string containing valid characters for the first letter of
127 # Default is as in RFC1459.
129 NICKNAME_VALID_FIRST_CHAR = string.letters + "_[]{}`^\\|"
131 # OPTION: NICKNAME_VALID_SUBSEQUENT_CHAR
132 # A string containing valid characters for the rest of the
134 NICKNAME_VALID_SUBSEQUENT_CHARS = NICKNAME_VALID_FIRST_CHAR + string.digits + "-"
136 # OPTION: NICKNAME_MINIMUM_LENGTH
137 # Minimum characters permitted in a nickname on your network.
138 NICKNAME_MINIMUM_LENGTH = 2
140 # OPTION: NICKNAME_MAXIMUM_LENGTH
141 # Maximum characters permitted in a nickname on your network.
142 # Ideally we'd extract this from the ircd, but we need to know
144 NICKNAME_MAXIMUM_LENGTH = 15
147 # ---------------------------------------------------------------------
149 # These options control the feedback module, which allows users to
150 # send feedback directly from qwebirc (via email).
152 # OPTION: FEEDBACK_FROM
153 # E-mail address that feedback will originate from.
154 FEEDBACK_FROM = "moo@moo.com"
156 # OPTION: FEEDBACK_TO:
157 # E-mail address that feedback will be sent to.
158 FEEDBACK_TO = "moo@moo.com"
160 # OPTION: FEEDBACK_SMTP_HOST
161 # Hostname/IP address of SMTP server feedback will be sent
163 # OPTION: FEEDBACK_SMTP_PORT
164 # Port of SMTP server feedback will be sent through.
165 FEEDBACK_SMTP_HOST, FEEDBACK_SMTP_PORT = "127.0.0.1", 25
167 # ADMIN ENGINE OPTIONS
168 # ---------------------------------------------------------------------
170 # OPTION: ADMIN_ENGINE_HOSTS:
171 # List of IP addresses to allow onto the admin engine at
172 # http://instance/adminengine
173 ADMIN_ENGINE_HOSTS = ["127.0.0.1"]
176 # ---------------------------------------------------------------------
178 # OPTION: FORWARDED_FOR_HEADER
179 # If you're using a proxy that passes through a forwarded-for
180 # header set this option to the header name, also set
182 #FORWARDED_FOR_HEADER="x-forwarded-for"
184 # OPTION: FORWARDED_FOR_IPS
185 # This option specifies the IP addresses that forwarded-for
186 # headers will be accepted from.
187 #FORWARDED_FOR_IPS=["127.0.0.1"]
190 # ---------------------------------------------------------------------
192 # OPTION: ARGS (optional)
193 # These arguments will be used as if qwebirc was run directly
194 # with them, see run.py --help for a list of options.
197 # OPTION: SYSLOG_ADDR (optional)
198 # Used in conjunction with util/syslog.py and -s option.
199 # This option specifies the address and port that syslog
200 # datagrams will be sent to.
201 #SYSLOG_ADDR = "127.0.0.1", 514
204 # ---------------------------------------------------------------------
206 # You probably don't want to fiddle with these unless you really know
207 # what you're doing...
209 # OPTION: UPDATE_FREQ
210 # Maximum rate (in seconds) at which updates will be propagated
215 # Maximum client AJAX recieve buffer size (in bytes), if this
216 # buffer size is exceeded then the client will be disconnected.
217 # This value should match the client sendq size in your ircd's
221 # OPTION: MAXSUBSCRIPTIONS
222 # Maximum amount of 'subscriptions' to a specific AJAX channel,
223 # i.e. an IRC connection.
224 # In theory with a value greater than one you can connect more
225 # than one web IRC client to the same IRC connection, ala
230 # If the client sends a line greater than MAXLINELEN (in bytes)
231 # then they will be disconnected.
232 # Note that IRC normally silently drops messages >=512 bytes.
235 # OPTION: DNS_TIMEOUT
236 # DNS requests that do not respond within DNS_TIMEOUT seconds
240 # OPTION: HTTP_AJAX_REQUEST_TIMEOUT
241 # Connections made to the AJAX engine are closed after this
243 # Note that this value is intimately linked with the client
244 # AJAX code at this time, changing it will result in bad
246 HTTP_AJAX_REQUEST_TIMEOUT = 295
248 # OPTION: HTTP_REQUEST_TIMEOUT
249 # Connections made to everything but the AJAX engine will
250 # be closed after this many seconds, including connections
251 # that haven't started/completed an HTTP request.
252 HTTP_REQUEST_TIMEOUT = 5
254 # OPTION: STATIC_BASE_URL
255 # This value is used to build the URL for all static HTTP
257 # You'd find this useful if you're running multiple qwebirc
258 # instances on the same host.
261 # OPTION: DYNAMIC_BASE_URL
262 # This value is used to build the URL for all dynamic HTTP
264 # You'd find this useful if you're running multiple qwebirc
265 # instances on the same host.
266 DYNAMIC_BASE_URL = ""
268 # OPTION: CONNECTION_RESOLVER
269 # A list of (ip, port) tuples of resolvers to use for looking
270 # the SRV record(s) used for connecting to the name set in
272 # The default value is None, and in this case qwebirc will use
273 # the system's default resolver(s).
274 CONNECTION_RESOLVER = None
277 # Shown to the user if they type /HELP or click on the Help!
278 # option in the user interface.
281 # OPTION: ACCOUNT_WHOIS_COMMAND
282 # Command sent when a username is clicked.
283 #ACCOUNT_WHOIS_COMMAND = "/msg Q whois #"
285 # QUAKENET SPECIFIC VALUES
286 # ---------------------------------------------------------------------
288 # These values are of no interest if you're not QuakeNet.
289 # At present they still need to be set, this will change soon.
292 # Shared key to use with hmac WEBIRC_MODE.
295 # OPTION: HMACTEMPORAL
296 # Divisor used for modulo HMAC timestamp generation.
299 # OPTION: AUTHGATEDOMAIN
300 # Domain accepted inside authgate tickets.
301 AUTHGATEDOMAIN = "webchat_test"
304 # Key shared with the authgate that is used to decrypt
308 # OPTION: AUTH_SERVICE
309 # Service that auth commands are sent to. Also used to check
310 # responses from said service.
311 AUTH_SERVICE = "Q!TheQBot@CServe.quakenet.org"
313 # OPTION: AUTH_OK_REGEX
314 # JavaScript regular expression that should match when
315 # AUTH_SERVICE has returned an acceptable response to
317 AUTH_OK_REGEX = "^You are now logged in as [^ ]+\\.$"
319 # OPTION: AUTHGATEPROVIDER
320 # Authgate module to use, normally imported directly.
321 # dummyauthgate does nothing.
322 import dummyauthgate as AUTHGATEPROVIDER