plugins/SphinxSearch/README

   1 You can get a significant boost in performance using Sphinx Search
   2 instead of your database server to search for users and notices.
   3 <http://sphinxsearch.com/>.
   4
   5 Configuration
   6 -------------
   7
   8 In StatusNet's configuration, you can adjust the following settings
   9 under 'sphinx':
  10
  11 enabled: Set to true to enable. Default false.
  12 server: a string with the hostname of the sphinx server.
  13 port: an integer with the port number of the sphinx server.
  14
  15
  16 Requirements
  17 ------------
  18
  19 To use a Sphinx server to search users and notices, you also need
  20 to install, compile and enable the sphinx pecl extension for php on the
  21 client side, which itself depends on the sphinx development files.
  22 "pecl install sphinx" should take care of that. Add "extension=sphinx.so"
  23 to your php.ini and reload apache to enable it.
  24
  25 You can update your MySQL or Postgresql databases to drop their fulltext
  26 search indexes, since they're now provided by sphinx.
  27
  28
  29 You will also need a Sphinx server to serve the search queries.
  30
  31 On the sphinx server side, a script reads the main database and build
  32 the keyword index. A cron job reads the database and keeps the sphinx
  33 indexes up to date. scripts/sphinx-cron.sh should be called by cron
  34 every 5 minutes, for example. scripts/sphinx.sh is an init.d script
  35 to start and stop the sphinx search daemon.
  36
  37
  38 Server configuration
  39 --------------------
  40 scripts/gen_config.php can generate a sphinx.conf file listing MySQL
  41 data sources for your databases. You may need to tweak paths afterwards.
  42
  43   $ plugins/SphinxSearch/scripts/gen_config.php > sphinx.conf
  44
  45 If you wish, you can build a full config yourself based on sphinx.conf.sample