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
  37
  38 // Do we want to enable the built in Identd server?
  39 conf.identd = {
  40     enabled: false,
  41     port: 113,
  42     address: "0.0.0.0"
  43 };
  44
  45
  46
  47
  48
  49
  50 // Where the client files are
  51 conf.public_http = "client/";
  52
  53 // Max connections per connection. 0 to disable
  54 conf.max_client_conns = 5;
  55
  56 // Max connections per server. 0 to disable.
  57 // Setting is ignored if:
  58 //   - There is a WEBIRC password configured for the server,
  59 //   - Kiwi is configured to send the client's ip as a username for the server, or
  60 //   - Kiwi is running in restricted server mode.
  61 conf.max_server_conns = 0;
  62
  63
  64 /*
  65  * Client side plugins
  66  * Array of URLs that will be loaded into the browser when the client first loads up
  67  * See http://github.com/prawnsalad/KiwiIRC/wiki/Client-plugins
  68  */
  69 conf.client_plugins = [
  70     // "http://server.com/kiwi/plugins/myplugin.html"
  71 ];
  72
  73
  74
  75 // Enabled CAP extensions (See ENTER URL TO CAP INFO HERE PLS)
  76 conf.cap_options = [];
  77
  78
  79
  80
  81 // Directory to find the server modules
  82 conf.module_dir = "../server_modules/";
  83
  84 // Which modules to load
  85 conf.modules = [];
  86
  87
  88
  89
  90 // WebIRC passwords enabled for this server
  91 conf.webirc_pass = {
  92     //"irc.network.com":  "configured_webirc_password",
  93     //"127.0.0.1":        "foobar"
  94 };
  95
  96 // Some IRCDs require the clients IP via the username/ident
  97 conf.ip_as_username = [
  98     //"irc.network.com",
  99     //"127.0.0.1"
 100 ];
 101
 102 // Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
 103 conf.reject_unauthorised_certificates = false;
 104
 105
 106
 107 /*
 108  * Reverse proxy settings
 109  * Reverse proxies that have been reported to work can be found at:
 110  *     http://github.com/prawnsalad/KiwiIRC/wiki/Running-behind-a-proxy
 111  */
 112
 113 // Whitelisted HTTP proxies in CIDR format
 114 conf.http_proxies = ["127.0.0.1/32"];
 115
 116 // Header that contains the real-ip from the HTTP proxy
 117 conf.http_proxy_ip_header = "x-forwarded-for";
 118
 119 // Base HTTP path to the KIWI IRC client (eg. /kiwi)
 120 conf.http_base_path = "/kiwi";
 121
 122
 123 /*
 124  * SOCKS (version 5) proxy settings
 125  * This feature is only available on node 0.10.0 and above.
 126  * Do not enable it if you're running 0.8 or below or Bad Things will happen.
 127  */
 128 conf.socks_proxy = {};
 129
 130 // Enable proxying outbound connections through a SOCKS proxy
 131 conf.socks_proxy.enabled = false;
 132
 133 // Proxy *all* outbound connections through a SOCKS proxy
 134 conf.socks_proxy.all = false;
 135
 136 // Use SOCKS proxy for these hosts only (if conf.sock_proxy.all === false)
 137 conf.socks_proxy.proxy_hosts = [
 138     "irc.example.com"
 139 ];
 140
 141 // Host and port for the SOCKS proxy
 142 conf.socks_proxy.address = '127.0.0.1';
 143 conf.socks_proxy.port = 1080;
 144
 145 // Username and password for the SOCKS proxy
 146 // Set user to null to disable password authentication
 147 conf.socks_proxy.user = null;
 148 conf.socks_proxy.pass = null;
 149
 150
 151 // Enabled transports for the browser to use
 152 conf.transports = [
 153     "websocket",
 154     "flashsocket",
 155     "htmlfile",
 156     "xhr-polling",
 157     "jsonp-polling"
 158 ];
 159
 160
 161
 162
 163 // Default quit message
 164 conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
 165
 166
 167 // Default settings for the client. These may be changed in the browser
 168 conf.client = {
 169     server: 'irc.kiwiirc.com',
 170     port:    6697,
 171     ssl:     true,
 172     channel: '#kiwiirc',
 173     nick:    'kiwi_?',
 174     settings: {
 175         theme: 'relaxed',
 176         channel_list_style: 'tabs',
 177         scrollback: 250,
 178         show_joins_parts: true,
 179         show_timestamps: false,
 180         mute_sounds: false
 181     }
 182 };
 183
 184
 185 // If set, the client may only connect to this 1 IRC server
 186 //conf.restrict_server = "irc.kiwiirc.com";
 187 //conf.restrict_server_port = 6667;
 188 //conf.restrict_server_ssl = false;
 189 //conf.restrict_server_channel = "#kiwiirc";
 190 //conf.restrict_server_password = "";
 191 //conf.restrict_server_nick = "kiwi_";
 192
 193
 194
 195
 196 /*
 197  * Do not ammend the below lines unless you understand the changes!
 198  */
 199 module.exports.production = conf;