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 // Transports available to the client.
  59 // Behind an Apache reverse proxy? Uncomment the below - Apache does not support websockets!
  60 //conf.client_transports = ['polling'];
  61
  62 // Max connections per connection. 0 to disable
  63 conf.max_client_conns = 5;
  64
  65 // Max connections per server. 0 to disable.
  66 // Setting is ignored if:
  67 //   - There is a WEBIRC password configured for the server,
  68 //   - Kiwi is configured to send the client's ip as a username for the server, or
  69 //   - Kiwi is running in restricted server mode.
  70 conf.max_server_conns = 0;
  71
  72 /*
  73 * Default encoding to be used by the server
  74 * As specified and limited to iconv-lite library support.
  75 */
  76 conf.default_encoding = 'utf8';
  77
  78
  79 /*
  80 * Default GECOS (real name) for IRC connections
  81 * %n will be replaced with the users nick
  82 * %h will be replaced with the users hostname
  83 */
  84 //conf.default_gecos = 'Web IRC Client';
  85
  86
  87 /*
  88 * Auto reconnect if the IRC server disconnects a kiwi user
  89 * Hundreds of connected users getting disconnected then reconnecting at once may see
  90 * high CPU usage causing further dropouts. Set to false if under high usage.
  91 */
  92 conf.ircd_reconnect = true;
  93
  94
  95 /*
  96  * Client side plugins
  97  * Array of URLs that will be loaded into the browser when the client first loads up
  98  * See http://github.com/prawnsalad/KiwiIRC/wiki/Client-plugins
  99  */
 100 conf.client_plugins = [
 101     // "http://server.com/kiwi/plugins/myplugin.html"
 102 ];
 103
 104
 105
 106
 107 // Directory to find the server modules
 108 conf.module_dir = "../server_modules/";
 109
 110 // Which modules to load
 111 conf.modules = [];
 112
 113
 114
 115
 116 // WebIRC password enabled for this server
 117 //conf.webirc_pass = "foobar";
 118
 119 // Multiple WebIRC passwords may be used for multiple servers
 120 //conf.webirc_pass = {
 121 //    "irc.network.com":  "configured_webirc_password",
 122 //    "127.0.0.1":        "foobar"
 123 //};
 124
 125 // Some IRCDs require the clients IP via the username/ident
 126 conf.ip_as_username = [
 127     //"irc.network.com",
 128     //"127.0.0.1"
 129 ];
 130
 131 // Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
 132 conf.reject_unauthorised_certificates = false;
 133
 134
 135
 136 /*
 137  * Reverse proxy settings
 138  * Reverse proxies that have been reported to work can be found at:
 139  *     https://kiwiirc.com/docs/installing/proxies
 140  */
 141
 142 // Whitelisted HTTP proxies in CIDR format
 143 conf.http_proxies = ["127.0.0.1/32"];
 144
 145 // Header that contains the real-ip from the HTTP proxy
 146 conf.http_proxy_ip_header = "x-forwarded-for";
 147
 148 // Base HTTP path to the KIWI IRC client (eg. /kiwi)
 149 conf.http_base_path = "/kiwi";
 150
 151
 152 /*
 153  * SOCKS (version 5) proxy settings
 154  * This feature is only available on node 0.10.0 and above.
 155  * Do not enable it if you're running 0.8 or below or Bad Things will happen.
 156  */
 157 conf.socks_proxy = {};
 158
 159 // Enable proxying outbound connections through a SOCKS proxy
 160 conf.socks_proxy.enabled = false;
 161
 162 // Proxy *all* outbound connections through a SOCKS proxy
 163 conf.socks_proxy.all = false;
 164
 165 // Use SOCKS proxy for these hosts only (if conf.sock_proxy.all === false)
 166 conf.socks_proxy.proxy_hosts = [
 167     "irc.example.com"
 168 ];
 169
 170 // Host and port for the SOCKS proxy
 171 conf.socks_proxy.address = '127.0.0.1';
 172 conf.socks_proxy.port = 1080;
 173
 174 // Username and password for the SOCKS proxy
 175 // Set user to null to disable password authentication
 176 conf.socks_proxy.user = null;
 177 conf.socks_proxy.pass = null;
 178
 179
 180
 181 // Default quit message
 182 conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
 183
 184
 185 // Default settings for the client. These may be changed in the browser
 186 conf.client = {
 187     server: 'irc.kiwiirc.com',
 188     port:    6697,
 189     ssl:     true,
 190     channel: '#kiwiirc',
 191     channel_key: '',
 192     nick:    'kiwi_?',
 193     settings: {
 194         theme: 'relaxed',
 195         text_theme: 'default',
 196         channel_list_style: 'tabs',
 197         scrollback: 250,
 198         show_joins_parts: true,
 199         show_timestamps: false,
 200         use_24_hour_timestamps: true,
 201         mute_sounds: false,
 202         show_emoticons: true,
 203         count_all_activity: false
 204     },
 205     window_title: 'Kiwi IRC'
 206 };
 207
 208 // List of themes available for the user to choose from
 209 conf.client_themes = [
 210     'relaxed',
 211     'mini',
 212     'cli',
 213     'basic'
 214 ];
 215
 216
 217 // If set, the client may only connect to this 1 IRC server
 218 //conf.restrict_server = "irc.kiwiirc.com";
 219 //conf.restrict_server_port = 6667;
 220 //conf.restrict_server_ssl = false;
 221 //conf.restrict_server_channel = "#kiwiirc";
 222 //conf.restrict_server_channel_key = "";
 223 //conf.restrict_server_password = "";
 224 //conf.restrict_server_nick = "kiwi_";
 225
 226
 227
 228
 229 /*
 230  * Do not amend the below lines unless you understand the changes!
 231  */
 232 module.exports.production = conf;