Add configuration of dynamic and static base URLs.

[irc/quakenet/qwebirc.git] / config.py.example

diff --git a/config.py.example b/config.py.example
index 92828a8fed59432d67435f250d6386fb03129f49..267d0244ab8840435013a9bf9724d1dcf2de18bc 100644 (file)
--- a/config.py.example
+++ b/config.py.example
@@ -8,6 +8,9 @@
 # both!)
 # If in doubt always re-compile and restart.
 
+# The following line is required, don't remove it!
+from qwebirc.config_options import *
+
 # IRC OPTIONS
 # ---------------------------------------------------------------------
 #
@@ -22,16 +25,21 @@ IRCSERVER, IRCPORT = "irc.myserver.com", 6667
 REALNAME = "http://moo.com/"
 
 # OPTION: IDENT
-#        ident to use on irc, set to the literal value None to use a
-#        hexadecimal version of the IP address, e.g.:
-#        IDENT = None
+#        ident to use on irc, possible values include:
+#        - a string, e.g. IDENT = "webchat"
+#        - the literal value IDENT_HEX, this will set the ident to the
+#          a hexadecimal version of the users IP address, e.g
+#          IDENT = IDENT_HEX
+#        - the literal value IDENT_NICKNAME, this will use the users
+#          supplied nickname as their ident.
 IDENT = "webchat"
 
 # OPTION: WEBIRC_MODE
-#         This option controls how the IP/hostname of the connecting #         browser will be sent to IRC.
+#         This option controls how the IP/hostname of the connecting
+#         browser will be sent to IRC.
 #
 #         Possible values include:
-#         - webirc
+#         - the string "webirc", i.e. WEBIRC_MODE = "webirc"
 #           Use WEBIRC type blocks, with a server configuration of
 #           the following style:
 #
@@ -43,12 +51,12 @@ IDENT = "webchat"
 #
 #           Remember to set the WEBIRC_PASSWORD value to be the
 #           same as <password>.
-#         - cgiirc
+#         - the string "cgiirc", i.e. WEBIRC_MODE = "cgiirc"
 #           old style CGIIRC command, set CGIIRC_STRING to be the
 #           command used to set the ip/hostname, and set
 #           WEBIRC_PASSWORD to be the password used in the server's
 #           configuration file.
-#         - None (the literal value)
+#         - the literal value None, i.e. WEBIRC_MODE = None
 #           Send the IP and hostname in the realname field, overrides
 #          the REALNAME option.
 WEBIRC_MODE = None
@@ -67,7 +75,8 @@ WEBIRC_MODE = None
 # ---------------------------------------------------------------------
 #
 # OPTION: BASE_URL
-#         URL that this qwebirc instance will be available at
+#         URL that this qwebirc instance will be available at, add the
+#         port number if your instance runs on a port other than 80.
 BASE_URL = "http://foo.foo.org/"
 
 # OPTION: NETWORK_NAME
@@ -109,6 +118,20 @@ FEEDBACK_SMTP_HOST, FEEDBACK_SMTP_PORT = "127.0.0.1", 25
 #         http://instance/adminengine
 ADMIN_ENGINE_HOSTS = ["127.0.0.1"]
 
+# PROXY OPTIONS
+# ---------------------------------------------------------------------
+#
+# OPTION: FORWARDED_FOR_HEADER
+#         If you're using a proxy that passes through a forwarded-for
+#         header set this option to the header name, also set
+#         FORWARDED_FOR_IPS.
+#FORWARDED_FOR_HEADER="x-forwarded-for"
+ 
+# OPTION: FORWARDED_FOR_IPS
+#         This option specifies the IP addresses that forwarded-for
+#         headers will be accepted from.
+#FORWARDED_FOR_IPS=["127.0.0.1"]
+
 # EXECUTION OPTIONS
 # ---------------------------------------------------------------------
 #
@@ -117,6 +140,12 @@ ADMIN_ENGINE_HOSTS = ["127.0.0.1"]
 #         with them, see run.py --help for a list of options.
 #ARGS = "-n -p 3989"
 
+# OPTION: SYSLOG_ADDR (optional)
+#         Used in conjunction with util/syslog.py and -s option.
+#         This option specifies the address and port that syslog
+#         datagrams will be sent to.
+#SYSLOG_ADDR = "127.0.0.1", 514
+
 # TUNEABLE VALUES
 # ---------------------------------------------------------------------
 #
@@ -131,7 +160,9 @@ UPDATE_FREQ = 0.5
 # OPTION: MAXBUFLEN
 #         Maximum client AJAX recieve buffer size (in bytes), if this
 #         buffer size is exceeded then the client will be disconnected.
-MAXBUFLEN = 10000
+#         This value should match the client sendq size in your ircd's
+#         configuration.
+MAXBUFLEN = 100000
 
 # OPTION: MAXSUBSCRIPTIONS
 #         Maximum amount of 'subscriptions' to a specific AJAX channel,
@@ -144,6 +175,7 @@ MAXSUBSCRIPTIONS = 1
 # OPTION: MAXLINELEN
 #         If the client sends a line greater than MAXLINELEN (in bytes)
 #         then they will be disconnected.
+#         Note that IRC normally silently drops messages >=512 bytes.
 MAXLINELEN = 600
 
 # OPTION: DNS_TIMEOUT
@@ -165,6 +197,20 @@ HTTP_AJAX_REQUEST_TIMEOUT = 30
 #         that haven't started/completed an HTTP request.
 HTTP_REQUEST_TIMEOUT = 5
 
+# OPTION: STATIC_BASE_URL
+#         This value is used to build the URL for all static HTTP
+#         requests.
+#         You'd find this useful if you're running multiple qwebirc
+#         instances on the same host.
+STATIC_BASE_URL = ""
+
+# OPTION: DYNAMIC_BASE_URL
+#         This value is used to build the URL for all dynamic HTTP
+#         requests.
+#         You'd find this useful if you're running multiple qwebirc
+#         instances on the same host.
+DYNAMIC_BASE_URL = ""
+
 # QUAKENET SPECIFIC VALUES
 # ---------------------------------------------------------------------
 #