forked from 10up/ElasticPress
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathreadme.txt
More file actions
266 lines (133 loc) · 6.29 KB
/
readme.txt
File metadata and controls
266 lines (133 loc) · 6.29 KB
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
=== ElasticProbe ===
Contributors: bushwackstudio, nshayanfar
Tags: performance, search, elasticsearch, fuzzy, related posts
Tested up to: 6.8
Stable tag: 1.5.0
License: GPLv2 or later
License URI: https://www.gnu.org/licenses/gpl-2.0.html
A lightning fast and flexible search and query engine for WordPress.
== Description ==
ElasticProbe, a fast and flexible search and query engine for WordPress, enables WordPress to find or “query” relevant content extremely fast through a variety of highly customizable features. WordPress out-of-the-box struggles to analyze content relevancy and can be very slow. ElasticProbe supercharges your WordPress website making for more sales, happier users and administrators. The plugin even contains many features.
Here is a list of the amazing ElasticProbe features included in the plugin:
__Search__: Instantly find the content you’re looking for. Even when you misspell.
__Instant Results__: A built for WordPress search experience that bypasses WordPress for optimal performance. Instant Results routes search queries through a dedicated API, separate from WordPress which results in lightning fast search experience.
__WooCommerce__: With ElasticProbe, filtering WooCommerce product results is fast and easy. Your customers can find and buy exactly what they're looking for, even if you have a large or complex product catalog.
__Related Posts__: ElasticProbe understands data in real time, so it can instantly deliver engaging and precise related content with no impact on site performance.
__Protected Content__: Optionally index all of your content, including private and unpublished content, to speed up searches and queries in places like the administrative dashboard.
__Documents__: Indexes text inside of popular file types, and adds those files types to search results.
__Autosuggest__: Make (post, page or custom type) suggestion while user is typing in the search input.
__Autocomplete__: Complete the search query term while the user is typing.
__Filters__: Add controls to your website to filter content by one or more taxonomies.
__Comments__: Indexes your comments and provides a widget with type-ahead search functionality. It works with WooCommerce product reviews out-of-the-box.
== Frequently Asked Questions ==
= How does ElasticProbe work? =
The ElasticProbe plugin enables you to connect your WordPress site to the ElasticProbe.com service, a SaaS solution that provides an enhanced search experience while reducing load on your WordPress site. Check out our [privacy policy](https://elasticprobe.com/privacy-policy/) and [terms of use](https://elasticprobe.com/terms-and-conditions/) for the hosted ElasticProbe.com.
= Where can I find ElasticProbe documentation and user guides? =
Please refer to [GitHub](https://github.com/BushwackStudio/ElasticProbe) for detailed usage instructions and documentation. FAQs and tutorials can be also found on our [support site](https://elasticprobe.com/resources/).
= I have a problem with the plugin. Where can I get help? =
If you have identified a bug or would like to suggest an enhancement, please refer to our [GitHub repo](https://github.com/BushwackStudio/ElasticProbe). We do not provide support here at WordPress.org forums.
= Is ElasticProbe compatible with Elasticsearch X.Y? =
ElasticProbe requirements can be found in the [Requirements section](https://github.com/BushwackStudio/ElasticProbe#requirements) of our GitHub repository.
= I really like ElasticProbe! Can I contribute? =
For sure! Feel free to submit ideas or feedback in general to our [GitHub repo](https://github.com/BushwackStudio/ElasticProbe).
= How can I report security bugs? =
You can report security bugs through the Patchstack Vulnerability Disclosure Program. The Patchstack team help validate, triage and handle any security vulnerabilities. [Report a security vulnerability.]( https://patchstack.com/database/vdp/e2c7eaef-a0f5-4aed-861e-fbfc826bb10c )
== Installation ==
1. First, you will need to properly [install and configure](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html) Elasticsearch.
2. Activate the plugin in WordPress.
3. In the ElasticProbe settings page, input your Elasticsearch host.
4. Sync your content by clicking the sync icon.
5. Enjoy!
== Screenshots ==
1. Features Page
2. Search Fields & Weighting Dashboard
3. Sync Page
4. Synonyms Dashboard
== Changelog ==
= 1.5.0 - 2024-x-x =
__Changed:__
* Updated the upstream
__Added:__
* Support for WordPress 9.3
= 1.4.0 - 2024-10-19 =
__Added:__
* Documents feature
= 1.3.0 - 2024-08-30 =
__Added:__
* Autocomplete feature
= 1.2.0 - 2024-08-17 =
__Added:__
* Autosuggestion feature
= 1.1.0 - 2024-07-08 =
__Added:__
* Instant result feature
* ElasticProbe is now a member of Patchstack vulnerability disclosure program.
__Developer:__
* Renamed some HTTP headers
= 1.0.0 - 2024-05-24 =
__Added:__
__Changed:__
* Domain name to elasticprobe.com
__Fixed:__
__Security:__
__Developer:__
= 0.3.2 - 2024-05-21 =
__Added:__
__Changed:__
__Fixed:__
* Some input sanitization
* i18n strings
__Security:__
__Developer:__
= 0.3.1 - 2024-05-19 =
__Added:__
__Changed:__
* Plugin logo in admin page
* Changed admin panel icon
__Fixed:__
* An input sanitization issue
__Security:__
__Developer:__
= 0.3.0 - 2024-05-18 =
__Added:__
__Changed:__
* Filter and option prefixes to "eprobe"
* API endpoint path prefix to "elasticprobe"
* Contributer accounts in readme.txt
__Fixed:__
* Some missing translation domains
* Some missing sanitizations
__Security:__
__Developer:__
= 0.2.1 - 2024-05-12 =
__Added:__
__Changed:__
* Wordpress screenshots
__Fixed:__
* Some hosted PHP tests
__Security:__
__Developer:__
= 0.2.0 - 2024-05-10 =
__Added:__
* Cloned tests of ES for the hosted service
__Changed:__
* Plugin name
__Fixed:__
* Some tests which failed when running against the hosted service
__Security:__
__Developer:__
= 0.1.1 - 2024-04-26 =
__Added:__
__Changed:__
* Bumped the tested wordpress version and plugin version
__Fixed:__
__Security:__
__Developer:__
= 0.1.0 - 2024-04-23 =
__Added:__
__Changed:__
* Changed the code to reflect the new architecture.
__Fixed:__
__Security:__
__Developer:__
[View historical changelog details here](https://github.com/BushwackStudio/ElasticProbe/blob/dev/CHANGELOG.md).