Add CUSTOM_CSS option and allow it to interact with LOGO_URL

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

diff --git a/config.py.example b/config.py.example
index 485b0f3a5157aa7fff07bc3b01aa873a68f2d7d8..03c3c738b06a06c76a6004441683515524a23d6b 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/"
@@ -92,10 +97,58 @@ BASE_URL = "http://foo.foo.org/"
 #         application.
 NETWORK_NAME = "FooNet"
 
+# OPTION: LOGO_URL
+#         URL (relative or absolute) to your logo (max height 68 pixels).
+#         If not set the default network name will shown in text.
+#         Can be set to "" to display the logo box without setting the
+#         logo (for use with CUSTOM_CSS)
+#LOGO_URL="images/logo.png"
+
+# OPTION: CUSTOM_CSS
+#         Filename of custom css to include.
+#         Must be in the css directory.
+#CUSTOM_CSS="mynetwork.css"
+
+# 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
 # ---------------------------------------------------------------------
@@ -197,7 +250,7 @@ DNS_TIMEOUT = 5
 #         Note that this value is intimately linked with the client
 #         AJAX code at this time, changing it will result in bad
 #         things happening.
-HTTP_AJAX_REQUEST_TIMEOUT = 30
+HTTP_AJAX_REQUEST_TIMEOUT = 295
 
 # OPTION: HTTP_REQUEST_TIMEOUT
 #         Connections made to everything but the AJAX engine will
@@ -227,6 +280,15 @@ 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 = ""
+
+# OPTION: ACCOUNT_WHOIS_COMMAND
+#         Command sent when a username is clicked.
+#ACCOUNT_WHOIS_COMMAND = "/msg Q whois #"
+
 # QUAKENET SPECIFIC VALUES
 # ---------------------------------------------------------------------
 #