prepare release of 0.7.0

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index 85de4364f7af21fe7371c1cdad8960bfc32a023f..422306ce22038092d2eb852dc5805788bd13c612 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -42,6 +42,7 @@ Features
 - webhook support - get notified when pastes are created, edited or deleted
 - atom feed for new and updated pastes
 - notifies remote instances via linkbacks when a paste has been forked
 - webhook support - get notified when pastes are created, edited or deleted
 - atom feed for new and updated pastes
 - notifies remote instances via linkbacks when a paste has been forked

+- text file detection for unknown file types

 
 
 ============
 
 
 ============


@@ -50,7 +51,7 @@ Installation
 
 .phar
 =====
 
 .phar
 =====

-Download ``phorkie-0.6.0.phar`` and put it in your web server's document root
+Download ``phorkie-0.7.0.phar`` and put it in your web server's document root

 directory.
 
 No further setup needed.
 directory.
 
 No further setup needed.


@@ -59,17 +60,21 @@ No further setup needed.
    PHP handle ``.phar`` files.
 
    Unfortunately, no Linux distribution has this activated by default.
    PHP handle ``.phar`` files.
 
    Unfortunately, no Linux distribution has this activated by default.

+   You can do it yourself, though - see
+   `Enable .phar handling in your web server`__.

 
 .. warning:: PHP has some bugs in its .phar handling code (e.g. with FPM).
 
    So currently, the ``.phar`` option is considered experimental.
 
 
 .. warning:: PHP has some bugs in its .phar handling code (e.g. with FPM).
 
    So currently, the ``.phar`` option is considered experimental.
 

+__ http://cweiske.de/tagebuch/phar-webserver.htm
+

 
 Zip package
 ===========
 1. Unzip the phorkie release file::
 
 
 Zip package
 ===========
 1. Unzip the phorkie release file::
 

-   $ tar xjvf phorkie-0.6.0.tar.bz2
+   $ tar xjvf phorkie-0.7.0.tar.bz2

 
 2. Create the git directories::
 
 
 2. Create the git directories::
 


@@ -113,6 +118,8 @@ on your machine:
 
 - Git v1.7.5 or later
 - PHP v5.3.0 or later
 
 - Git v1.7.5 or later
 - PHP v5.3.0 or later

+
+  - optionally the ``mbstring`` extension

 - PEAR v1.9.2 or later
 
 ::
 - PEAR v1.9.2 or later
 
 ::


@@ -155,9 +162,15 @@ phorkie makes use of an Elasticsearch__ installation, if you have one.
 
 It is used to provide search capabilities and the list of recent pastes.
 
 
 It is used to provide search capabilities and the list of recent pastes.
 

-Elasticsearch version 1.3 is supported.
+Elasticsearch version 2.0 is supported.
+
+You have to install the `delete-by-query`__ plugin::
+
+    $ cd /usr/share/elasticsearch
+    $ bin/plugin install delete-by-query

 
 __ http://www.elasticsearch.org/
 
 __ http://www.elasticsearch.org/

+__ https://www.elastic.co/guide/en/elasticsearch/plugins/2.0/plugins-delete-by-query.html

 
 
 Setup
 
 
 Setup


@@ -366,9 +379,9 @@ If you use nginx, place the following lines into your ``server`` block:
     rewrite ^/([0-9]+)/delete/confirm$ /delete.php?id=$1&confirm=1;
     rewrite ^/([0-9]+)/doap$ /doap.php?id=$1;
     rewrite ^/([0-9]+)/edit$ /edit.php?id=$1;
     rewrite ^/([0-9]+)/delete/confirm$ /delete.php?id=$1&confirm=1;
     rewrite ^/([0-9]+)/doap$ /doap.php?id=$1;
     rewrite ^/([0-9]+)/edit$ /edit.php?id=$1;

-    rewrite ^/([0-9]+)/edit/(.+)$ edit.php?id=$1&file=$2
+    rewrite ^/([0-9]+)/edit/(.+)$ /edit.php?id=$1&file=$2;

     rewrite ^/([0-9]+)/embed$ /embed.php?id=$1;
     rewrite ^/([0-9]+)/embed$ /embed.php?id=$1;

-    rewrite ^/([0-9]+)/embed/(.+)$ embed.php?id=$1&file=$2
+    rewrite ^/([0-9]+)/embed/(.+)$ /embed.php?id=$1&file=$2;

     rewrite ^/([0-9]+)/fork$ /fork.php?id=$1;
     rewrite ^/([0-9]+)/raw/(.+)$ /raw.php?id=$1&file=$2;
     rewrite ^/([0-9]+)/rev/(.+)$ /revision.php?id=$1&rev=$2;
     rewrite ^/([0-9]+)/fork$ /fork.php?id=$1;
     rewrite ^/([0-9]+)/raw/(.+)$ /raw.php?id=$1&file=$2;
     rewrite ^/([0-9]+)/rev/(.+)$ /revision.php?id=$1&rev=$2;