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 - Date search:
  23
  24   - ``before:2016-08-30`` - modification date before that day
  25   - ``after:2016-08-30`` - modified after that day
  26   - ``date::2016-08-30`` - exact modification day match
  27 - Site search
  28
  29   - Query: ``foo bar site:example.org/dir/``
  30   - or use the ``site`` GET parameter:
  31     ``/?q=foo&site=example.org/dir``
  32 - OpenSearch support with HTML and Atom result lists
  33 * Instant indexing with WebSub (formerly PubSubHubbub)
  34
  35
  36 ============
  37 Dependencies
  38 ============
  39 - PHP 5.5+
  40 - elasticsearch 2.0
  41 - gearman
  42 - Console_CommandLine
  43 - Net_URL2
  44
  45
  46 =====
  47 Setup
  48 =====
  49 This section is incomplete.
  50
  51 Cron job
  52 ========
  53 Run ``bin/renew-subscriptions.php`` once a day with cron.
  54
  55
  56 ============
  57 About phinde
  58 ============
  59
  60 Source code
  61 ===========
  62 phinde's source code is available from http://git.cweiske.de/phinde.git
  63 or the `mirror on github`__.
  64
  65 __ https://github.com/cweiske/phinde
  66
  67
  68 License
  69 =======
  70 phinde is licensed under the `AGPL v3 or later`__.
  71
  72 __ http://www.gnu.org/licenses/agpl.html
  73
  74
  75 Author
  76 ======
  77 phinde was written by `Christian Weiske`__.
  78
  79 __ http://cweiske.de/