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