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