talk about search setup
[phorkie.git] / README.rst
index aaa38cc..39d940d 100644 (file)
@@ -31,36 +31,26 @@ Features
 - history in the sidebar
 
   - old files can be downloaded easily
+- search across pastes: description, file names and file content
+
+  - options: quoting, logical and, or, not, partial words
+
 
 ============
 Dependencies
 ============
 phorkie stands on the shoulders of giants.
 
-
-Install VersionControl_Git
-==========================
 ::
 
   $ pear install versioncontrol_git-alpha
-
-Install Services_Libravatar
-==========================
-::
-
   $ pear install services_libravatar-alpha
-
-
-Install Date_HumanDiff
-======================
-::
-
+  $ pear install http_request2
+  $ pear install pager
   $ pear install https://github.com/downloads/cweiske/Date_HumanDiff/Date_HumanDiff-0.1.0.tgz
 
-
-Install GeSHi
-=============
-::
+  $ pear channel-discover pear.twig-project.org
+  $ pear install twig/Twig
 
   $ pear channel-discover mediawiki.googlecode.com/svn
   $ pear install mediawiki/geshi
@@ -69,12 +59,29 @@ Note that this version of GeSHi is a bit outdated, but it's the fastest
 way to install it.
 
 
-Install Twig
-============
-::
+======
+Search
+======
 
-  $ pear channel-discover pear.twig-project.org
-  $ pear install twig/Twig
+phorkie makes use of an Elasticsearch__ installation if you have one.
+
+It is used to provide search capabilities and the list of recent pastes.
+
+__ http://www.elasticsearch.org/
+
+Setup
+=====
+Edit ``config.php``, setting the ``elasticsearch`` property to the HTTP URL
+of the index, e.g. ::
+
+  http://localhost:9200/phorkie/
+
+Run the index script to import all existing pastes into the index::
+
+  php scripts/index.php
+
+That's all. Open phorkie in your browser, and you'll notice the search box
+in the top menu.
 
 
 =====
@@ -106,16 +113,13 @@ Technical details
 
 TODO
 ====
-- filters (xmllint --format, rapper)
-- search
 - OpenID-Login to get username+email as authorship information
+- filters (``xmllint --format``, ``rapper``)
 - document how to keep disk usage low (block size)
 - comments
 - when 2 people edit, merge changes
 - diff changes
 - configurable highlights
-- tags
-- autotags for file types
 - Atom feed for new pastes
 - Atom feed for paste changes
 
@@ -131,12 +135,18 @@ URLs
   Edit the paste
 ``/[0-9]+/raw/(.+)``
   Display raw file contents
+``/[0-9]/tool/[a-zA-Z]+/(.+)``
+  Run a tool on the given file
+``/[0-9]/rev/[a-z0-9]+``
+  Show specific revision of the paste
 ``/[0-9]/delete``
   Delete the paste
-``/search(/.+)?``
-  Search for term
+``/[0-9]/fork``
+  Create a fork of the paste
+``/search?q=..(&page=[0-9]+)?``
+  Search for term, with optional page
 ``/list(/[0-9])?``
-  List all pastes
+  List all pastes, with optional page
 
 
 Internal directory layout