Updated README to clarify elasticsearch setup

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index e7e1625b6a3685421e3143078606c939999ed554..f805e7767e65d2521af6a5b03db07b0291dc4ee4 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -15,16 +15,17 @@ Features
 
   - repositories can be cloned
   - clone url can be displayed
+  - remote pastes can be forked (rel="vcs-git" and gist.github.com)
 - paste editing
 
   - add new files
   - delete existing files
   - replace file with upload
-- OpenID authentication
 - multiple files in one paste
 - syntax highlighting with GeSHi
 - rST and Markdown rendering
 - image upload + display
+- OpenID authentication
 - external tool support
 
   - xmllint
@@ -68,9 +69,12 @@ Dependencies
 ============
 phorkie stands on the shoulders of giants.
 
-- git v1.7.5
-- php v5.3.0
-- pear v1.9.2
+It requires the following programs to be installed
+on your machine:
+
+- Git v1.7.5 or later
+- PHP v5.3.0 or later
+- PEAR v1.9.2 or later
 
 ::
 
@@ -91,10 +95,12 @@ phorkie stands on the shoulders of giants.
 
   $ pear channel-discover pear.michelf.ca
   $ pear install michelf/Markdown
-  
+
 Note that this version of GeSHi is a bit outdated, but it's the fastest
-way to install it.  If you install it manually be sure to update the
-path in ``data/config.default.php``.
+way to install it.
+If you install it manually be sure to update the
+path from ``data/config.default.php``.
+
 
 ======
 Search
@@ -106,6 +112,7 @@ 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
@@ -113,6 +120,7 @@ of the index, e.g. ::
 
   http://localhost:9200/phorkie/
 
+You must use a search namespace with Elasticsearch such as ``phorkie/``.
 Run the index script to import all existing pastes into the index::
 
   php scripts/index.php
@@ -132,6 +140,10 @@ index, run the following command::
 Phorkie will automatically re-index everything when ``setupcheck`` is enabled
 in the configuration file.
 
+You may also manually run the reindexing script with::
+
+  $ php scripts/index.php
+
 
 =====
 HowTo
@@ -152,22 +164,44 @@ Edit your ``config.php`` and set the ``$GLOBALS['phorkie']['cfg']['git']['public
 setting to ``git://$yourhostname/git/paste/``.
 The rest will be appended automatically.
 
+
 You're on your own to setup writable repositories.
 
+
 Protect your site with OpenID
 =============================
 You have the option of enabling OpenID authentication to help secure your
-pastes on phorkie.  Set the ``$GLOBALS['phorkie']['auth']`` values in the
-``data/config.php`` file as desired.  
-
-There are two different types of security you can apply.  First, you can
-restrict to one of three ``securityLevels``; completely open (``0``), protection
-of write-enabled functions such as add, edit, etc. (``1``), and full site
-protection (``2``).  Additionally, you can restrict your site to ``listedUsersOnly``.
-You will need to add the individual OpenIDs identity urls to the
+pastes on phorkie.
+Set the ``$GLOBALS['phorkie']['auth']`` values in the
+``data/config.php`` file as desired.
+
+There are two different types of security you can apply.
+First, you can restrict to one of three ``securityLevels``:
+
+- completely open (``0``)
+- protection of write-enabled functions such as add, edit, etc. (``1``)
+- full site protection (``2``)
+
+Additionally, you can restrict your site to ``listedUsersOnly``.
+You will need to add the individual OpenID urls to the
 ``$GLOBALS['phorkie']['auth']['users']`` variable.
 
 
+Get information about paste editors
+===================================
+Phorkie stores the user's OpenID or IP address (when not logged in) when
+a paste is edited.
+It is possible to get this information for each single commit::
+
+    // IP / OpenID for the latest commit
+    $ git notes --ref=identity show
+    127.0.0.1
+
+    // show IP / OpenID for a given commit
+    $ git notes --ref=identity show 29f82a
+    http://cweiske.de/
+
+
 =================
 Technical details
 =================