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 // Do we want to enable the built in Identd server?
  39 conf.identd = {
  40     enabled: false,
  41     port: 113,
  42     address: "0.0.0.0"
  43 };
  44
  45
  46
  47
  48
  49
  50 // Where the client files are
  51 conf.public_http = "client/";
  52
  53 // Max connections per connection. 0 to disable
  54 conf.max_client_conns = 5;
  55
  56
  57 /*
  58  * Client side plugins
  59  * Array of URLs that will be loaded into the browser when the client first loads up
  60  * See http://github.com/prawnsalad/KiwiIRC/wiki/Client-plugins
  61  */
  62 conf.client_plugins = [
  63     // "http://server.com/kiwi/plugins/myplugin.html"
  64 ];
  65
  66
  67
  68 // Enabled CAP extensions (See ENTER URL TO CAP INFO HERE PLS)
  69 conf.cap_options = [];
  70
  71
  72
  73
  74 // Directory to find the server modules
  75 conf.module_dir = "../server_modules/";
  76
  77 // Which modules to load
  78 conf.modules = [];
  79
  80
  81
  82
  83 // WebIRC passwords enabled for this server
  84 conf.webirc_pass = {
  85     //"irc.network.com":  "configured_webirc_password",
  86     //"127.0.0.1":        "foobar"
  87 };
  88
  89 // Some IRCDs require the clients IP via the username/ident
  90 conf.ip_as_username = [
  91     //"irc.network.com",
  92     //"127.0.0.1"
  93 ];
  94
  95 // Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
  96 conf.reject_unauthorised_certificates = false;
  97
  98
  99
 100 /*
 101  * Reverse proxy settings
 102  * Reverse proxies that have been reported to work can be found at:
 103  *     http://github.com/prawnsalad/KiwiIRC/wiki/Running-behind-a-proxy
 104  */
 105
 106 // Whitelisted HTTP proxies in CIDR format
 107 conf.http_proxies = ["127.0.0.1/32"];
 108
 109 // Header that contains the real-ip from the HTTP proxy
 110 conf.http_proxy_ip_header = "x-forwarded-for";
 111
 112 // Base HTTP path to the KIWI IRC client (eg. /kiwi)
 113 conf.http_base_path = "/kiwi";
 114
 115
 116 /*
 117  * SOCKS (version 5) proxy settings
 118  * This feature is only available on node 0.10.0 and above.
 119  * Do not enable it if you're running 0.8 or below or Bad Things will happen.
 120  */
 121 conf.socks_proxy = {};
 122
 123 // Enable proxying outbound connections through a SOCKS proxy
 124 conf.socks_proxy.enabled = false;
 125
 126 // Proxy *all* outbound connections through a SOCKS proxy
 127 conf.socks_proxy.all = false;
 128
 129 // Use SOCKS proxy for these hosts only (if conf.sock_proxy.all === false)
 130 conf.socks_proxy.proxy_hosts = [
 131     "irc.example.com"
 132 ];
 133
 134 // Host and port for the SOCKS proxy
 135 conf.socks_proxy.address = '127.0.0.1';
 136 conf.socks_proxy.port = 1080;
 137
 138 // Username and password for the SOCKS proxy
 139 // Set user to null to disable password authentication
 140 conf.socks_proxy.user = null;
 141 conf.socks_proxy.pass = null;
 142
 143
 144 // Enabled transports for the browser to use
 145 conf.transports = [
 146     "websocket",
 147     "flashsocket",
 148     "htmlfile",
 149     "xhr-polling",
 150     "jsonp-polling"
 151 ];
 152
 153
 154
 155
 156 // Default quit message
 157 conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
 158
 159
 160 // Default settings for the client. These may be changed in the browser
 161 conf.client = {
 162     server: 'irc.kiwiirc.com',
 163     port:    6697,
 164     ssl:     true,
 165     channel: '#kiwiirc',
 166     nick:    'kiwi_?'
 167 };
 168
 169
 170 // If set, the client may only connect to this 1 IRC server
 171 //conf.restrict_server = "irc.kiwiirc.com";
 172 //conf.restrict_server_port = 6667;
 173 //conf.restrict_server_ssl = false;
 174 //conf.restrict_server_channel = "#kiwiirc";
 175 //conf.restrict_server_password = "";
 176 //conf.restrict_server_nick = "kiwi_";
 177
 178
 179
 180
 181 /*
 182  * Do not ammend the below lines unless you understand the changes!
 183  */
 184 module.exports.production = conf;