-
Notifications
You must be signed in to change notification settings - Fork 1
/
config.js
157 lines (131 loc) · 4.76 KB
/
config.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
exports.config = {
"mongo": "mongodb://127.0.0.1:27017/ircanywhere",
/* -- required
* -- string
* -- usage: The mongodb database url */
"oplog": "mongodb://127.0.0.1:27017/local",
/* -- required
* -- string
* -- usage: The mongodb oplog url - Note you may not have this available on shared mongohq and similar hosts */
"url": "http://localhost:3000/",
/* -- required
* -- string
* -- usage: The http url of the web server you're running behind */
"port": 3000,
/* -- required
* -- number
* -- usage: The port to listen on */
"secure": false,
/* -- required
* -- boolean
* -- usage: Whether to setup the http server with SSL or not. Certificates will be required in
private/certs/key.pem and private/certs/cert.pem */
"enableRegistrations": true,
/* -- required
* -- boolean
* -- usage: Whether to enable registrations or not */
"forkProcess": true,
/* -- required
* -- boolean
* -- usage: Whether to fork a seperate process for irc connections, this will allow connections to stay
online when the main application closes. It'll also probably speed things up. It's recommended
to only ever set this to false when developing */
"retryWait": 10,
/* -- number
* -- usage: How many seconds to wait between reconnect attemps, default is 10 */
"retryCount": 10,
/* -- number
* -- usage: How many times to retry connecting if disconnected, default is 10. Set to negative to
keep retrying and 0 to disable */
"ircServer": {
"enable": true,
/* -- required
* -- boolean
* -- usage: Whether to enable the IRC server or not. The IRC server allows you to connect from other
clients to ircanywhere. */
"port": 6667
/* -- number
* -- usage: The port to run the IRC server on, 6667 is the default IRC service port. */
/* TODO: SSL */
},
"identd": {
"enable": true,
/* -- required
* -- boolean
* -- usage: Whether to enable the integrated identd server or not. This is recommended to ensure that
server owners can validate your users, and often it increases i:line limits on some networks */
"port": 113
/* -- number
* -- usage: The port to run the identd server on, 113 is the ident service port, however you can run it on
any port you wish, you would need to forward 113 to this port. If you omit it or leave it as 113
IRCAnywhere will need elevated permissions to bind */
},
"email": {
"siteName": "IRCAnywhere",
/* -- string
* -- usage: The title to use in validation/forgot password emails
defaults to "IRCAnywhere" */
"from": "IRCAnywhere <[email protected]>",
/* -- required
* -- string
* -- usage: The email address to send emails from, can be either [email protected]
or Name <[email protected]> */
"smtp": "smtps://username:[email protected]"
/* -- required
* -- string
* -- usage: The smtp server to connect to, it's advised you set this up properly, you can run
a local server and pass in a local url, or get free accounts from places like Mailgun.
Note the prefix smtps:// enables SSL, whereas smtp:// is unsecure. */
},
"clientSettings": {
"activityTimeout": 0,
/* -- number
* -- usage: The amount of hours to timeout irc clients after inactivity, not required
and can be set to 0 or below to deactivate timeouts */
"networkLimit": 10,
/* -- required
* -- number
* -- usage: Network limit for users, minimum is 0, maximum is 10, at the moment */
"networkRestriction": [
],
/* -- array
* -- usage: Whether to restrict clients to connecting to specific hostmasks, can be
disabled by omitting completely, or setting to ["*"] */
"userNamePrefix": "ia"
/* -- required
* -- string
* -- usage: The username prefix for users, each registered user has it's own ident
based on this prefix + a sequential number */
},
"defaultNetwork": {
"server": "irc.freenode.org",
/* -- required
* -- string
* -- usage: Hostname of the default network to connect new users to */
"port": 6667,
/* -- required
* -- number
* -- usage: Port to connect the default client to, min 1, max 65535 */
"realname": "IRC Client",
/* -- required
* -- string
* -- usage: The gecos for default irc clients */
"secure": false,
/* -- boolean
* -- usage: Whether to use ssl for the default irc client, can be omitted
defaults to false if so */
"password": "",
/* -- string
* -- usage: If the server requires a password, enter it here. Set to null to emit it
or remove it completely */
"channels": [
{
"channel": "#ircanywhere-test",
"password": "channel-password"
}
]
/* -- array > object
* -- usage: An array of channels to connect to on startup, the channel must be the
same as the above object, password is optional, channel is not. */
}
};