more names into about

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

diff --git a/config.py.example b/config.py.example
index 7bdda5d9f02feb56ef025c91e9465b8de3506979..779226e2035edf764df32d477c3b5ae032cec59d 100644 (file)
--- a/config.py.example
+++ b/config.py.example
@@ -20,6 +20,11 @@ from qwebirc.config_options import *
 #         Port of IRC server to connect to.
 IRCSERVER, IRCPORT = "irc.myserver.com", 6667
 
+# OPTION: SSLPORT
+#         SSL port of IRC server to connect to.
+#         If this option is uncommented it will override IRCPORT.
+#SSLPORT = 6697
+
 # OPTION: REALNAME
 #         The realname field of IRC clients will be set to this value.
 REALNAME = "http://moo.com/"
@@ -34,6 +39,14 @@ REALNAME = "http://moo.com/"
 #          supplied nickname as their ident.
 IDENT = "webchat"
 
+# OPTION: OUTGOING_IP
+#         The IP address to bind to when connecting to the IRC server.
+#
+#         This will not change the IP address that qwebirc listens on. 
+#         You will need to call run.py with the --ip/-i option if you 
+#         want that.
+#OUTGOING_IP = "127.0.0.1"
+
 # OPTION: WEBIRC_MODE
 #         This option controls how the IP/hostname of the connecting
 #         browser will be sent to IRC.
@@ -84,10 +97,46 @@ BASE_URL = "http://foo.foo.org/"
 #         application.
 NETWORK_NAME = "FooNet"
 
+# OPTION: ANALYTICS_HTML
+#         If you have an analytics service, you can paste the HTML
+#         between the triple quotes.
+#ANALYTICS_HTML = """
+#"""
+
 # OPTION: APP_TITLE
 #         The title of the application in the web browser.
 APP_TITLE = NETWORK_NAME + " Web IRC"
 
+# NICKNAME VALIDATION OPTIONS
+# ---------------------------------------------------------------------
+#
+# OPTION: NICKNAME_VALIDATE
+#         If True then user nicknames will be validated according to
+#         the configuration below, otherwise they will be passed
+#         directly to the ircd.
+NICKNAME_VALIDATE = True
+
+# OPTION: NICKNAME_VALID_FIRST_CHAR
+#         A string containing valid characters for the first letter of
+#         a nickname.
+#         Default is as in RFC1459.
+import string
+NICKNAME_VALID_FIRST_CHAR = string.letters + "_[]{}`^\\|"
+
+# OPTION: NICKNAME_VALID_SUBSEQUENT_CHAR
+#         A string containing valid characters for the rest of the
+#         nickname.
+NICKNAME_VALID_SUBSEQUENT_CHARS = NICKNAME_VALID_FIRST_CHAR + string.digits + "-"
+
+# OPTION: NICKNAME_MINIMUM_LENGTH
+#         Minimum characters permitted in a nickname on your network.
+NICKNAME_MINIMUM_LENGTH = 2
+
+# OPTION: NICKNAME_MAXIMUM_LENGTH
+#         Maximum characters permitted in a nickname on your network.
+#         Ideally we'd extract this from the ircd, but we need to know
+#         before we connect.
+NICKNAME_MAXIMUM_LENGTH = 15
 
 # FEEDBACK OPTIONS
 # ---------------------------------------------------------------------
@@ -219,6 +268,11 @@ DYNAMIC_BASE_URL = ""
 #         the system's default resolver(s).
 CONNECTION_RESOLVER = None
 
+# OPTION: HELP_URL
+#         Shown to the user if they type /HELP or click on the Help!
+#         option in the user interface.
+HELP_URL = ""
+
 # QUAKENET SPECIFIC VALUES
 # ---------------------------------------------------------------------
 #