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 # 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.
  22 REALNAME = "http://moo.com/"
  23
  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
  31 #         This option controls how the IP/hostname of the connecting #         browser will be sent to IRC.
  32 #
  33 #         Possible values include:
  34 #         - webirc
  35 #           Use WEBIRC type blocks, with a server configuration of
  36 #           the following style:
  37 #
  38 #           cgiirc {
  39 #             type webirc;
  40 #             hostname <qwebirc's ip address>;
  41 #             password <password>;
  42 #           };
  43 #
  44 #           Remember to set the WEBIRC_PASSWORD value to be the
  45 #           same as <password>.
  46 #         - cgiirc
  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
  50 #           configuration file.
  51 #         - None (the literal value)
  52 #           Send the IP and hostname in the realname field, overrides
  53 #          the REALNAME option.
  54 WEBIRC_MODE = None
  55
  56 # OPTION: WEBIRC_PASSWORD
  57 #         Used for WEBIRC_MODE webirc and cgiirc, see WEBIRC_MODE
  58 #         option documentation.
  59 #WEBIRC_PASSWORD = "fish"
  60
  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"
  65
  66 # UI OPTIONS
  67 # ---------------------------------------------------------------------
  68 #
  69 # OPTION: BASE_URL
  70 #         URL that this qwebirc instance will be available at
  71 BASE_URL = "http://foo.foo.org/"
  72
  73 # OPTION: NETWORK_NAME
  74 #         The name of your IRC network, displayed throughout the
  75 #         application.
  76 NETWORK_NAME = "FooNet"
  77
  78 # OPTION: APP_TITLE
  79 #         The title of the application in the web browser.
  80 APP_TITLE = NETWORK_NAME + " Web IRC"
  81
  82
  83 # FEEDBACK OPTIONS
  84 # ---------------------------------------------------------------------
  85 #
  86 # These options control the feedback module, which allows users to
  87 # send feedback directly from qwebirc (via email).
  88 #
  89 # OPTION: FEEDBACK_FROM
  90 #         E-mail address that feedback will originate from.
  91 FEEDBACK_FROM = "moo@moo.com"
  92
  93 # OPTION: FEEDBACK_TO:
  94 #         E-mail address that feedback will be sent to.
  95 FEEDBACK_TO = "moo@moo.com"
  96
  97 # OPTION: FEEDBACK_SMTP_HOST
  98 #         Hostname/IP address of SMTP server feedback will be sent
  99 #         through.
 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
 103
 104 # ADMIN ENGINE OPTIONS
 105 # ---------------------------------------------------------------------
 106 #
 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"]
 111
 112 # EXECUTION OPTIONS
 113 # ---------------------------------------------------------------------
 114 #
 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.
 118 #ARGS = "-n -p 3989"
 119
 120 # TUNEABLE VALUES
 121 # ---------------------------------------------------------------------
 122 #
 123 # You probably don't want to fiddle with these unless you really know
 124 # what you're doing...
 125
 126 # OPTION: UPDATE_FREQ
 127 #         Maximum rate (in seconds) at which updates will be propagated
 128 #         to clients
 129 UPDATE_FREQ = 0.5
 130
 131 # OPTION: MAXBUFLEN
 132 #         Maximum client AJAX recieve buffer size (in bytes), if this
 133 #         buffer size is exceeded then the client will be disconnected.
 134 MAXBUFLEN = 10000
 135
 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
 141 #         irssi-proxy.
 142 MAXSUBSCRIPTIONS = 1
 143
 144 # OPTION: MAXLINELEN
 145 #         If the client sends a line greater than MAXLINELEN (in bytes)
 146 #         then they will be disconnected.
 147 MAXLINELEN = 600
 148
 149 # OPTION: DNS_TIMEOUT
 150 #         DNS requests that do not respond within DNS_TIMEOUT seconds
 151 #         will cancelled.
 152 DNS_TIMEOUT = 5
 153
 154 # OPTION: HTTP_AJAX_REQUEST_TIMEOUT
 155 #         Connections made to the AJAX engine are closed after this
 156 #         this many seconds.
 157 #         Note that this value is intimately linked with the client
 158 #         AJAX code at this time, changing it will result in bad
 159 #         things happening.
 160 HTTP_AJAX_REQUEST_TIMEOUT = 30
 161
 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
 167
 168 # QUAKENET SPECIFIC VALUES
 169 # ---------------------------------------------------------------------
 170 #
 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.
 173 #
 174 # OPTION: HMACKEY
 175 #         Shared key to use with hmac WEBIRC_MODE.
 176 HMACKEY = "mrmoo"
 177
 178 # OPTION: HMACTEMPORAL
 179 #         Divisor used for modulo HMAC timestamp generation.
 180 HMACTEMPORAL = 30
 181
 182 # OPTION: AUTHGATEDOMAIN
 183 #         Domain accepted inside authgate tickets.
 184 AUTHGATEDOMAIN = "webchat_test"
 185
 186 # OPTION: QTICKETKEY
 187 #         Key shared with the authgate that is used to decrypt
 188 #         qtickets.
 189 QTICKETKEY = "boo"
 190
 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"
 195
 196 # OPTION: AUTH_OK_REGEX
 197 #         JavaScript regular expression that should match when
 198 #         AUTH_SERVICE has returned an acceptable response to
 199 #         authentication.
 200 AUTH_OK_REGEX = "^You are now logged in as [^ ]+\\.$"
 201
 202 # OPTION: AUTHGATEPROVIDER
 203 #         Authgate module to use, normally imported directly.
 204 #         dummyauthgate does nothing.
 205 import dummyauthgate as AUTHGATEPROVIDER