Merge branch 'spadgos-notifications' into development

[KiwiIRC.git] / config.example.js

diff --git a/config.example.js b/config.example.js
index 9732497638973b4b6108ed5a35681ce75ce3b884..d1f21e7769eea78494784f1c037db8e8d23cf054 100644 (file)
--- a/config.example.js
+++ b/config.example.js
@@ -33,6 +33,11 @@ conf.servers.push({
 //    ssl_cert: "cert.pem"
 //});
 
+// Network interface for outgoing connections
+conf.outgoing_address = {
+    IPv4: '0.0.0.0'
+    //IPv6: '::'
+};
 
 
 // Do we want to enable the built in Identd server?
@@ -50,6 +55,10 @@ conf.identd = {
 // Where the client files are
 conf.public_http = "client/";
 
+// Transports available to the client.
+// Behind an Apache reverse proxy? Uncomment the below - Apache does not support websockets!
+//conf.client_transports = ['polling'];
+
 // Max connections per connection. 0 to disable
 conf.max_client_conns = 5;
 
@@ -60,6 +69,28 @@ conf.max_client_conns = 5;
 //   - Kiwi is running in restricted server mode.
 conf.max_server_conns = 0;
 
+/*
+* Default encoding to be used by the server
+* As specified and limited to iconv-lite library support.
+*/
+conf.default_encoding = 'utf8';
+
+
+/*
+* Default GECOS (real name) for IRC connections
+* %n will be replaced with the users nick
+* %h will be replaced with the users hostname
+*/
+//conf.default_gecos = 'Web IRC Client';
+
+
+/*
+* Auto reconnect if the IRC server disconnects a kiwi user
+* Hundreds of connected users getting disconnected then reconnecting at once may see
+* high CPU usage causing further dropouts. Set to false if under high usage.
+*/
+conf.ircd_reconnect = true;
+
 
 /*
  * Client side plugins
@@ -72,11 +103,6 @@ conf.client_plugins = [
 
 
 
-// Enabled CAP extensions (See ENTER URL TO CAP INFO HERE PLS)
-conf.cap_options = [];
-
-
-
 
 // Directory to find the server modules
 conf.module_dir = "../server_modules/";
@@ -87,11 +113,14 @@ conf.modules = [];
 
 
 
-// WebIRC passwords enabled for this server
-conf.webirc_pass = {
-    //"irc.network.com":  "configured_webirc_password",
-    //"127.0.0.1":        "foobar"
-};
+// WebIRC password enabled for this server
+//conf.webirc_pass = "foobar";
+
+// Multiple WebIRC passwords may be used for multiple servers
+//conf.webirc_pass = {
+//    "irc.network.com":  "configured_webirc_password",
+//    "127.0.0.1":        "foobar"
+//};
 
 // Some IRCDs require the clients IP via the username/ident
 conf.ip_as_username = [
@@ -107,7 +136,7 @@ conf.reject_unauthorised_certificates = false;
 /*
  * Reverse proxy settings
  * Reverse proxies that have been reported to work can be found at:
- *     http://github.com/prawnsalad/KiwiIRC/wiki/Running-behind-a-proxy
+ *     https://kiwiirc.com/docs/installing/proxies
  */
 
 // Whitelisted HTTP proxies in CIDR format
@@ -148,17 +177,6 @@ conf.socks_proxy.user = null;
 conf.socks_proxy.pass = null;
 
 
-// Enabled transports for the browser to use
-conf.transports = [
-    "websocket",
-    "flashsocket",
-    "htmlfile",
-    "xhr-polling",
-    "jsonp-polling"
-];
-
-
-
 
 // Default quit message
 conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
@@ -170,23 +188,38 @@ conf.client = {
     port:    6697,
     ssl:     true,
     channel: '#kiwiirc',
+    channel_key: '',
     nick:    'kiwi_?',
     settings: {
         theme: 'relaxed',
+        text_theme: 'default',
         channel_list_style: 'tabs',
         scrollback: 250,
         show_joins_parts: true,
         show_timestamps: false,
-        mute_sounds: false
-    }
+        use_24_hour_timestamps: true,
+        mute_sounds: false,
+        show_emoticons: true,
+        count_all_activity: false
+    },
+    window_title: 'Kiwi IRC'
 };
 
+// List of themes available for the user to choose from
+conf.client_themes = [
+    'relaxed',
+    'mini',
+    'cli',
+    'basic'
+];
+
 
 // If set, the client may only connect to this 1 IRC server
 //conf.restrict_server = "irc.kiwiirc.com";
 //conf.restrict_server_port = 6667;
 //conf.restrict_server_ssl = false;
 //conf.restrict_server_channel = "#kiwiirc";
+//conf.restrict_server_channel_key = "";
 //conf.restrict_server_password = "";
 //conf.restrict_server_nick = "kiwi_";
 
@@ -194,6 +227,6 @@ conf.client = {
 
 
 /*
- * Do not ammend the below lines unless you understand the changes!
+ * Do not amend the below lines unless you understand the changes!
  */
 module.exports.production = conf;