New IRC connection - don't send redundant con_num to client on connection error
[KiwiIRC.git] / config.example.js
CommitLineData
ab15f618
D
1var conf = {};
2
3// Run the Kiwi server under a different user/group
4conf.user = "";
5conf.group = "";
6
7
11dbb00f
D
8// Log file location
9conf.log = "kiwi.log";
10
11
8baf9099
D
12
13/*
14 * Server listen blocks
15 */
16
17// Do not edit this line!
ab15f618
D
18conf.servers = [];
19
8baf9099 20// Example server block
3be87cdd
D
21conf.servers.push({
22 port: 7778,
23 address: "0.0.0.0"
24});
25
ab15f618 26// Example SSL server block
38da7139
D
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//});
ab15f618 35
7496de01 36// Network interface for outgoing connections
e412195d
D
37conf.outgoing_address = {
38 IPv4: '0.0.0.0'
39 //IPv6: '::'
b156e01a 40};
ab15f618 41
8baf9099 42
adefb6bd
D
43// Do we want to enable the built in Identd server?
44conf.identd = {
45 enabled: false,
46 port: 113,
47 address: "0.0.0.0"
48};
49
50
51
8baf9099
D
52
53
54
ab15f618
D
55// Where the client files are
56conf.public_http = "client/";
57
13d7faa3 58// Max connections per connection. 0 to disable
ab15f618
D
59conf.max_client_conns = 5;
60
8838bdd6 61// Max connections per server. 0 to disable.
8ae445ce
JA
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.
8838bdd6
JA
66conf.max_server_conns = 0;
67
d1b3e8b3 68/*
3efb4f33 69* Default encoding to be used by the server
d1b3e8b3 70* As specified and limited to iconv-lite library support.
d1b3e8b3 71*/
396ea0d9 72conf.default_encoding = 'utf8';
2eec3842 73
c14b67ae
D
74
75/*
76* Default GECOS (real name) for IRC connections
77*/
78//conf.default_gecos = 'Web IRC Client';
79
80
2eec3842
D
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 */
86conf.client_plugins = [
87 // "http://server.com/kiwi/plugins/myplugin.html"
88];
89
90
91
ab15f618
D
92
93// Directory to find the server modules
d8002ae0 94conf.module_dir = "../server_modules/";
ab15f618
D
95
96// Which modules to load
991091b7 97conf.modules = [];
ab15f618
D
98
99
100
101
102// WebIRC passwords enabled for this server
103conf.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
109conf.ip_as_username = [
86d127f9
PV
110 //"irc.network.com",
111 //"127.0.0.1"
ab15f618
D
112];
113
831b41b0
JA
114// Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
115conf.reject_unauthorised_certificates = false;
ab15f618
D
116
117
d99877b8
D
118
119/*
120 * Reverse proxy settings
121 * Reverse proxies that have been reported to work can be found at:
b54438a9 122 * https://kiwiirc.com/docs/installing/proxies
d99877b8 123 */
76391784 124
d99877b8
D
125// Whitelisted HTTP proxies in CIDR format
126conf.http_proxies = ["127.0.0.1/32"];
c6e3ed44 127
31a18fa4
D
128// Header that contains the real-ip from the HTTP proxy
129conf.http_proxy_ip_header = "x-forwarded-for";
130
d99877b8
D
131// Base HTTP path to the KIWI IRC client (eg. /kiwi)
132conf.http_base_path = "/kiwi";
133
134
ac0b278c 135/*
57c22370 136 * SOCKS (version 5) proxy settings
1515556c
JA
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.
ac0b278c
JA
139 */
140conf.socks_proxy = {};
141
142// Enable proxying outbound connections through a SOCKS proxy
143conf.socks_proxy.enabled = false;
144
145// Proxy *all* outbound connections through a SOCKS proxy
146conf.socks_proxy.all = false;
147
148// Use SOCKS proxy for these hosts only (if conf.sock_proxy.all === false)
149conf.socks_proxy.proxy_hosts = [
150 "irc.example.com"
151];
152
153// Host and port for the SOCKS proxy
154conf.socks_proxy.address = '127.0.0.1';
155conf.socks_proxy.port = 1080;
156
157// Username and password for the SOCKS proxy
158// Set user to null to disable password authentication
159conf.socks_proxy.user = null;
160conf.socks_proxy.pass = null;
161
d99877b8 162
ab15f618
D
163
164// Default quit message
1360a454 165conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
ab15f618
D
166
167
76391784
D
168// Default settings for the client. These may be changed in the browser
169conf.client = {
170 server: 'irc.kiwiirc.com',
171 port: 6697,
172 ssl: true,
173 channel: '#kiwiirc',
6d86afeb 174 channel_key: '',
1cfc4800
JA
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,
2eacc942
JA
182 mute_sounds: false,
183 show_emoticons: true
1cfc4800 184 }
76391784
D
185};
186
187
46f41dfb 188// If set, the client may only connect to this 1 IRC server
93e84f75
D
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";
6d86afeb 193//conf.restrict_server_channel_key = "";
93e84f75
D
194//conf.restrict_server_password = "";
195//conf.restrict_server_nick = "kiwi_";
ab15f618
D
196
197
76391784
D
198
199
ab15f618
D
200/*
201 * Do not ammend the below lines unless you understand the changes!
202 */
813ae69a 203module.exports.production = conf;