config.example.js

   1 var conf = {};
   2
   3 // Run the Kiwi server under a different user/group
   4 conf.user = "";
   5 conf.group = "";
   6
   7
   8 // Log file location
   9 conf.log = "kiwi.log";
  10
  11
  12
  13 /*
  14  * Server listen blocks
  15  */
  16
  17 // Do not edit this line!
  18 conf.servers = [];
  19
  20 // Example server block
  21 conf.servers.push({
  22     port:   7778,
  23     address: "0.0.0.0"
  24 });
  25
  26 // Example SSL server block
  27 //conf.servers.push({
  28 //    port:     7777,
  29 //    address: "0.0.0.0",
  30 //
  31 //    ssl:   true,
  32 //    ssl_key: "server.key",
  33 //    ssl_cert: "cert.pem"
  34 //});
  35
  36
  37
  38
  39
  40
  41 // Where the client files are
  42 conf.public_http = "client/";
  43
  44 // Max connections per connection. 0 to disable
  45 conf.max_client_conns = 5;
  46
  47
  48 /*
  49  * Client side plugins
  50  * Array of URLs that will be loaded into the browser when the client first loads up
  51  * See http://github.com/prawnsalad/KiwiIRC/wiki/Client-plugins
  52  */
  53 conf.client_plugins = [
  54     // "http://server.com/kiwi/plugins/myplugin.html"
  55 ];
  56
  57
  58
  59 // Enabled CAP extensions (See ENTER URL TO CAP INFO HERE PLS)
  60 conf.cap_options = [];
  61
  62
  63
  64
  65 // Directory to find the server modules
  66 conf.module_dir = "../server_modules/";
  67
  68 // Which modules to load
  69 conf.modules = [];
  70
  71
  72
  73
  74 // WebIRC passwords enabled for this server
  75 conf.webirc_pass = {
  76     //"irc.network.com":  "configured_webirc_password",
  77     //"127.0.0.1":        "foobar"
  78 };
  79
  80 // Some IRCDs require the clients IP via the username/ident
  81 conf.ip_as_username = [
  82         "irc.network.com",
  83         "127.0.0.1"
  84 ];
  85
  86 // Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
  87 conf.reject_unauthorised_certificates = false;
  88
  89
  90
  91 /*
  92  * Reverse proxy settings
  93  * Reverse proxies that have been reported to work can be found at:
  94  *     http://github.com/prawnsalad/KiwiIRC/wiki/Running-behind-a-proxy
  95  */
  96
  97 // Whitelisted HTTP proxies in CIDR format
  98 conf.http_proxies = ["127.0.0.1/32"];
  99
 100 // Header that contains the real-ip from the HTTP proxy
 101 conf.http_proxy_ip_header = "x-forwarded-for";
 102
 103 // Base HTTP path to the KIWI IRC client (eg. /kiwi)
 104 conf.http_base_path = "/kiwi";
 105
 106
 107 /*
 108  * SOCKS (version 5) proxy settings
 109  */
 110 conf.socks_proxy = {};
 111
 112 // Enable proxying outbound connections through a SOCKS proxy
 113 conf.socks_proxy.enabled = false;
 114
 115 // Proxy *all* outbound connections through a SOCKS proxy
 116 conf.socks_proxy.all = false;
 117
 118 // Use SOCKS proxy for these hosts only (if conf.sock_proxy.all === false)
 119 conf.socks_proxy.proxy_hosts = [
 120     "irc.example.com"
 121 ];
 122
 123 // Host and port for the SOCKS proxy
 124 conf.socks_proxy.address = '127.0.0.1';
 125 conf.socks_proxy.port = 1080;
 126
 127 // Username and password for the SOCKS proxy
 128 // Set user to null to disable password authentication
 129 conf.socks_proxy.user = null;
 130 conf.socks_proxy.pass = null;
 131
 132
 133 // Enabled transports for the browser to use
 134 conf.transports = [
 135     "websocket",
 136     "flashsocket",
 137     "htmlfile",
 138     "xhr-polling",
 139     "jsonp-polling"
 140 ];
 141
 142
 143
 144
 145 // Default quit message
 146 conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
 147
 148
 149 // Default settings for the client. These may be changed in the browser
 150 conf.client = {
 151     server: 'irc.kiwiirc.com',
 152     port:    6697,
 153     ssl:     true,
 154     channel: '#kiwiirc',
 155     nick:    'kiwi_?'
 156 };
 157
 158
 159 // If not empty, the client may only connect to this 1 IRC server
 160 //conf.restrict_server = "irc.kiwiirc.com";
 161 //conf.restrict_server_port = 6667;
 162 //conf.restrict_server_ssl = false;
 163 //conf.restrict_server_channel = "#kiwiirc";
 164 //conf.restrict_server_password = "";
 165 //conf.restrict_server_nick = "kiwi_";
 166
 167
 168
 169
 170 /*
 171  * Do not ammend the below lines unless you understand the changes!
 172  */
 173 module.exports.production = conf;