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 // Max connections per server. 0 to disable.
  57 // Setting is ignored if there is a WEBIRC password configured for the server or kiwi is running in restricted server mode.
  58 conf.max_server_conns = 0;
  59
  60
  61 /*
  62  * Client side plugins
  63  * Array of URLs that will be loaded into the browser when the client first loads up
  64  * See http://github.com/prawnsalad/KiwiIRC/wiki/Client-plugins
  65  */
  66 conf.client_plugins = [
  67     // "http://server.com/kiwi/plugins/myplugin.html"
  68 ];
  69
  70
  71
  72 // Enabled CAP extensions (See ENTER URL TO CAP INFO HERE PLS)
  73 conf.cap_options = [];
  74
  75
  76
  77
  78 // Directory to find the server modules
  79 conf.module_dir = "../server_modules/";
  80
  81 // Which modules to load
  82 conf.modules = [];
  83
  84
  85
  86
  87 // WebIRC passwords enabled for this server
  88 conf.webirc_pass = {
  89     //"irc.network.com":  "configured_webirc_password",
  90     //"127.0.0.1":        "foobar"
  91 };
  92
  93 // Some IRCDs require the clients IP via the username/ident
  94 conf.ip_as_username = [
  95         "irc.network.com",
  96         "127.0.0.1"
  97 ];
  98
  99 // Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
 100 conf.reject_unauthorised_certificates = false;
 101
 102
 103
 104 /*
 105  * Reverse proxy settings
 106  * Reverse proxies that have been reported to work can be found at:
 107  *     http://github.com/prawnsalad/KiwiIRC/wiki/Running-behind-a-proxy
 108  */
 109
 110 // Whitelisted HTTP proxies in CIDR format
 111 conf.http_proxies = ["127.0.0.1/32"];
 112
 113 // Header that contains the real-ip from the HTTP proxy
 114 conf.http_proxy_ip_header = "x-forwarded-for";
 115
 116 // Base HTTP path to the KIWI IRC client (eg. /kiwi)
 117 conf.http_base_path = "/kiwi";
 118
 119
 120
 121 // Enabled transports for the browser to use
 122 conf.transports = [
 123     "websocket",
 124     "flashsocket",
 125     "htmlfile",
 126     "xhr-polling",
 127     "jsonp-polling"
 128 ];
 129
 130
 131
 132
 133 // Default quit message
 134 conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
 135
 136
 137 // Default settings for the client. These may be changed in the browser
 138 conf.client = {
 139     server: 'irc.kiwiirc.com',
 140     port:    6697,
 141     ssl:     true,
 142     channel: '#kiwiirc',
 143     nick:    'kiwi_?'
 144 };
 145
 146
 147 // If set, the client may only connect to this 1 IRC server
 148 //conf.restrict_server = "irc.kiwiirc.com";
 149 //conf.restrict_server_port = 6667;
 150 //conf.restrict_server_ssl = false;
 151 //conf.restrict_server_channel = "#kiwiirc";
 152 //conf.restrict_server_password = "";
 153 //conf.restrict_server_nick = "kiwi_";
 154
 155
 156
 157
 158 /*
 159  * Do not ammend the below lines unless you understand the changes!
 160  */
 161 module.exports.production = conf;