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.
12 # ---------------------------------------------------------------------
15 # Hostname (or IP address) of IRC server to connect to.
17 # Port of IRC server to connect to.
18 IRCSERVER, IRCPORT = "irc.myserver.com", 6667
21 # The realname field of IRC clients will be set to this value.
22 REALNAME = "http://moo.com/"
25 # ident to use on irc, set to the literal value None to use a
26 # hexadecimal version of the IP address, e.g.:
31 # This option controls how the IP/hostname of the connecting # browser will be sent to IRC.
33 # Possible values include:
35 # Use WEBIRC type blocks, with a server configuration of
36 # the following style:
40 # hostname <qwebirc's ip address>;
41 # password <password>;
44 # Remember to set the WEBIRC_PASSWORD value to be the
47 # old style CGIIRC command, set CGIIRC_STRING to be the
48 # command used to set the ip/hostname, and set
49 # WEBIRC_PASSWORD to be the password used in the server's
51 # - None (the literal value)
52 # Send the IP and hostname in the realname field, overrides
53 # the REALNAME option.
56 # OPTION: WEBIRC_PASSWORD
57 # Used for WEBIRC_MODE webirc and cgiirc, see WEBIRC_MODE
58 # option documentation.
59 #WEBIRC_PASSWORD = "fish"
61 # OPTION: CGIIRC_STRING
62 # Command sent to IRC server in for cgiirc WEBIRC_MODE.
63 # See WEBIRC_MODE option documentation.
64 #CGIIRC_STRING = "CGIIRC"
67 # ---------------------------------------------------------------------
70 # URL that this qwebirc instance will be available at
71 BASE_URL = "http://foo.foo.org/"
73 # OPTION: NETWORK_NAME
74 # The name of your IRC network, displayed throughout the
76 NETWORK_NAME = "FooNet"
79 # The title of the application in the web browser.
80 APP_TITLE = NETWORK_NAME + " Web IRC"
84 # ---------------------------------------------------------------------
86 # These options control the feedback module, which allows users to
87 # send feedback directly from qwebirc (via email).
89 # OPTION: FEEDBACK_FROM
90 # E-mail address that feedback will originate from.
91 FEEDBACK_FROM = "moo@moo.com"
93 # OPTION: FEEDBACK_TO:
94 # E-mail address that feedback will be sent to.
95 FEEDBACK_TO = "moo@moo.com"
97 # OPTION: FEEDBACK_SMTP_HOST
98 # Hostname/IP address of SMTP server feedback will be sent
100 # OPTION: FEEDBACK_SMTP_PORT
101 # Port of SMTP server feedback will be sent through.
102 FEEDBACK_SMTP_HOST, FEEDBACK_SMTP_PORT = "127.0.0.1", 25
104 # ADMIN ENGINE OPTIONS
105 # ---------------------------------------------------------------------
107 # OPTION: ADMIN_ENGINE_HOSTS:
108 # List of IP addresses to allow onto the admin engine at
109 # http://instance/adminengine
110 ADMIN_ENGINE_HOSTS = ["127.0.0.1"]
113 # ---------------------------------------------------------------------
115 # OPTION: ARGS (optional)
116 # These arguments will be used as if qwebirc was run directly
117 # with them, see run.py --help for a list of options.
121 # ---------------------------------------------------------------------
123 # You probably don't want to fiddle with these unless you really know
124 # what you're doing...
126 # OPTION: UPDATE_FREQ
127 # Maximum rate (in seconds) at which updates will be propagated
132 # Maximum client AJAX recieve buffer size (in bytes), if this
133 # buffer size is exceeded then the client will be disconnected.
136 # OPTION: MAXSUBSCRIPTIONS
137 # Maximum amount of 'subscriptions' to a specific AJAX channel,
138 # i.e. an IRC connection.
139 # In theory with a value greater than one you can connect more
140 # than one web IRC client to the same IRC connection, ala
145 # If the client sends a line greater than MAXLINELEN (in bytes)
146 # then they will be disconnected.
149 # OPTION: DNS_TIMEOUT
150 # DNS requests that do not respond within DNS_TIMEOUT seconds
154 # OPTION: HTTP_AJAX_REQUEST_TIMEOUT
155 # Connections made to the AJAX engine are closed after this
157 # Note that this value is intimately linked with the client
158 # AJAX code at this time, changing it will result in bad
160 HTTP_AJAX_REQUEST_TIMEOUT = 30
162 # OPTION: HTTP_REQUEST_TIMEOUT
163 # Connections made to everything but the AJAX engine will
164 # be closed after this many seconds, including connections
165 # that haven't started/completed an HTTP request.
166 HTTP_REQUEST_TIMEOUT = 5
168 # QUAKENET SPECIFIC VALUES
169 # ---------------------------------------------------------------------
171 # These values are of no interest if you're not QuakeNet.
172 # At present they still need to be set, this will change soon.
175 # Shared key to use with hmac WEBIRC_MODE.
178 # OPTION: HMACTEMPORAL
179 # Divisor used for modulo HMAC timestamp generation.
182 # OPTION: AUTHGATEDOMAIN
183 # Domain accepted inside authgate tickets.
184 AUTHGATEDOMAIN = "webchat_test"
187 # Key shared with the authgate that is used to decrypt
191 # OPTION: AUTH_SERVICE
192 # Service that auth commands are sent to. Also used to check
193 # responses from said service.
194 AUTH_SERVICE = "Q!TheQBot@CServe.quakenet.org"
196 # OPTION: AUTH_OK_REGEX
197 # JavaScript regular expression that should match when
198 # AUTH_SERVICE has returned an acceptable response to
200 AUTH_OK_REGEX = "^You are now logged in as [^ ]+\\.$"
202 # OPTION: AUTHGATEPROVIDER
203 # Authgate module to use, normally imported directly.
204 # dummyauthgate does nothing.
205 import dummyauthgate as AUTHGATEPROVIDER