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