]>
Commit | Line | Data |
---|---|---|
b8357cf5 CP |
1 | # qwebirc configuration file |
2 | # | |
3 | # This a Python program that is imported, so feel free to use any | |
4 | # Python here! | |
5 | # | |
6 | # Note that some changes to this configuration file require re-running | |
7 | # compile.py and others require restarting qwebirc (and some require | |
8 | # both!) | |
9 | # If in doubt always re-compile and restart. | |
1435dd92 | 10 | |
b8357cf5 CP |
11 | # IRC OPTIONS |
12 | # --------------------------------------------------------------------- | |
13 | # | |
14 | # OPTION: IRCSERVER | |
15 | # Hostname (or IP address) of IRC server to connect to. | |
16 | # OPTION: IRCPORT | |
17 | # Port of IRC server to connect to. | |
18 | IRCSERVER, IRCPORT = "irc.myserver.com", 6667 | |
19 | ||
20 | # OPTION: REALNAME | |
21 | # The realname field of IRC clients will be set to this value. | |
4094890f | 22 | REALNAME = "http://moo.com/" |
9a2bf266 | 23 | |
b8357cf5 CP |
24 | # OPTION: IDENT |
25 | # ident to use on irc, set to the literal value None to use a | |
26 | # hexadecimal version of the IP address, e.g.: | |
27 | # IDENT = None | |
28 | IDENT = "webchat" | |
29 | ||
30 | # OPTION: WEBIRC_MODE | |
de4380a1 CP |
31 | # This option controls how the IP/hostname of the connecting |
32 | # browser will be sent to IRC. | |
b8357cf5 CP |
33 | # |
34 | # Possible values include: | |
efd064c5 CP |
35 | # - webirc |
36 | # Use WEBIRC type blocks, with a server configuration of | |
37 | # the following style: | |
38 | # | |
39 | # cgiirc { | |
40 | # type webirc; | |
41 | # hostname <qwebirc's ip address>; | |
42 | # password <password>; | |
43 | # }; | |
44 | # | |
45 | # Remember to set the WEBIRC_PASSWORD value to be the | |
46 | # same as <password>. | |
b8357cf5 CP |
47 | # - cgiirc |
48 | # old style CGIIRC command, set CGIIRC_STRING to be the | |
49 | # command used to set the ip/hostname, and set | |
50 | # WEBIRC_PASSWORD to be the password used in the server's | |
51 | # configuration file. | |
52 | # - None (the literal value) | |
53 | # Send the IP and hostname in the realname field, overrides | |
54 | # the REALNAME option. | |
55 | WEBIRC_MODE = None | |
56 | ||
57 | # OPTION: WEBIRC_PASSWORD | |
58 | # Used for WEBIRC_MODE webirc and cgiirc, see WEBIRC_MODE | |
59 | # option documentation. | |
60 | #WEBIRC_PASSWORD = "fish" | |
61 | ||
62 | # OPTION: CGIIRC_STRING | |
63 | # Command sent to IRC server in for cgiirc WEBIRC_MODE. | |
64 | # See WEBIRC_MODE option documentation. | |
65 | #CGIIRC_STRING = "CGIIRC" | |
66 | ||
67 | # UI OPTIONS | |
68 | # --------------------------------------------------------------------- | |
69 | # | |
70 | # OPTION: BASE_URL | |
de4380a1 CP |
71 | # URL that this qwebirc instance will be available at, add the |
72 | # port number if your instance runs on a port other than 80. | |
2dfab0e1 CP |
73 | BASE_URL = "http://foo.foo.org/" |
74 | ||
b8357cf5 CP |
75 | # OPTION: NETWORK_NAME |
76 | # The name of your IRC network, displayed throughout the | |
77 | # application. | |
78 | NETWORK_NAME = "FooNet" | |
79 | ||
80 | # OPTION: APP_TITLE | |
81 | # The title of the application in the web browser. | |
82 | APP_TITLE = NETWORK_NAME + " Web IRC" | |
83 | ||
84 | ||
85 | # FEEDBACK OPTIONS | |
86 | # --------------------------------------------------------------------- | |
87 | # | |
88 | # These options control the feedback module, which allows users to | |
89 | # send feedback directly from qwebirc (via email). | |
90 | # | |
91 | # OPTION: FEEDBACK_FROM | |
92 | # E-mail address that feedback will originate from. | |
391f51ff | 93 | FEEDBACK_FROM = "moo@moo.com" |
b8357cf5 CP |
94 | |
95 | # OPTION: FEEDBACK_TO: | |
96 | # E-mail address that feedback will be sent to. | |
391f51ff | 97 | FEEDBACK_TO = "moo@moo.com" |
b8357cf5 CP |
98 | |
99 | # OPTION: FEEDBACK_SMTP_HOST | |
100 | # Hostname/IP address of SMTP server feedback will be sent | |
101 | # through. | |
102 | # OPTION: FEEDBACK_SMTP_PORT | |
103 | # Port of SMTP server feedback will be sent through. | |
104 | FEEDBACK_SMTP_HOST, FEEDBACK_SMTP_PORT = "127.0.0.1", 25 | |
105 | ||
106 | # ADMIN ENGINE OPTIONS | |
107 | # --------------------------------------------------------------------- | |
108 | # | |
109 | # OPTION: ADMIN_ENGINE_HOSTS: | |
110 | # List of IP addresses to allow onto the admin engine at | |
111 | # http://instance/adminengine | |
85f01e3f | 112 | ADMIN_ENGINE_HOSTS = ["127.0.0.1"] |
9a2bf266 | 113 | |
b8357cf5 CP |
114 | # EXECUTION OPTIONS |
115 | # --------------------------------------------------------------------- | |
116 | # | |
117 | # OPTION: ARGS (optional) | |
118 | # These arguments will be used as if qwebirc was run directly | |
119 | # with them, see run.py --help for a list of options. | |
120 | #ARGS = "-n -p 3989" | |
121 | ||
122 | # TUNEABLE VALUES | |
123 | # --------------------------------------------------------------------- | |
124 | # | |
125 | # You probably don't want to fiddle with these unless you really know | |
126 | # what you're doing... | |
127 | ||
128 | # OPTION: UPDATE_FREQ | |
129 | # Maximum rate (in seconds) at which updates will be propagated | |
130 | # to clients | |
131 | UPDATE_FREQ = 0.5 | |
132 | ||
133 | # OPTION: MAXBUFLEN | |
134 | # Maximum client AJAX recieve buffer size (in bytes), if this | |
135 | # buffer size is exceeded then the client will be disconnected. | |
de4380a1 CP |
136 | # This value should match the client sendq size in your ircd's |
137 | # configuration. | |
138 | MAXBUFLEN = 100000 | |
b8357cf5 CP |
139 | |
140 | # OPTION: MAXSUBSCRIPTIONS | |
141 | # Maximum amount of 'subscriptions' to a specific AJAX channel, | |
142 | # i.e. an IRC connection. | |
143 | # In theory with a value greater than one you can connect more | |
144 | # than one web IRC client to the same IRC connection, ala | |
145 | # irssi-proxy. | |
146 | MAXSUBSCRIPTIONS = 1 | |
147 | ||
148 | # OPTION: MAXLINELEN | |
149 | # If the client sends a line greater than MAXLINELEN (in bytes) | |
150 | # then they will be disconnected. | |
de4380a1 | 151 | # Note that IRC normally silently drops messages >=512 bytes. |
b8357cf5 | 152 | MAXLINELEN = 600 |
348574ee | 153 | |
b8357cf5 CP |
154 | # OPTION: DNS_TIMEOUT |
155 | # DNS requests that do not respond within DNS_TIMEOUT seconds | |
00cc5cd5 | 156 | # will be cancelled. |
28c4ad01 | 157 | DNS_TIMEOUT = 5 |
b5c84380 | 158 | |
b8357cf5 CP |
159 | # OPTION: HTTP_AJAX_REQUEST_TIMEOUT |
160 | # Connections made to the AJAX engine are closed after this | |
161 | # this many seconds. | |
162 | # Note that this value is intimately linked with the client | |
163 | # AJAX code at this time, changing it will result in bad | |
164 | # things happening. | |
165 | HTTP_AJAX_REQUEST_TIMEOUT = 30 | |
166 | ||
167 | # OPTION: HTTP_REQUEST_TIMEOUT | |
168 | # Connections made to everything but the AJAX engine will | |
169 | # be closed after this many seconds, including connections | |
170 | # that haven't started/completed an HTTP request. | |
171 | HTTP_REQUEST_TIMEOUT = 5 | |
b5c84380 | 172 | |
b8357cf5 CP |
173 | # QUAKENET SPECIFIC VALUES |
174 | # --------------------------------------------------------------------- | |
175 | # | |
176 | # These values are of no interest if you're not QuakeNet. | |
177 | # At present they still need to be set, this will change soon. | |
178 | # | |
179 | # OPTION: HMACKEY | |
180 | # Shared key to use with hmac WEBIRC_MODE. | |
9a2bf266 | 181 | HMACKEY = "mrmoo" |
b8357cf5 CP |
182 | |
183 | # OPTION: HMACTEMPORAL | |
184 | # Divisor used for modulo HMAC timestamp generation. | |
9a2bf266 | 185 | HMACTEMPORAL = 30 |
b5c84380 | 186 | |
b8357cf5 CP |
187 | # OPTION: AUTHGATEDOMAIN |
188 | # Domain accepted inside authgate tickets. | |
9a2bf266 | 189 | AUTHGATEDOMAIN = "webchat_test" |
b8357cf5 CP |
190 | |
191 | # OPTION: QTICKETKEY | |
192 | # Key shared with the authgate that is used to decrypt | |
193 | # qtickets. | |
9a2bf266 | 194 | QTICKETKEY = "boo" |
b8357cf5 CP |
195 | |
196 | # OPTION: AUTH_SERVICE | |
197 | # Service that auth commands are sent to. Also used to check | |
198 | # responses from said service. | |
348574ee | 199 | AUTH_SERVICE = "Q!TheQBot@CServe.quakenet.org" |
b8357cf5 CP |
200 | |
201 | # OPTION: AUTH_OK_REGEX | |
202 | # JavaScript regular expression that should match when | |
203 | # AUTH_SERVICE has returned an acceptable response to | |
204 | # authentication. | |
348574ee | 205 | AUTH_OK_REGEX = "^You are now logged in as [^ ]+\\.$" |
b8357cf5 CP |
206 | |
207 | # OPTION: AUTHGATEPROVIDER | |
208 | # Authgate module to use, normally imported directly. | |
209 | # dummyauthgate does nothing. | |
210 | import dummyauthgate as AUTHGATEPROVIDER |