config.py.example

   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.
  10
  11 # The following line is required, don't remove it!
  12 from qwebirc.config_options import *
  13
  14 # IRC OPTIONS
  15 # ---------------------------------------------------------------------
  16 #
  17 # OPTION: IRCSERVER
  18 #         Hostname (or IP address) of IRC server to connect to.
  19 # OPTION: IRCPORT
  20 #         Port of IRC server to connect to.
  21 IRCSERVER, IRCPORT = "irc.myserver.com", 6667
  22
  23 # OPTION: REALNAME
  24 #         The realname field of IRC clients will be set to this value.
  25 REALNAME = "http://moo.com/"
  26
  27 # OPTION: IDENT
  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
  32 #          IDENT = IDENT_HEX
  33 #        - the literal value IDENT_NICKNAME, this will use the users
  34 #          supplied nickname as their ident.
  35 IDENT = "webchat"
  36
  37 # OPTION: OUTGOING_IP
  38 #         The IP address to bind to when connecting to the IRC server.
  39 #
  40 #         This will not change the IP address that qwebirc listens on.
  41 #         You will need to call run.py with the --ip/-i option if you
  42 #         want that.
  43 #OUTGOING_IP = "127.0.0.1"
  44
  45 # OPTION: WEBIRC_MODE
  46 #         This option controls how the IP/hostname of the connecting
  47 #         browser will be sent to IRC.
  48 #
  49 #         Possible values include:
  50 #         - the string "webirc", i.e. WEBIRC_MODE = "webirc"
  51 #           Use WEBIRC type blocks, with a server configuration of
  52 #           the following style:
  53 #
  54 #           cgiirc {
  55 #             type webirc;
  56 #             hostname <qwebirc's ip address>;
  57 #             password <password>;
  58 #           };
  59 #
  60 #           Remember to set the WEBIRC_PASSWORD value to be the
  61 #           same as <password>.
  62 #         - the string "cgiirc", i.e. WEBIRC_MODE = "cgiirc"
  63 #           old style CGIIRC command, set CGIIRC_STRING to be the
  64 #           command used to set the ip/hostname, and set
  65 #           WEBIRC_PASSWORD to be the password used in the server's
  66 #           configuration file.
  67 #         - the literal value None, i.e. WEBIRC_MODE = None
  68 #           Send the IP and hostname in the realname field, overrides
  69 #          the REALNAME option.
  70 WEBIRC_MODE = None
  71
  72 # OPTION: WEBIRC_PASSWORD
  73 #         Used for WEBIRC_MODE webirc and cgiirc, see WEBIRC_MODE
  74 #         option documentation.
  75 #WEBIRC_PASSWORD = "fish"
  76
  77 # OPTION: CGIIRC_STRING
  78 #         Command sent to IRC server in for cgiirc WEBIRC_MODE.
  79 #         See WEBIRC_MODE option documentation.
  80 #CGIIRC_STRING = "CGIIRC"
  81
  82 # UI OPTIONS
  83 # ---------------------------------------------------------------------
  84 #
  85 # OPTION: BASE_URL
  86 #         URL that this qwebirc instance will be available at, add the
  87 #         port number if your instance runs on a port other than 80.
  88 BASE_URL = "http://foo.foo.org/"
  89
  90 # OPTION: NETWORK_NAME
  91 #         The name of your IRC network, displayed throughout the
  92 #         application.
  93 NETWORK_NAME = "FooNet"
  94
  95 # OPTION: APP_TITLE
  96 #         The title of the application in the web browser.
  97 APP_TITLE = NETWORK_NAME + " Web IRC"
  98
  99
 100 # FEEDBACK OPTIONS
 101 # ---------------------------------------------------------------------
 102 #
 103 # These options control the feedback module, which allows users to
 104 # send feedback directly from qwebirc (via email).
 105 #
 106 # OPTION: FEEDBACK_FROM
 107 #         E-mail address that feedback will originate from.
 108 FEEDBACK_FROM = "moo@moo.com"
 109
 110 # OPTION: FEEDBACK_TO:
 111 #         E-mail address that feedback will be sent to.
 112 FEEDBACK_TO = "moo@moo.com"
 113
 114 # OPTION: FEEDBACK_SMTP_HOST
 115 #         Hostname/IP address of SMTP server feedback will be sent
 116 #         through.
 117 # OPTION: FEEDBACK_SMTP_PORT
 118 #         Port of SMTP server feedback will be sent through.
 119 FEEDBACK_SMTP_HOST, FEEDBACK_SMTP_PORT = "127.0.0.1", 25
 120
 121 # ADMIN ENGINE OPTIONS
 122 # ---------------------------------------------------------------------
 123 #
 124 # OPTION: ADMIN_ENGINE_HOSTS:
 125 #         List of IP addresses to allow onto the admin engine at
 126 #         http://instance/adminengine
 127 ADMIN_ENGINE_HOSTS = ["127.0.0.1"]
 128
 129 # PROXY OPTIONS
 130 # ---------------------------------------------------------------------
 131 #
 132 # OPTION: FORWARDED_FOR_HEADER
 133 #         If you're using a proxy that passes through a forwarded-for
 134 #         header set this option to the header name, also set
 135 #         FORWARDED_FOR_IPS.
 136 #FORWARDED_FOR_HEADER="x-forwarded-for"
 137
 138 # OPTION: FORWARDED_FOR_IPS
 139 #         This option specifies the IP addresses that forwarded-for
 140 #         headers will be accepted from.
 141 #FORWARDED_FOR_IPS=["127.0.0.1"]
 142
 143 # EXECUTION OPTIONS
 144 # ---------------------------------------------------------------------
 145 #
 146 # OPTION: ARGS (optional)
 147 #         These arguments will be used as if qwebirc was run directly
 148 #         with them, see run.py --help for a list of options.
 149 #ARGS = "-n -p 3989"
 150
 151 # OPTION: SYSLOG_ADDR (optional)
 152 #         Used in conjunction with util/syslog.py and -s option.
 153 #         This option specifies the address and port that syslog
 154 #         datagrams will be sent to.
 155 #SYSLOG_ADDR = "127.0.0.1", 514
 156
 157 # TUNEABLE VALUES
 158 # ---------------------------------------------------------------------
 159 #
 160 # You probably don't want to fiddle with these unless you really know
 161 # what you're doing...
 162
 163 # OPTION: UPDATE_FREQ
 164 #         Maximum rate (in seconds) at which updates will be propagated
 165 #         to clients
 166 UPDATE_FREQ = 0.5
 167
 168 # OPTION: MAXBUFLEN
 169 #         Maximum client AJAX recieve buffer size (in bytes), if this
 170 #         buffer size is exceeded then the client will be disconnected.
 171 #         This value should match the client sendq size in your ircd's
 172 #         configuration.
 173 MAXBUFLEN = 100000
 174
 175 # OPTION: MAXSUBSCRIPTIONS
 176 #         Maximum amount of 'subscriptions' to a specific AJAX channel,
 177 #         i.e. an IRC connection.
 178 #         In theory with a value greater than one you can connect more
 179 #         than one web IRC client to the same IRC connection, ala
 180 #         irssi-proxy.
 181 MAXSUBSCRIPTIONS = 1
 182
 183 # OPTION: MAXLINELEN
 184 #         If the client sends a line greater than MAXLINELEN (in bytes)
 185 #         then they will be disconnected.
 186 #         Note that IRC normally silently drops messages >=512 bytes.
 187 MAXLINELEN = 600
 188
 189 # OPTION: DNS_TIMEOUT
 190 #         DNS requests that do not respond within DNS_TIMEOUT seconds
 191 #         will be cancelled.
 192 DNS_TIMEOUT = 5
 193
 194 # OPTION: HTTP_AJAX_REQUEST_TIMEOUT
 195 #         Connections made to the AJAX engine are closed after this
 196 #         this many seconds.
 197 #         Note that this value is intimately linked with the client
 198 #         AJAX code at this time, changing it will result in bad
 199 #         things happening.
 200 HTTP_AJAX_REQUEST_TIMEOUT = 30
 201
 202 # OPTION: HTTP_REQUEST_TIMEOUT
 203 #         Connections made to everything but the AJAX engine will
 204 #         be closed after this many seconds, including connections
 205 #         that haven't started/completed an HTTP request.
 206 HTTP_REQUEST_TIMEOUT = 5
 207
 208 # OPTION: STATIC_BASE_URL
 209 #         This value is used to build the URL for all static HTTP
 210 #         requests.
 211 #         You'd find this useful if you're running multiple qwebirc
 212 #         instances on the same host.
 213 STATIC_BASE_URL = ""
 214
 215 # OPTION: DYNAMIC_BASE_URL
 216 #         This value is used to build the URL for all dynamic HTTP
 217 #         requests.
 218 #         You'd find this useful if you're running multiple qwebirc
 219 #         instances on the same host.
 220 DYNAMIC_BASE_URL = ""
 221
 222 # OPTION: CONNECTION_RESOLVER
 223 #         A list of (ip, port) tuples of resolvers to use for looking
 224 #         the SRV record(s) used for connecting to the name set in
 225 #         IRC_SERVER.
 226 #         The default value is None, and in this case qwebirc will use
 227 #         the system's default resolver(s).
 228 CONNECTION_RESOLVER = None
 229
 230 # QUAKENET SPECIFIC VALUES
 231 # ---------------------------------------------------------------------
 232 #
 233 # These values are of no interest if you're not QuakeNet.
 234 # At present they still need to be set, this will change soon.
 235 #
 236 # OPTION: HMACKEY
 237 #         Shared key to use with hmac WEBIRC_MODE.
 238 HMACKEY = "mrmoo"
 239
 240 # OPTION: HMACTEMPORAL
 241 #         Divisor used for modulo HMAC timestamp generation.
 242 HMACTEMPORAL = 30
 243
 244 # OPTION: AUTHGATEDOMAIN
 245 #         Domain accepted inside authgate tickets.
 246 AUTHGATEDOMAIN = "webchat_test"
 247
 248 # OPTION: QTICKETKEY
 249 #         Key shared with the authgate that is used to decrypt
 250 #         qtickets.
 251 QTICKETKEY = "boo"
 252
 253 # OPTION: AUTH_SERVICE
 254 #         Service that auth commands are sent to. Also used to check
 255 #         responses from said service.
 256 AUTH_SERVICE = "Q!TheQBot@CServe.quakenet.org"
 257
 258 # OPTION: AUTH_OK_REGEX
 259 #         JavaScript regular expression that should match when
 260 #         AUTH_SERVICE has returned an acceptable response to
 261 #         authentication.
 262 AUTH_OK_REGEX = "^You are now logged in as [^ ]+\\.$"
 263
 264 # OPTION: AUTHGATEPROVIDER
 265 #         Authgate module to use, normally imported directly.
 266 #         dummyauthgate does nothing.
 267 import dummyauthgate as AUTHGATEPROVIDER