Disable editor on commit with --no-edit

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index bda173d6e466153aa8274821055cf57112ab3181..0e8cadf90f2192effb7ef725de70178e8b6c72b5 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
@@ -60,6 +61,12 @@ Installation
    Look at ``config.default.php`` for values that you may adjust.
 
 5. Set your web server's document root to ``/path/to/phorkie/www/``
+   Alternatively, you can add a symlink to the ``www`` folder into your
+   web server's existing document root tree (being careful to keep
+   main phorkie folder outside the document root for security purposes)
+   and ensure you set the ``baseurl`` config option appropriately. You
+   must also set the ``RewriteBase`` in the ``.htaccess`` file or adjust
+   the nginx configuration accordingly.
 
 6. Open phorkie in your web browser
 
@@ -100,6 +107,7 @@ way to install it.
 If you install it manually be sure to update the
 path from ``data/config.default.php``.
 
+
 ======
 Search
 ======
@@ -110,6 +118,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
@@ -117,6 +126,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
@@ -136,6 +146,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
@@ -179,6 +193,21 @@ 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
 =================
@@ -260,6 +289,8 @@ If you use nginx, place the following lines into your ``server`` block:
     rewrite ^/([0-9]+)/tool/([^/]+)/(.+)$ /tool.php?id=$1&tool=$2&file=$3;
 
     rewrite ^/new$ /new.php;
+    rewrite ^/feed/new$ /feed-new.php;
+    rewrite ^/feed/updated$ /feed-updated.php;
     rewrite ^/list$ /list.php;
     rewrite ^/list/([0-9]+)$ /list.php?page=$1;