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