-
Notifications
You must be signed in to change notification settings - Fork 6
/
Copy pathreadme.txt
395 lines (301 loc) · 17.3 KB
/
readme.txt
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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
=== WordPress Sphinx Search Plugin ===
Contributors: Ivinco, Percona
Donate link: http://www.ivinco.com/
Tags: search, sphinx
Requires at least: 2.0.2
Tested up to: 4.8
Stable tag: 3.10.5
License: GPLv2
WordPress Sphinx Search Plugin allows to use Sphinx Search Server power to enable ultra-fast and feature-rich search on WordPress-based websites.
== Description ==
WordPress Sphinx Search Plugin allows to use Sphinx Search Server power to enable ultra-fast and feature-rich search on WordPress-based websites. It is especially useful if your WordPress site becomes very large.
Search results are more relevant and you can search in posts, pages and comments using flexible search syntax, quickly sort the results by freshness, relevance or in both modes. This plugin comes with sidebar widgets to display the most recent searches, top and related search terms.
This plugin replaces WordPress’s built-in search functionality.
Key Features
* Sort search results by Relevance, Freshness or in both modes
* Related searches widget is a great SEO tool for finding related search terms
* Top searches widget is another SEO tool which displays top search terms when no related search terms found
* Latest searches widget is a SEO tool which is used to display latest search terms of those people are doing right now
* Widget settings have plenty of options to control widget behavior and quality of widget content
* Search through posts, pages and comments content
* Search Management Tools is a set of tools for managing search terms
* Search Statistics Tool is an analytic tool which can help you analyze search trends of your blog
Support
This plugin is developed by [Ivinco](http://www.ivinco.com/ "Ivinco"). If you need commercial support, or if you’d like WordPress Sphinx Search Plugin
customized for your needs, we can help. Visit [plugin website](http://www.ivinco.com/software/wordpress-sphinx-search/ "plugin website") for the latest news.
See release notes, report bugs and feature wishes on Launchpad: https://bugs.launchpad.net/wp-sphinx-plugin
E-mail:
opensource@ivinco.com
Websites:
[WordPress Sphinx Search plugin website](http://www.ivinco.com/software/wordpress-sphinx-search/ "Ivinco WordPress Sphinx Search Home")
[WordPress Sphinx Search tutorial](http://www.ivinco.com/software/wordpress-sphinx-search-tutorial/ "Ivinco WordPress Sphinx Search Tutorial")
== Installation ==
= Requirements =
* WordPress 2.0.2 or higher
* Sphinx Search 2.1.9 or higher
* Writable WordPress upload directory for Sphinx configuration files, logs and indexes
= Installation guide =
[Online step-by-step installation guide](http://www.ivinco.com/software/wordpress-sphinx-search-tutorial/#installation "Step-by-step installation guide")
= Install the plugin =
1. Unpack the plugin archive to wp-content/plugins folder of your WordPress installation
2. Activate Sphinx Search plugin via WordPress Settings
3. Make sure WordPress upload directory is writable by web server (by default WordPress is configured to use wp-content/uploads)
4. Open Sphinx Search settings page and follow Wizard steps to setup Sphinx Search Server first time
= Setup scheduled jobs to re-index your website data periodically =
To setup periodical re-indexing, you should run Wizard to create special schedule files.
The default location of these files is: /path/to/wp-content/uploads/sphinx/cron/.
When wizard finishes, edit your Crontab file.
Use “crontab -e” command in Linux terminal and add the following lines to your crontab:
`
#WordPress Delta index update
#Following cron job update delta index every 5 minutes:
*/5 * * * * /usr/bin/php /path/to/wp-content/uploads/sphinx/cron/cron_reindex_delta.php
#WordPress Main index update
#Following cron job update main index daily (at 0 hours and 5 minutes):
5 0 * * * /usr/bin/php /path/to/wp-content/uploads/sphinx/cron/cron_reindex_main.php
#WordPress Stats index update
#Following cron job update stats index every 5 minutes
*/5 * * * * /usr/bin/php /path/to/wp-content/uploads/sphinx/cron/cron_reindex_stats.php
`
= Setup templates and widgets =
Extended search form on search results page
`<?php if (function_exists('ss_search_bar'))
echo ss_search_bar();/*put it in search page*/?>`
To find out if the current post is comment
`<?php if (function_exists('ss_isComment') )
if (ss_isComment()) echo 'It is comment'; else echo '';?>`
Extended search form at the sidebar
Use "Sphinx Search sidebar" widget or add it as template tag:
`<?php if (function_exists('ss_search_bar'))
echo ss_search_bar(true); /*put it in sidebar*/?>`
Related/Top searches at the sidebar
Use "Sphinx Related/Top Searches" widget or add it as template tag:
`<?php if (function_exists('ss_top_searches')) ss_top_searches(); ?>`
Top searches with pagination
Use "ss_top_searches_pager($max_per_page=10, $show_all=false)" template tag to enable pagination for top search terms:
`<?php if (function_exists('ss_top_searches_pager')) ss_top_searches_pager(); ?>`
Parameters:
* $max_per_page - limit how many search terms to display per page, by default 10
* $show_all - If set to True, then it will show all of the pages instead of a
short list of the pages near the current page. By default, the 'show_all' is set to false
Latest searches at the sidebar
Use "Sphinx Latest Searches" widget or add it as template tag:
`<?php if (function_exists('ss_latest_searches')) ss_latest_searches(); ?>`
= Upgrade the plugin =
1. Unpack the plugin archive to wp-content/plugins folder of your WordPress installation
== Frequently Asked Questions ==
Q: What is Sphinx Search Server?
A: Sphinx is a full-text search engine which provides fast and relevant full-text search functionality. Read more on Sphinx website http://sphinxsearch.com
Q: How to install Sphinx Search manually?
A: To manually install Sphinx use the official Sphinx Search documentation.
Q: How to update the search index?
A: The best option to update search index is to setup cron job task for it.
Also you may manually update search indexes through WordPress Sphinx Search administrative interface.
Q: I have just activated the plugin, however when I try to run the Plugin's Wizard it does not do anything. What is wrong?
A: This might be jQuery version collision. Our plugin uses jQuery v1.4 and supposed to work with WordPress up to 3.8 version
which uses jQuery v1.x (i.e. 1.10 for WP3.8). Check if your installation has custom plugin or WP is modified to use
jQuery v2.x. If so then it will impossible to use our plugin's Wizard.
Q: I have just installed and run the wizard, however I have the following error message. What to do?
Can not start searchd, try to start it manually.
A: If you use version 2.1 or higher you can see the exact command below message “Can not start searchd, try to start it manually.”
which you need to run manually through terminal on your server.
If you have ‘Permissions problem’ try to run the command as super user.
Q: How to run indexer manually
A: Open terminal and run following command: `/path/to/indexer -c /path/to/sphinx.conf --rotate --all`
Q: When I run searchd or indexer I got ERROR: invalid section type 'X-Powered-By' in ../sphinx.conf line 1 col 1.
A: You are using CGI version of php, by default it shows a http header like "X-Powered-By: PHP/4.3.6"
To prevent this, PHP needs to be invoked with the '-q' option for 'quiet'. Open sphinx.conf in editor and change first line to:
`#!/usr/bin/php -q`
Q: I got WARNING: index 'wp_main': preload: failed to open /path/to/indexes/wp_main.sph No such file or directory; NOT SERVING
A: That means you have no indexes to serve. You need to build them. You may do it via wp-admin or manually:
On wp-admin>Settings>Sphinx Search page click "Re-index WordPress index"
Or use run this command manually in terminal:
`/path/to/indexer -c /path/to/etc/sphinx.conf --all --rotate`
Q: Sphinx installs fine, but when I go to search for something on the blog I get no results.
A: Check Sphinx version, Sphinx version should be 0.9.9 or higher.
Q: How do I modify the plugin php script to specify the path where I have Sphinx installed?
A: Run Sphinx Configuration wizard from WP Admin panel.
There are two important steps:
1. Install or use existing Sphinx binaries
There you can specify the path to your own indexer and searchd
2. Setup path to Sphinx indexes
There you can specify where to store index files and sphinx.conf file. This path should be writeable by web server.
Q: Cannot activate plugin. If I try to activate the plugin I get the following PHP error:
Fatal error: Cannot redeclare class SphinxClient in /home/wordpress/wp-content/plugins/wordpress-sphinx-plugin/php/sphinxapi.php
A: Check that you haven't:
1. any other plugins which loaded Sphinx Search API library.
2. Sphinx Search PECL extension installed
Q: I’ve got an error “Indexer: configuration files not found.” on clicking “Run Indexing & Contunue” (“Sphinx data indexing” step of Wizard).
A: Check that the user which is running your web server (it's usually apache, www-data or smth like this)
can run indexer/searchd and can read/write into sphinx.conf. Then run Sphinx Configuration wizard from WP Admin panel again.
Q: How to set the maximum number of search results above 100.000?
A: 1)Go to Sphinx Search plugin directory and open rep/sphinx.conf in text editor.
2)Find max_matches parameter in searchd section at the bottom of the file
3)Set new value i.e. max_matches = 1000000
4)Open Sphinx Search control panel in WP Admin
5)Click on "Run Sphinx configuration Wizard" and skip all steps in the Wizard, it will rebuilds sphinx.conf file at the last step, click Finish.
6)Restart Sphinx Search (click on "Stop Sphinx daemon" and then "Start Sphinx daemon")
7)Open tab "Search settings" and set the same max_matches value in the field "Maximum number of search results".
== Screenshots ==
1. You can search by Relevance, Freshness or in both modes
2. Related searches widget is a great SEO tool for finding related search terms
3. Search Management Tools is a set of tools for managing search terms
4. Search Statistics Tool is an analytic tool which can help you analyze search trends of your blog
5. Widget settings have plenty of options to control widget behavior and quality of widget content
== Arbitrary section ==
= Semi live update - "main+delta" scheme =
To enable semi-live index updates also known as "main+delta" scheme,
the plugin will create the following table in your MySQL database:
`
# in MySQL
CREATE TABLE wp_sph_counter
(
counter_id INTEGER PRIMARY KEY NOT NULL,
max_doc_id INTEGER NOT NULL
);
`
If your WordPress installation's table prefix is not "wp_", substitute
the correct value.
= Top and last search terms =
In order to be able to store search statistics the plugin will run
the following SQL query during the activation process:
`
# in MySQL
CREATE TABLE wp_sph_stats (
id int(11) unsigned NOT NULL auto_increment,
keywords varchar(255) NOT NULL default '',
date_added datetime NOT NULL default '0000-00-00 00:00:00',
keywords_full varchar(255) NOT NULL default '',
status tinyint(1) NOT NULL DEFAULT '0',
PRIMARY KEY (id),
KEY keywords (keywords)
);
`
If your WordPress installation's table prefix is not "wp_", substitute it with
the correct value.
= Start Sphinx Search at boot =
#How to automatically start Sphinx Search daemon at boot:
* In Debian based systems i.e. Ubuntu:
`% update-rc.d "/path/to/bin/searchd --config /path/to/etc/sphinx.conf" defaults`
* In Redhat based systems i.e. Fedora:
`% chkconfig --add "/path/to/bin/searchd --config /path/to/etc/sphinx.conf"`
== Upgrade Notice ==
= 3.0 =
This release comes with big improvements in performance of Top/Related and Latest widgets.
We replaced MySQL FullText engine with Sphinx Search engine in all components.
We added new search mode "Freshness & Relevance" which works perfect for blogs and news sites.
== Changelog ==
= 3.10.4 =
* Properly handle DB_HOST when it contains a non-default unix socket
= 3.10.1 =
* Changed plugin release version for WordPress 4.7.1, CSS fix
= 3.9.8 =
* Changed plugin release version for WordPress 4.2
= 3.9.7 =
* Plugin release for WordPress 4.2
= 3.9.6 =
* Plugin code was revised, fixed and tested to use with WordPress 4.2
= 3.9.5 =
* Plugin code was revised and tested with WordPress 4.1
= 3.9.4 =
* Plugin code was revised and tested with WordPress 4.0 Benny.
= 3.9.1 =
* Updated Sphinx Search engine binaries to version 2.1.9.
= 3.9 =
* Checked compatibility with WP v 3.9. Updated common styles.
= 3.8.3 =
* FAQ page is updated. Added description of the problem with Plugin's Wizard.
= 3.8.2 =
* Plugin will use static SSE configuration file now instead of dynamic one.
= 3.8.1 =
* Updated installer's auto-detection mechanism which will allow user admin to choose pre-installed Sphinx binaries even on Windows platform.
= 3.8 =
* Updated styles to fit new default theme
= 3.7 =
* Added support of WP version up to 3.7.1
* New feature: Tags search. added missed files.
* New feature: Added an opportunity to search within post tags.
* Fixed duplicates of statistics when seo URLs are used.
* Fixed bug with single quote character.
* Updates to layout of sphinx installation wizard.
* Small fixes to verification logic of sphinx dirs security.
* There is a warning of insecure files has been added to plugin configuration section
* Fixed bug with unescaped html in snippets
= 3.3.4 =
* fix of the bug related with searching for words that are not in the index
= 3.3.3 =
* few miscellaneous fixes in the plugin admin zone
* insert into sph_stat table improvement
= 3.3.2 =
* Unhooked unnecessary filters
* Added checking Sphinx connection on remote or local server to determine is Sphinx running
= 3.3.1 =
* Fixed bug in search term escaping
* Fixed bug in redirect for friendly URLs
= 3.3.0 =
* Added friendly URLs support
* Added ability to enable/disable friendly urls in Top/Related and Latest search terms widgets
* Added ability to set maximum number of search results
* Added tag for listing top search terms on a page
* Fixed several bugs
= 3.0.2 =
* Added new template tag: top search terms with pagination
= 3.0.1 =
* Fixed bug in ss_isComment tag
* Fixed search term highlighting bug
= 3.0 =
* Added search management tool
* Added search statistics/analytic report
* Added new search mode "Freshness & Relevance"
* Reworked Admin user interface, made it more simple and clear.
* Added ability to add custom search terms to the top of the Top/Related widget
* New option "Show only approved search terms" in Top/Related and Latest widgets
* New option "Show top Searches for last: day, week, months..." in Top/Related widget
* Added option to run php in quiet mode in sphinx.conf to prevent displaying HTTP headers
* Replaced MySQL FullText engine with Sphinx Search in Top/Related and Latest widgets
* Built search management tool and statistics tool over Sphinx Search
* Added custom css styles file (templates/style.css) for search forms
* Ivinco icon looking more smoothly with transparent background
= 2.1 =
* Added more settings to Top/Related widget.
* A few bug fixes and minor improvements
= 2.0 =
* Added configuration wizard: you can automatically install or reinstall Sphinx via WordPress wp-admin panel
* Changed default Sphinx installation directory: now Sphinx is installed to WordPress upload directory
* Using shebang syntax for Sphinx configuration file - it allows to hide the connection parameters from the public access
* UI fixes for WordPress wp-admin panel
* Improved error handling: system output is now hidden and human readable error messages were added
* Added a new sidebar widgets for displaying top/related and latest search terms and a widget for the extended search form
* Added search term highlighting for search results (in WordPress' the_excerpt tag)
* Added automatic generation of cron files
= 1.0 =
* Added Search powered by Sphinx Search engine
* Added sort search resutls by Relevance or Freshness
* Added search by posts, by comments and by pages.
* Added exclude posts, comments or pages from search results.
* Added display comments at search results page.
* Added search non-password protected pages only
* Added search only approved comments
* Added "Match Any" search ability - if no one results was found, then it try to search in "Match Any" mode.
* Added support for tag title of web page - it changed due to entered search keywords
* Added log of all search results, except empty results
* Added tag to display Top-n search keywords
* Added tag to display Latest-n search keywords
* Added relevant keywords support to the Top-n search keywords bar.
* Added support to Disable/Enable search by: comments, posts, pages
* Added support of keywords wrapper settings:
* Add tag Before and After search keyword in body/title
* Separator of result snippets
* Snippet max length
* Maximum number of words around keyword in snippet
* Prefix before Posts, Comments and Pages title
* List of phrases to cut from search results
* Added configuration for Sphinx index prefix
* Added configuration for Host
* Added configuration for Port
* Added configuration for Configuration file
* Added configuration for Searchd file
* Added configuration for Indexer file
* Added support to reindex all content manually
* Added support to stop/start search daemon
* Added support to install Sphinx Search through web interface