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 # The realname field of IRC clients will be set to this value.
25 REALNAME = "http://moo.com/"
28 # ident to use on irc, possible values include:
29 # - a string, e.g. IDENT = "webchat"
30 # - the literal value IDENT_HEX, this will set the ident to the
31 # a hexadecimal version of the users IP address, e.g
33 # - the literal value IDENT_NICKNAME, this will use the users
34 # supplied nickname as their ident.
38 # This option controls how the IP/hostname of the connecting
39 # browser will be sent to IRC.
41 # Possible values include:
43 # Use WEBIRC type blocks, with a server configuration of
44 # the following style:
48 # hostname <qwebirc's ip address>;
49 # password <password>;
52 # Remember to set the WEBIRC_PASSWORD value to be the
55 # old style CGIIRC command, set CGIIRC_STRING to be the
56 # command used to set the ip/hostname, and set
57 # WEBIRC_PASSWORD to be the password used in the server's
59 # - None (the literal value)
60 # Send the IP and hostname in the realname field, overrides
61 # the REALNAME option.
64 # OPTION: WEBIRC_PASSWORD
65 # Used for WEBIRC_MODE webirc and cgiirc, see WEBIRC_MODE
66 # option documentation.
67 #WEBIRC_PASSWORD = "fish"
69 # OPTION: CGIIRC_STRING
70 # Command sent to IRC server in for cgiirc WEBIRC_MODE.
71 # See WEBIRC_MODE option documentation.
72 #CGIIRC_STRING = "CGIIRC"
75 # ---------------------------------------------------------------------
78 # URL that this qwebirc instance will be available at, add the
79 # port number if your instance runs on a port other than 80.
80 BASE_URL = "http://foo.foo.org/"
82 # OPTION: NETWORK_NAME
83 # The name of your IRC network, displayed throughout the
85 NETWORK_NAME = "FooNet"
88 # The title of the application in the web browser.
89 APP_TITLE = NETWORK_NAME + " Web IRC"
93 # ---------------------------------------------------------------------
95 # These options control the feedback module, which allows users to
96 # send feedback directly from qwebirc (via email).
98 # OPTION: FEEDBACK_FROM
99 # E-mail address that feedback will originate from.
100 FEEDBACK_FROM = "moo@moo.com"
102 # OPTION: FEEDBACK_TO:
103 # E-mail address that feedback will be sent to.
104 FEEDBACK_TO = "moo@moo.com"
106 # OPTION: FEEDBACK_SMTP_HOST
107 # Hostname/IP address of SMTP server feedback will be sent
109 # OPTION: FEEDBACK_SMTP_PORT
110 # Port of SMTP server feedback will be sent through.
111 FEEDBACK_SMTP_HOST, FEEDBACK_SMTP_PORT = "127.0.0.1", 25
113 # ADMIN ENGINE OPTIONS
114 # ---------------------------------------------------------------------
116 # OPTION: ADMIN_ENGINE_HOSTS:
117 # List of IP addresses to allow onto the admin engine at
118 # http://instance/adminengine
119 ADMIN_ENGINE_HOSTS = ["127.0.0.1"]
122 # ---------------------------------------------------------------------
124 # OPTION: ARGS (optional)
125 # These arguments will be used as if qwebirc was run directly
126 # with them, see run.py --help for a list of options.
130 # ---------------------------------------------------------------------
132 # You probably don't want to fiddle with these unless you really know
133 # what you're doing...
135 # OPTION: UPDATE_FREQ
136 # Maximum rate (in seconds) at which updates will be propagated
141 # Maximum client AJAX recieve buffer size (in bytes), if this
142 # buffer size is exceeded then the client will be disconnected.
143 # This value should match the client sendq size in your ircd's
147 # OPTION: MAXSUBSCRIPTIONS
148 # Maximum amount of 'subscriptions' to a specific AJAX channel,
149 # i.e. an IRC connection.
150 # In theory with a value greater than one you can connect more
151 # than one web IRC client to the same IRC connection, ala
156 # If the client sends a line greater than MAXLINELEN (in bytes)
157 # then they will be disconnected.
158 # Note that IRC normally silently drops messages >=512 bytes.
161 # OPTION: DNS_TIMEOUT
162 # DNS requests that do not respond within DNS_TIMEOUT seconds
166 # OPTION: HTTP_AJAX_REQUEST_TIMEOUT
167 # Connections made to the AJAX engine are closed after this
169 # Note that this value is intimately linked with the client
170 # AJAX code at this time, changing it will result in bad
172 HTTP_AJAX_REQUEST_TIMEOUT = 30
174 # OPTION: HTTP_REQUEST_TIMEOUT
175 # Connections made to everything but the AJAX engine will
176 # be closed after this many seconds, including connections
177 # that haven't started/completed an HTTP request.
178 HTTP_REQUEST_TIMEOUT = 5
180 # QUAKENET SPECIFIC VALUES
181 # ---------------------------------------------------------------------
183 # These values are of no interest if you're not QuakeNet.
184 # At present they still need to be set, this will change soon.
187 # Shared key to use with hmac WEBIRC_MODE.
190 # OPTION: HMACTEMPORAL
191 # Divisor used for modulo HMAC timestamp generation.
194 # OPTION: AUTHGATEDOMAIN
195 # Domain accepted inside authgate tickets.
196 AUTHGATEDOMAIN = "webchat_test"
199 # Key shared with the authgate that is used to decrypt
203 # OPTION: AUTH_SERVICE
204 # Service that auth commands are sent to. Also used to check
205 # responses from said service.
206 AUTH_SERVICE = "Q!TheQBot@CServe.quakenet.org"
208 # OPTION: AUTH_OK_REGEX
209 # JavaScript regular expression that should match when
210 # AUTH_SERVICE has returned an acceptable response to
212 AUTH_OK_REGEX = "^You are now logged in as [^ ]+\\.$"
214 # OPTION: AUTHGATEPROVIDER
215 # Authgate module to use, normally imported directly.
216 # dummyauthgate does nothing.
217 import dummyauthgate as AUTHGATEPROVIDER