Merge branch 'master' into development

[KiwiIRC.git] / config.example.js

diff --git a/config.example.js b/config.example.js
index 286ee214d79bacd3ed3b17c6b61c5bf2d0430c60..9732497638973b4b6108ed5a35681ce75ce3b884 100644 (file)
--- a/config.example.js
+++ b/config.example.js
@@ -35,6 +35,15 @@ conf.servers.push({
 
 
 
+// Do we want to enable the built in Identd server?
+conf.identd = {
+    enabled: false,
+    port: 113,
+    address: "0.0.0.0"
+};
+
+
+
 
 
 
@@ -44,6 +53,13 @@ conf.public_http = "client/";
 // 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;
+
 
 /*
  * Client side plugins
@@ -79,8 +95,8 @@ conf.webirc_pass = {
 
 // 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
@@ -104,6 +120,33 @@ 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;
+
+// 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;
+
 
 // Enabled transports for the browser to use
 conf.transports = [
@@ -127,11 +170,19 @@ conf.client = {
     port:    6697,
     ssl:     true,
     channel: '#kiwiirc',
-    nick:    'kiwi_?'
+    nick:    'kiwi_?',
+    settings: {
+        theme: 'relaxed',
+        channel_list_style: 'tabs',
+        scrollback: 250,
+        show_joins_parts: true,
+        show_timestamps: false,
+        mute_sounds: false
+    }
 };
 
 
-// If not empty, the client may only connect to this 1 IRC server
+// 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;
@@ -145,4 +196,4 @@ conf.client = {
 /*
  * Do not ammend the below lines unless you understand the changes!
  */
-module.exports.production = conf;
\ No newline at end of file
+module.exports.production = conf;