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