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