LibreJS compatibility modifications
[KiwiIRC.git] / config.example.js
index bf107638ba8e0e17151d087ac81ccb295d280245..d1f21e7769eea78494784f1c037db8e8d23cf054 100644 (file)
@@ -33,6 +33,20 @@ 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?
+conf.identd = {
+    enabled: false,
+    port: 113,
+    address: "0.0.0.0"
+};
+
 
 
 
@@ -41,9 +55,42 @@ conf.servers.push({
 // 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;
 
+// Max connections per server. 0 to disable.
+// Setting is ignored if:
+//   - There is a WEBIRC password configured for the server,
+//   - Kiwi is configured to send the client's ip as a username for the server, or
+//   - 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
@@ -56,31 +103,29 @@ 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 = "./kiwi_modules/";
+conf.module_dir = "../server_modules/";
 
 // Which modules to load
-conf.modules = ["spamfilter", "statistics"];
+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 = [
-       "irc.network.com",
-       "127.0.0.1"
+    //"irc.network.com",
+    //"127.0.0.1"
 ];
 
 // Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
@@ -91,8 +136,9 @@ 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
 conf.http_proxies = ["127.0.0.1/32"];
 
@@ -103,16 +149,32 @@ conf.http_proxy_ip_header = "x-forwarded-for";
 conf.http_base_path = "/kiwi";
 
 
+/*
+ * SOCKS (version 5) proxy settings
+ * This feature is only available on node 0.10.0 and above.
+ * Do not enable it if you're running 0.8 or below or Bad Things will happen.
+ */
+conf.socks_proxy = {};
+
+// Enable proxying outbound connections through a SOCKS proxy
+conf.socks_proxy.enabled = false;
+
+// Proxy *all* outbound connections through a SOCKS proxy
+conf.socks_proxy.all = false;
 
-// Enabled transports for the browser to use
-conf.transports = [
-    "websocket",
-    "flashsocket",
-    "htmlfile",
-    "xhr-polling",
-    "jsonp-polling"
+// Use SOCKS proxy for these hosts only (if conf.sock_proxy.all === false)
+conf.socks_proxy.proxy_hosts = [
+    "irc.example.com"
 ];
 
+// Host and port for the SOCKS proxy
+conf.socks_proxy.address = '127.0.0.1';
+conf.socks_proxy.port = 1080;
+
+// Username and password for the SOCKS proxy
+// Set user to null to disable password authentication
+conf.socks_proxy.user = null;
+conf.socks_proxy.pass = null;
 
 
 
@@ -120,16 +182,51 @@ conf.transports = [
 conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
 
 
-// If not empty, the client may only connect to this 1 IRC server
+// Default settings for the client. These may be changed in the browser
+conf.client = {
+    server: 'irc.kiwiirc.com',
+    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,
+        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_";
 
 
+
+
 /*
- * 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;
\ No newline at end of file
+module.exports.production = conf;