X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=config.example.js;h=d1f21e7769eea78494784f1c037db8e8d23cf054;hb=a3ee84371397ba78623f4a04294ef40f7f7f6e7b;hp=626b80435980b6ba58cda419da683e8126596e56;hpb=d1b3e8b3777af1b391545b05cebd3929bf3c6e09;p=KiwiIRC.git diff --git a/config.example.js b/config.example.js index 626b804..d1f21e7 100644 --- a/config.example.js +++ b/config.example.js @@ -33,6 +33,11 @@ conf.servers.push({ // ssl_cert: "cert.pem" //}); +// Network interface for outgoing connections +conf.outgoing_address = { + IPv4: '0.0.0.0' + //IPv6: '::' +}; // Do we want to enable the built in Identd server? @@ -50,6 +55,10 @@ conf.identd = { // Where the client files are conf.public_http = "client/"; +// Transports available to the client. +// Behind an Apache reverse proxy? Uncomment the below - Apache does not support websockets! +//conf.client_transports = ['polling']; + // Max connections per connection. 0 to disable conf.max_client_conns = 5; @@ -61,11 +70,27 @@ conf.max_client_conns = 5; conf.max_server_conns = 0; /* -* Available encodings supported by the server +* Default encoding to be used by the server * As specified and limited to iconv-lite library support. -* All upper-case. Default is the first element on the list. */ -conf.available_encodings = ['UTF-8', 'WINDOWS-1252']; +conf.default_encoding = 'utf8'; + + +/* +* Default GECOS (real name) for IRC connections +* %n will be replaced with the users nick +* %h will be replaced with the users hostname +*/ +//conf.default_gecos = 'Web IRC Client'; + + +/* +* Auto reconnect if the IRC server disconnects a kiwi user +* Hundreds of connected users getting disconnected then reconnecting at once may see +* high CPU usage causing further dropouts. Set to false if under high usage. +*/ +conf.ircd_reconnect = true; + /* * Client side plugins @@ -78,11 +103,6 @@ conf.client_plugins = [ -// Enabled CAP extensions (See ENTER URL TO CAP INFO HERE PLS) -conf.cap_options = []; - - - // Directory to find the server modules conf.module_dir = "../server_modules/"; @@ -93,11 +113,14 @@ conf.modules = []; -// WebIRC passwords enabled for this server -conf.webirc_pass = { - //"irc.network.com": "configured_webirc_password", - //"127.0.0.1": "foobar" -}; +// WebIRC password enabled for this server +//conf.webirc_pass = "foobar"; + +// Multiple WebIRC passwords may be used for multiple servers +//conf.webirc_pass = { +// "irc.network.com": "configured_webirc_password", +// "127.0.0.1": "foobar" +//}; // Some IRCDs require the clients IP via the username/ident conf.ip_as_username = [ @@ -113,7 +136,7 @@ conf.reject_unauthorised_certificates = false; /* * Reverse proxy settings * Reverse proxies that have been reported to work can be found at: - * http://github.com/prawnsalad/KiwiIRC/wiki/Running-behind-a-proxy + * https://kiwiirc.com/docs/installing/proxies */ // Whitelisted HTTP proxies in CIDR format @@ -154,17 +177,6 @@ conf.socks_proxy.user = null; conf.socks_proxy.pass = null; -// Enabled transports for the browser to use -conf.transports = [ - "websocket", - "flashsocket", - "htmlfile", - "xhr-polling", - "jsonp-polling" -]; - - - // Default quit message conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client"; @@ -176,23 +188,38 @@ conf.client = { port: 6697, ssl: true, channel: '#kiwiirc', + channel_key: '', nick: 'kiwi_?', settings: { theme: 'relaxed', + text_theme: 'default', channel_list_style: 'tabs', scrollback: 250, show_joins_parts: true, show_timestamps: false, - mute_sounds: false - } + use_24_hour_timestamps: true, + mute_sounds: false, + show_emoticons: true, + count_all_activity: false + }, + window_title: 'Kiwi IRC' }; +// List of themes available for the user to choose from +conf.client_themes = [ + 'relaxed', + 'mini', + 'cli', + 'basic' +]; + // If set, the client may only connect to this 1 IRC server //conf.restrict_server = "irc.kiwiirc.com"; //conf.restrict_server_port = 6667; //conf.restrict_server_ssl = false; //conf.restrict_server_channel = "#kiwiirc"; +//conf.restrict_server_channel_key = ""; //conf.restrict_server_password = ""; //conf.restrict_server_nick = "kiwi_"; @@ -200,6 +227,6 @@ conf.client = { /* - * Do not ammend the below lines unless you understand the changes! + * Do not amend the below lines unless you understand the changes! */ module.exports.production = conf;