README.rst

   1 **********************************
   2 phinde - generic web search engine
   3 **********************************
   4 Self-hosted search engine you can use for your static blog or about
   5 any other website you want search functionality for.
   6
   7 My live instance is at http://search.cweiske.de/ and indexes my
   8 website, blog and all linked URLs.
   9
  10
  11 ========
  12 Features
  13 ========
  14 - Crawler and indexer with the ability to run many in parallel
  15 - Shows and highlights text that contains search words
  16 - Boolean search queries:
  17
  18   - ``foo bar`` searches for ``foo AND bar``
  19   - ``foo OR bar``
  20   - ``title:foo`` searches for ``foo`` only in the page title
  21 - Facets for tag, domain, language and type
  22 - Site search
  23
  24   - Query: ``foo bar site:example.org/dir/``
  25   - or use the ``site`` GET parameter:
  26     ``/?q=foo&site=example.org/dir``
  27 - OpenSearch support with HTML and Atom result lists
  28
  29
  30 ============
  31 Dependencies
  32 ============
  33 - PHP 5.5+
  34 - elasticsearch 2.0
  35 - gearman
  36 - Console_CommandLine
  37 - Net_URL2
  38
  39
  40 ============
  41 About phinde
  42 ============
  43
  44 Source code
  45 ===========
  46 phinde's source code is available from http://git.cweiske.de/phinde.git
  47 or the `mirror on github`__.
  48
  49 __ https://github.com/cweiske/phinde
  50
  51
  52 License
  53 =======
  54 phinde is licensed under the `AGPL v3 or later`__.
  55
  56 __ http://www.gnu.org/licenses/agpl.html
  57
  58
  59 Author
  60 ======
  61 phinde was written by `Christian Weiske`__.
  62
  63 __ http://cweiske.de/