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