Example config.js file
[KiwiIRC.git] / 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
39
40
41 // Where the client files are
42 conf.public_http = "client/";
43
44 // Max connections per connection. 0 to disable
45 conf.max_client_conns = 5;
46
47
48 /*
49 * Client side plugins
50 * Array of URLs that will be loaded into the browser when the client first loads up
51 * See http://github.com/prawnsalad/KiwiIRC/wiki/Client-plugins
52 */
53 conf.client_plugins = [
54 // "http://server.com/kiwi/plugins/myplugin.html"
55 ];
56
57
58
59 // Enabled CAP extensions (See ENTER URL TO CAP INFO HERE PLS)
60 conf.cap_options = [];
61
62
63
64
65 // Directory to find the server modules
66 conf.module_dir = "./kiwi_modules/";
67
68 // Which modules to load
69 conf.modules = ["spamfilter", "statistics"];
70
71
72
73
74 // WebIRC passwords enabled for this server
75 conf.webirc_pass = {
76 //"irc.network.com": "configured_webirc_password",
77 //"127.0.0.1": "foobar"
78 };
79
80 // Some IRCDs require the clients IP via the username/ident
81 conf.ip_as_username = [
82 "irc.network.com",
83 "127.0.0.1"
84 ];
85
86 // Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
87 conf.reject_unauthorised_certificates = false;
88
89
90
91 /*
92 * Reverse proxy settings
93 * Reverse proxies that have been reported to work can be found at:
94 * http://github.com/prawnsalad/KiwiIRC/wiki/Running-behind-a-proxy
95 */
96 // Whitelisted HTTP proxies in CIDR format
97 conf.http_proxies = ["127.0.0.1/32"];
98
99 // Header that contains the real-ip from the HTTP proxy
100 conf.http_proxy_ip_header = "x-forwarded-for";
101
102 // Base HTTP path to the KIWI IRC client (eg. /kiwi)
103 conf.http_base_path = "/kiwi";
104
105
106
107 // Enabled transports for the browser to use
108 conf.transports = [
109 "websocket",
110 "flashsocket",
111 "htmlfile",
112 "xhr-polling",
113 "jsonp-polling"
114 ];
115
116
117
118
119 // Default quit message
120 conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
121
122
123 // If not empty, the client may only connect to this 1 IRC server
124 //conf.restrict_server = "irc.kiwiirc.com";
125 //conf.restrict_server_port = 6667;
126 //conf.restrict_server_ssl = false;
127 //conf.restrict_server_channel = "#kiwiirc";
128 //conf.restrict_server_password = "";
129 //conf.restrict_server_nick = "kiwi_";
130
131
132 /*
133 * Do not ammend the below lines unless you understand the changes!
134 */
135 module.exports.production = conf;