Media Wiki CirrusSearch: Difference between revisions
| (6 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
=Internal= | =Internal= | ||
* [[ | * [[Media_Wiki_Operations#CirrusSearch|Media Wiki Operations]] | ||
* [[Elasticsearch]] | * [[Elasticsearch]] | ||
=Installation= | =Installation= | ||
Install | Install Elasticsearch first. Use the latest version of the recommended major version. At the time of the writing, CirrusSearch for MediaWiki 1.35 recommended Elasticsearch 6.5.4, and 6.8.20 worked fine. Elasticsearch 7.x did not. | ||
{{Internal|Elasticsearch#Installation|Elasticsearch Installation}} | |||
Install Elastica extension: {{Internal|MediaWiki Elastica Extension#Installation|Elastica Extension Installation}} | Install Elastica extension: {{Internal|MediaWiki Elastica Extension#Installation|Elastica Extension Installation}} | ||
| Line 35: | Line 38: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
If SELinux is enabled, make sure it is configured to allow the httpd user to connect to elasticsearch, otherwise the setup will fail. See [[#SELinux_Setup|SELinux Setup]] below. | |||
==SELinux Setup== | ==SELinux Setup== | ||
If [[SELinux_Operations#How_to_Find_Out_Whether_SELinux_is_Enabled|SELinux is enabled]] on the host, the httpd process may not be able to invoke into the elasticsearch server, with the following symptoms: | If [[SELinux_Operations#How_to_Find_Out_Whether_SELinux_is_Enabled|SELinux is enabled]] on the host, the httpd process may not be able to invoke into the elasticsearch server, with the following symptoms: | ||
| Line 85: | Line 89: | ||
$wgDebugLogGroups['CirrusSearch'] = "/tmp/cirrus-errors.log"; | $wgDebugLogGroups['CirrusSearch'] = "/tmp/cirrus-errors.log"; | ||
</syntaxhighlight> | </syntaxhighlight> | ||
<font color=darkgray>Did not work</font> | |||
Add the following query parameters to dump: <code>&cirrusDumpQuery=true</code>, <code>&cirrusDumpResult=true</code>. | |||
Latest revision as of 19:08, 29 December 2023
External
- https://www.mediawiki.org/wiki/Extension:CirrusSearch
- https://www.mediawiki.org/wiki/Help:CirrusSearch
Internal
Installation
Install Elasticsearch first. Use the latest version of the recommended major version. At the time of the writing, CirrusSearch for MediaWiki 1.35 recommended Elasticsearch 6.5.4, and 6.8.20 worked fine. Elasticsearch 7.x did not.
Install Elastica extension:
Download the correct CirrusSearch version from https://www.mediawiki.org/wiki/Special:ExtensionDistributor/CirrusSearch
Unzip it in the extensions directory:
tar -xzf CirrusSearch-REL1_35-95b958b.tar.gz -C /var/www/mediawiki-x.y.z/extensions
Add the following statement to LocalSettings.php:
wfLoadExtension( 'CirrusSearch' );
Smoke test: go to Special:Version and verify that the extension is successfully installed.
Follow the installation instructions delivered with /var/www/mediawiki-1.35.0/extensions/CirrusSearch/README.
wfLoadExtension( 'Elastica' );
wfLoadExtension( 'CirrusSearch' );
$wgDisableSearchUpdate = true;
If SELinux is enabled, make sure it is configured to allow the httpd user to connect to elasticsearch, otherwise the setup will fail. See SELinux Setup below.
SELinux Setup
If SELinux is enabled on the host, the httpd process may not be able to invoke into the elasticsearch server, with the following symptoms:
[CirrusSearch] Search backend error during near_match search for 'test' after 5: unknown: Couldn't connect to host, Elasticsearch down?
/var/log/audit/audit.log will contain something similar to:
type=AVC msg=audit(1637546254.160:75): avc: denied { name_connect } for pid=1216 comm="httpd" dest=9200 scontext=system_u:system_r:httpd_t:s0 tcontext=system_u:object_r:wap_wsp_port_t:s0 tclass=tcp_socket permissive=0
Use audit2allow to generate the SELinux policy to allow the denied operation. Follow:
The summary is there:
- Try a search operation that will fail.
grep httpd /var/log/audit/audit.log | audit2allow -M mysepolicysemodule -i mysepolicy.pp
Initialization
As root:
php /var/www/mediawiki-.../extensions/CirrusSearch/maintenance/UpdateSearchIndexConfig.php
Remove
$wgDisableSearchUpdate = true;
from LocalSettings.php.
php /var/www/mediawiki-.../extensions/CirrusSearch/maintenance/maintenance/ForceSearchIndex.php --skipLinks --indexOnSkip
php /var/www/mediawiki-.../extensions/CirrusSearch/maintenance/maintenance/ForceSearchIndex.php --skipParse
$wgSearchType = 'CirrusSearch';
Troubleshooting
Enable debugging as shown in:
[CirrusSearchRequests] near_match search for 'test' against {index} took 5 millis. Requested via web for 5b7883dcb7cd761f62397caa67819012 by executor 2078481799
[CirrusSearch] Search backend error during near_match search for 'test' after 5: unknown: Couldn't connect to host, Elasticsearch down?
Direct CirrusSearch error logs to a specific file. In LocalSettings.php:
$wgDebugLogGroups['CirrusSearch'] = "/tmp/cirrus-errors.log";
Did not work
Add the following query parameters to dump: &cirrusDumpQuery=true, &cirrusDumpResult=true.