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 ac727d9d0c2d0a076bce0d2bce192e152c14e6df..267d0244ab8840435013a9bf9724d1dcf2de18bc 100644 (file)
--- a/config.py.example
+++ b/config.py.example
@@ -39,7 +39,7 @@ IDENT = "webchat"
 #         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:
 #
@@ -51,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
@@ -118,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
 # ---------------------------------------------------------------------
 #
@@ -126,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
 # ---------------------------------------------------------------------
 #
@@ -177,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
 # ---------------------------------------------------------------------
 #