sanitize title better
[phinde.git] / 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
28
29 ============
30 Dependencies
31 ============
32 - PHP 5.5+
33 - elasticsearch 2.0
34 - gearman
35 - Console_CommandLine
36 - Net_URL2
37
38
39 ============
40 About phinde
41 ============
42
43 Source code
44 ===========
45 phinde's source code is available from http://git.cweiske.de/phinde.git
46 or the `mirror on github`__.
47
48 __ https://github.com/cweiske/phinde
49
50
51 License
52 =======
53 phinde is licensed under the `AGPL v3 or later`__.
54
55 __ http://www.gnu.org/licenses/agpl.html
56
57
58 Author
59 ======
60 phinde was written by `Christian Weiske`__.
61
62 __ http://cweiske.de/