Merge branch 'development'
[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 // 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
57 /*
58 * Client side plugins
59 * Array of URLs that will be loaded into the browser when the client first loads up
60 * See http://github.com/prawnsalad/KiwiIRC/wiki/Client-plugins
61 */
62 conf.client_plugins = [
63 // "http://server.com/kiwi/plugins/myplugin.html"
64 ];
65
66
67
68 // Enabled CAP extensions (See ENTER URL TO CAP INFO HERE PLS)
69 conf.cap_options = [];
70
71
72
73
74 // Directory to find the server modules
75 conf.module_dir = "../server_modules/";
76
77 // Which modules to load
78 conf.modules = [];
79
80
81
82
83 // WebIRC passwords enabled for this server
84 conf.webirc_pass = {
85 //"irc.network.com": "configured_webirc_password",
86 //"127.0.0.1": "foobar"
87 };
88
89 // Some IRCDs require the clients IP via the username/ident
90 conf.ip_as_username = [
91 "irc.network.com",
92 "127.0.0.1"
93 ];
94
95 // Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
96 conf.reject_unauthorised_certificates = false;
97
98
99
100 /*
101 * Reverse proxy settings
102 * Reverse proxies that have been reported to work can be found at:
103 * http://github.com/prawnsalad/KiwiIRC/wiki/Running-behind-a-proxy
104 */
105
106 // Whitelisted HTTP proxies in CIDR format
107 conf.http_proxies = ["127.0.0.1/32"];
108
109 // Header that contains the real-ip from the HTTP proxy
110 conf.http_proxy_ip_header = "x-forwarded-for";
111
112 // Base HTTP path to the KIWI IRC client (eg. /kiwi)
113 conf.http_base_path = "/kiwi";
114
115
116
117 // Enabled transports for the browser to use
118 conf.transports = [
119 "websocket",
120 "flashsocket",
121 "htmlfile",
122 "xhr-polling",
123 "jsonp-polling"
124 ];
125
126
127
128
129 // Default quit message
130 conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
131
132
133 // Default settings for the client. These may be changed in the browser
134 conf.client = {
135 server: 'irc.kiwiirc.com',
136 port: 6697,
137 ssl: true,
138 channel: '#kiwiirc',
139 nick: 'kiwi_?'
140 };
141
142
143 // If set, the client may only connect to this 1 IRC server
144 //conf.restrict_server = "irc.kiwiirc.com";
145 //conf.restrict_server_port = 6667;
146 //conf.restrict_server_ssl = false;
147 //conf.restrict_server_channel = "#kiwiirc";
148 //conf.restrict_server_password = "";
149 //conf.restrict_server_nick = "kiwi_";
150
151
152
153
154 /*
155 * Do not ammend the below lines unless you understand the changes!
156 */
157 module.exports.production = conf;