diff options
author | Evan Prodromou <evan@status.net> | 2009-11-11 00:22:42 -0500 |
---|---|---|
committer | Evan Prodromou <evan@status.net> | 2009-11-11 00:22:42 -0500 |
commit | 935410e8dc4c2d4d286a942cc27bbf8bc452fbdd (patch) | |
tree | 98e3a577b432232bdddcc30afa9ad8a61a28d301 /plugins/SphinxSearch/README | |
parent | 1f5f5474f175a8248b362f8be4ff23bb5e971305 (diff) | |
parent | 093857c582a68b39e0d65523d27f25ede7b7fed6 (diff) |
Merge branch '0.9.x' into adminpanel
Diffstat (limited to 'plugins/SphinxSearch/README')
-rw-r--r-- | plugins/SphinxSearch/README | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/plugins/SphinxSearch/README b/plugins/SphinxSearch/README new file mode 100644 index 000000000..5a2c063bd --- /dev/null +++ b/plugins/SphinxSearch/README @@ -0,0 +1,45 @@ +You can get a significant boost in performance using Sphinx Search +instead of your database server to search for users and notices. +<http://sphinxsearch.com/>. + +Configuration +------------- + +In StatusNet's configuration, you can adjust the following settings +under 'sphinx': + +enabled: Set to true to enable. Default false. +server: a string with the hostname of the sphinx server. +port: an integer with the port number of the sphinx server. + + +Requirements +------------ + +To use a Sphinx server to search users and notices, you also need +to install, compile and enable the sphinx pecl extension for php on the +client side, which itself depends on the sphinx development files. +"pecl install sphinx" should take care of that. Add "extension=sphinx.so" +to your php.ini and reload apache to enable it. + +You can update your MySQL or Postgresql databases to drop their fulltext +search indexes, since they're now provided by sphinx. + + +You will also need a Sphinx server to serve the search queries. + +On the sphinx server side, a script reads the main database and build +the keyword index. A cron job reads the database and keeps the sphinx +indexes up to date. scripts/sphinx-cron.sh should be called by cron +every 5 minutes, for example. scripts/sphinx.sh is an init.d script +to start and stop the sphinx search daemon. + + +Server configuration +-------------------- +scripts/gen_config.php can generate a sphinx.conf file listing MySQL +data sources for your databases. You may need to tweak paths afterwards. + + $ plugins/SphinxSearch/scripts/gen_config.php > sphinx.conf + +If you wish, you can build a full config yourself based on sphinx.conf.sample |