Add pidfile option to run.py.

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

diff --git a/config.py.example b/config.py.example
index c2280e2edccc7d95cbf9d41f3ab364b721cb8177..ac727d9d0c2d0a076bce0d2bce192e152c14e6df 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,25 +25,32 @@ 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
-#             Use WEBIRC type blocks, with a server configuration of
-#             the following style:
-#             cgiirc {
-#               type webirc;
-#               hostname <qwebirc's ip address>;
-#               password <password>;
-#             };
-#             Remember to set the WEBIRC_PASSWORD value to be the
-#             same as <password>.
+#         - webirc
+#           Use WEBIRC type blocks, with a server configuration of
+#           the following style:
+#
+#           cgiirc {
+#             type webirc;
+#             hostname <qwebirc's ip address>;
+#             password <password>;
+#           };
+#
+#           Remember to set the WEBIRC_PASSWORD value to be the
+#           same as <password>.
 #         - cgiirc
 #           old style CGIIRC command, set CGIIRC_STRING to be the
 #           command used to set the ip/hostname, and set
@@ -65,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
@@ -129,7 +140,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,
@@ -142,11 +155,12 @@ 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
 #         DNS requests that do not respond within DNS_TIMEOUT seconds
-#         will cancelled.
+#         will be cancelled.
 DNS_TIMEOUT = 5
 
 # OPTION: HTTP_AJAX_REQUEST_TIMEOUT