delete repository from index when deleting it

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index 39d940db929b43c3d0a4246bcd639916c58ac49f..d37ae9b4a0cb7d52d177f77a6b4ccc5a90b26b9d 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -4,7 +4,7 @@ phorkie - PHP and Git based pastebin
 Self-hosted pastebin software written in PHP.
 Pastes are editable, may have multiple files and are stored in git repositories.
 
-Homepage: http://sourceforge.net/p/phorkie/
+Project page: http://sourceforge.net/p/phorkie/
 
 .. contents:: Table of Contents
 
@@ -37,6 +37,32 @@ Features
 
 
 ============
+Installation
+============
+1. Unzip the phorkie release file::
+
+   $ tar xjvf phorkie-0.2.0.tar.bz2
+
+2. Create the git directories::
+
+   $ mkdir -p repos/git repos/work
+   $ chmod og+w repos/git repos/work
+
+3. Install dependencies_
+
+4. Copy ``data/config.php.dist`` to ``data/config.php`` and adjust it
+   to your needs::
+
+   $ cp data/config.php.dist data/config.php
+   $ $EDITOR data/config.php
+
+   Look at ``config.default.php`` for values that you may adjust.
+
+5. Set your web server's document root to ``/path/to/phorkie-0.2.0/www/``
+
+6. Open phorkie in your web browser
+
+
 Dependencies
 ============
 phorkie stands on the shoulders of giants.
@@ -84,6 +110,18 @@ That's all. Open phorkie in your browser, and you'll notice the search box
 in the top menu.
 
 
+Reset
+=====
+In case something really went wrong and you need to reset the search
+index, run the following command::
+
+  $ curl -XDELETE http://localhost:9200/phorkie/
+  {"ok":true,"acknowledged"}
+
+Phorkie will automatically re-index everything when ``setupcheck`` is enabled
+in the configuration file.
+
+
 =====
 HowTo
 =====
@@ -161,12 +199,3 @@ Internal directory layout
       1.git/ - git repository for paste #1
         description - Description for the repository
       2.git/ - git repository for paste #2
-
-
-Search
-======
-Use ``ack-grep``
-
-
-
-