Translations update
[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
9af18c41
D
58// Transports available to the client.
59// Behind an Apache reverse proxy? Uncomment the below - Apache does not support websockets!
60//conf.client_transports = ['polling'];
61
13d7faa3 62// Max connections per connection. 0 to disable
ab15f618
D
63conf.max_client_conns = 5;
64
8838bdd6 65// Max connections per server. 0 to disable.
8ae445ce
JA
66// Setting is ignored if:
67// - There is a WEBIRC password configured for the server,
68// - Kiwi is configured to send the client's ip as a username for the server, or
69// - Kiwi is running in restricted server mode.
8838bdd6
JA
70conf.max_server_conns = 0;
71
d1b3e8b3 72/*
3efb4f33 73* Default encoding to be used by the server
d1b3e8b3 74* As specified and limited to iconv-lite library support.
d1b3e8b3 75*/
396ea0d9 76conf.default_encoding = 'utf8';
2eec3842 77
c14b67ae
D
78
79/*
80* Default GECOS (real name) for IRC connections
cb234b7e 81* %n will be replaced with the users nick
7318cbc6 82* %h will be replaced with the users hostname
c14b67ae
D
83*/
84//conf.default_gecos = 'Web IRC Client';
85
d26a40c6 86
3ebce675
D
87/*
88* Auto reconnect if the IRC server disconnects a kiwi user
89* Hundreds of connected users getting disconnected then reconnecting at once may see
90* high CPU usage causing further dropouts. Set to false if under high usage.
91*/
92conf.ircd_reconnect = true;
93
c14b67ae 94
2eec3842
D
95/*
96 * Client side plugins
97 * Array of URLs that will be loaded into the browser when the client first loads up
98 * See http://github.com/prawnsalad/KiwiIRC/wiki/Client-plugins
99 */
100conf.client_plugins = [
101 // "http://server.com/kiwi/plugins/myplugin.html"
102];
103
104
105
ab15f618
D
106
107// Directory to find the server modules
d8002ae0 108conf.module_dir = "../server_modules/";
ab15f618
D
109
110// Which modules to load
991091b7 111conf.modules = [];
ab15f618
D
112
113
114
115
79e4d009
D
116// WebIRC password enabled for this server
117//conf.webirc_pass = "foobar";
118
119// Multiple WebIRC passwords may be used for multiple servers
120//conf.webirc_pass = {
121// "irc.network.com": "configured_webirc_password",
122// "127.0.0.1": "foobar"
123//};
ab15f618
D
124
125// Some IRCDs require the clients IP via the username/ident
126conf.ip_as_username = [
86d127f9
PV
127 //"irc.network.com",
128 //"127.0.0.1"
ab15f618
D
129];
130
831b41b0
JA
131// Whether to verify IRC servers' SSL certificates against built-in well-known certificate authorities
132conf.reject_unauthorised_certificates = false;
ab15f618
D
133
134
d99877b8
D
135
136/*
137 * Reverse proxy settings
138 * Reverse proxies that have been reported to work can be found at:
b54438a9 139 * https://kiwiirc.com/docs/installing/proxies
d99877b8 140 */
76391784 141
d99877b8
D
142// Whitelisted HTTP proxies in CIDR format
143conf.http_proxies = ["127.0.0.1/32"];
c6e3ed44 144
31a18fa4
D
145// Header that contains the real-ip from the HTTP proxy
146conf.http_proxy_ip_header = "x-forwarded-for";
147
d99877b8
D
148// Base HTTP path to the KIWI IRC client (eg. /kiwi)
149conf.http_base_path = "/kiwi";
150
151
ac0b278c 152/*
57c22370 153 * SOCKS (version 5) proxy settings
1515556c
JA
154 * This feature is only available on node 0.10.0 and above.
155 * Do not enable it if you're running 0.8 or below or Bad Things will happen.
ac0b278c
JA
156 */
157conf.socks_proxy = {};
158
159// Enable proxying outbound connections through a SOCKS proxy
160conf.socks_proxy.enabled = false;
161
162// Proxy *all* outbound connections through a SOCKS proxy
163conf.socks_proxy.all = false;
164
165// Use SOCKS proxy for these hosts only (if conf.sock_proxy.all === false)
166conf.socks_proxy.proxy_hosts = [
167 "irc.example.com"
168];
169
170// Host and port for the SOCKS proxy
171conf.socks_proxy.address = '127.0.0.1';
172conf.socks_proxy.port = 1080;
173
174// Username and password for the SOCKS proxy
175// Set user to null to disable password authentication
176conf.socks_proxy.user = null;
177conf.socks_proxy.pass = null;
178
d99877b8 179
ab15f618
D
180
181// Default quit message
1360a454 182conf.quit_message = "http://www.kiwiirc.com/ - A hand-crafted IRC client";
ab15f618
D
183
184
76391784
D
185// Default settings for the client. These may be changed in the browser
186conf.client = {
187 server: 'irc.kiwiirc.com',
188 port: 6697,
189 ssl: true,
190 channel: '#kiwiirc',
6d86afeb 191 channel_key: '',
1cfc4800
JA
192 nick: 'kiwi_?',
193 settings: {
194 theme: 'relaxed',
b62f086f 195 text_theme: 'default',
1cfc4800
JA
196 channel_list_style: 'tabs',
197 scrollback: 250,
198 show_joins_parts: true,
199 show_timestamps: false,
62d1e896 200 use_24_hour_timestamps: true,
2eacc942 201 mute_sounds: false,
223d53e5 202 show_emoticons: true,
141a00e7 203 count_all_activity: false
2df39a5c
JA
204 },
205 window_title: 'Kiwi IRC'
76391784
D
206};
207
15dc5f90
JA
208// List of themes available for the user to choose from
209conf.client_themes = [
210 'relaxed',
211 'mini',
212 'cli',
213 'basic'
214];
215
76391784 216
46f41dfb 217// If set, the client may only connect to this 1 IRC server
93e84f75
D
218//conf.restrict_server = "irc.kiwiirc.com";
219//conf.restrict_server_port = 6667;
220//conf.restrict_server_ssl = false;
221//conf.restrict_server_channel = "#kiwiirc";
6d86afeb 222//conf.restrict_server_channel_key = "";
93e84f75
D
223//conf.restrict_server_password = "";
224//conf.restrict_server_nick = "kiwi_";
ab15f618
D
225
226
76391784
D
227
228
ab15f618 229/*
aefdbb09 230 * Do not amend the below lines unless you understand the changes!
ab15f618 231 */
813ae69a 232module.exports.production = conf;