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
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
|
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
// See License.txt for license information.
import React from 'react';
import * as Utils from 'utils/utils.jsx';
import AdminSettings from './admin_settings.jsx';
import {elasticsearchTest, elasticsearchPurgeIndexes} from 'actions/admin_actions.jsx';
import BooleanSetting from './boolean_setting.jsx';
import {FormattedMessage} from 'react-intl';
import SettingsGroup from './settings_group.jsx';
import TextSetting from './text_setting.jsx';
import RequestButton from './request_button/request_button.jsx';
import ElasticsearchStatus from './elasticsearch_status';
export default class ElasticsearchSettings extends AdminSettings {
constructor(props) {
super(props);
this.getConfigFromState = this.getConfigFromState.bind(this);
this.doTestConfig = this.doTestConfig.bind(this);
this.handleChange = this.handleChange.bind(this);
this.handleSaved = this.handleSaved.bind(this);
this.renderSettings = this.renderSettings.bind(this);
}
getConfigFromState(config) {
config.ElasticsearchSettings.ConnectionUrl = this.state.connectionUrl;
config.ElasticsearchSettings.Username = this.state.username;
config.ElasticsearchSettings.Password = this.state.password;
config.ElasticsearchSettings.Sniff = this.state.sniff;
config.ElasticsearchSettings.EnableIndexing = this.state.enableIndexing;
config.ElasticsearchSettings.EnableSearching = this.state.enableSearching;
return config;
}
getStateFromConfig(config) {
return {
connectionUrl: config.ElasticsearchSettings.ConnectionUrl,
username: config.ElasticsearchSettings.Username,
password: config.ElasticsearchSettings.Password,
sniff: config.ElasticsearchSettings.Sniff,
enableIndexing: config.ElasticsearchSettings.EnableIndexing,
enableSearching: config.ElasticsearchSettings.EnableSearching,
configTested: true,
canSave: true,
canPurgeAndIndex: config.ElasticsearchSettings.EnableIndexing
};
}
handleChange(id, value) {
if (id === 'enableIndexing') {
if (value === false) {
this.setState({
enableSearching: false
});
} else {
this.setState({
canSave: false,
configTested: false
});
}
}
if (id === 'connectionUrl' || id === 'username' || id === 'password' || id === 'sniff') {
this.setState({
configTested: false,
canSave: false
});
}
if (id !== 'enableSearching') {
this.setState({
canPurgeAndIndex: false
});
}
super.handleChange(id, value);
}
handleSaved() {
this.setState({
canPurgeAndIndex: this.state.enableIndexing
});
}
canSave() {
return this.state.canSave;
}
doTestConfig(success, error) {
const config = JSON.parse(JSON.stringify(this.props.config));
this.getConfigFromState(config);
elasticsearchTest(
config,
() => {
this.setState({
configTested: true,
canSave: true
});
success();
this.doSubmit();
},
(err) => {
this.setState({
configTested: false,
canSave: false
});
error(err);
}
);
}
renderTitle() {
return (
<FormattedMessage
id='admin.elasticsearch.title'
defaultMessage='Elasticsearch (Beta)'
/>
);
}
renderSettings() {
return (
<SettingsGroup>
<div className='banner'>
<div className='banner__content'>
<FormattedMessage
id='admin.elasticsearch.noteDescription'
defaultMessage='Changing properties in this section will require a server restart before taking effect.'
/>
</div>
</div>
<BooleanSetting
id='enableIndexing'
label={
<FormattedMessage
id='admin.elasticsearch.enableIndexingTitle'
defaultMessage='Enable Elasticsearch Indexing:'
/>
}
helpText={
<FormattedMessage
id='admin.elasticsearch.enableIndexingDescription'
defaultMessage='When true, indexing of new posts occurs automatically. Search queries will use database search until "Enable Elasticsearch for search queries" is enabled. {documentationLink}'
values={{
documentationLink: (
<a
href='https://about.mattermost.com/default-elasticsearch-documentation/'
rel='noopener noreferrer'
target='_blank'
>
<FormattedMessage
id='admin.elasticsearch.enableIndexingDescription.documentationLinkText'
defaultMessage='Learn more about Elasticsearch in our documentation.'
/>
</a>
)
}}
/>
}
value={this.state.enableIndexing}
onChange={this.handleChange}
/>
<TextSetting
id='connectionUrl'
label={
<FormattedMessage
id='admin.elasticsearch.connectionUrlTitle'
defaultMessage='Server Connection Address:'
/>
}
placeholder={Utils.localizeMessage('admin.elasticsearch.connectionUrlExample', 'E.g.: "https://elasticsearch.example.org:9200"')}
helpText={
<FormattedMessage
id='admin.elasticsearch.connectionUrlDescription'
defaultMessage='The address of the Elasticsearch server. {documentationLink}'
values={{
documentationLink: (
<a
href='https://about.mattermost.com/default-elasticsearch-server-setup/'
rel='noopener noreferrer'
target='_blank'
>
<FormattedMessage
id='admin.elasticsearch.connectionUrlExample.documentationLinkText'
defaultMessage='Please see documentation with server setup instructions.'
/>
</a>
)
}}
/>
}
value={this.state.connectionUrl}
disabled={!this.state.enableIndexing}
onChange={this.handleChange}
/>
<TextSetting
id='username'
label={
<FormattedMessage
id='admin.elasticsearch.usernameTitle'
defaultMessage='Server Username:'
/>
}
placeholder={Utils.localizeMessage('admin.elasticsearch.usernameExample', 'E.g.: "elastic"')}
helpText={
<FormattedMessage
id='admin.elasticsearch.usernameDescription'
defaultMessage='(Optional) The username to authenticate to the Elasticsearch server.'
/>
}
value={this.state.username}
disabled={!this.state.enableIndexing}
onChange={this.handleChange}
/>
<TextSetting
id='password'
label={
<FormattedMessage
id='admin.elasticsearch.passwordTitle'
defaultMessage='Server Password:'
/>
}
placeholder={Utils.localizeMessage('admin.elasticsearch.password', 'E.g.: "yourpassword"')}
helpText={
<FormattedMessage
id='admin.elasticsearch.passwordDescription'
defaultMessage='(Optional) The password to authenticate to the Elasticsearch server.'
/>
}
value={this.state.password}
disabled={!this.state.enableIndexing}
onChange={this.handleChange}
/>
<BooleanSetting
id='sniff'
label={
<FormattedMessage
id='admin.elasticsearch.sniffTitle'
defaultMessage='Enable Cluster Sniffing:'
/>
}
helpText={
<FormattedMessage
id='admin.elasticsearch.sniffDescription'
defaultMessage='When true, sniffing finds and connects to all data nodes in your cluster automatically.'
/>
}
value={this.state.sniff}
disabled={!this.state.enableIndexing}
onChange={this.handleChange}
/>
<RequestButton
requestAction={this.doTestConfig}
helpText={
<FormattedMessage
id='admin.elasticsearch.testHelpText'
defaultMessage='Tests if the Mattermost server can connect to the Elasticsearch server specified. Testing the connection only saves the configuration if the test is successful. See log file for more detailed error messages.'
/>
}
buttonText={
<FormattedMessage
id='admin.elasticsearch.elasticsearch_test_button'
defaultMessage='Test Connection'
/>
}
successMessage={{
id: 'admin.elasticsearch.testConfigSuccess',
defaultMessage: 'Test successful. Configuration saved.'
}}
disabled={!this.state.enableIndexing}
/>
<ElasticsearchStatus
isConfigured={this.state.canPurgeAndIndex}
/>
<RequestButton
requestAction={elasticsearchPurgeIndexes}
helpText={
<FormattedMessage
id='admin.elasticsearch.purgeIndexesHelpText'
defaultMessage='Purging will entirely remove the index on the Elasticsearch server. Search results may be incomplete until a bulk index of the existing post database is rebuilt.'
/>
}
buttonText={
<FormattedMessage
id='admin.elasticsearch.purgeIndexesButton'
defaultMessage='Purge Index'
/>
}
successMessage={{
id: 'admin.elasticsearch.purgeIndexesButton.success',
defaultMessage: 'Indexes purged successfully.'
}}
errorMessage={{
id: 'admin.elasticsearch.purgeIndexesButton.error',
defaultMessage: 'Failed to purge indexes: {error}'
}}
disabled={!this.state.canPurgeAndIndex}
label={(
<FormattedMessage
id='admin.elasticsearch.purgeIndexesButton.label'
defaultMessage='Purge Indexes:'
/>
)}
/>
<BooleanSetting
id='enableSearching'
label={
<FormattedMessage
id='admin.elasticsearch.enableSearchingTitle'
defaultMessage='Enable Elasticsearch for search queries:'
/>
}
helpText={
<FormattedMessage
id='admin.elasticsearch.enableSearchingDescription'
defaultMessage='Requires a successful connection to the Elasticsearch server. When true, Elasticsearch will be used for all search queries using the latest index. Search results may be incomplete until a bulk index of the existing post database is finished. When false, database search is used.'
/>
}
value={this.state.enableSearching}
disabled={!this.state.enableIndexing || !this.state.configTested}
onChange={this.handleChange}
/>
</SettingsGroup>
);
}
}
|
