link news file

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index 85de4364f7af21fe7371c1cdad8960bfc32a023f..034266a0e5e29f5f170a9f2b279a5dc819e05ecd 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -1,10 +1,14 @@
-************************************
-phorkie - PHP and Git based pastebin
-************************************
+****************************
+phorkie - Git based pastebin
+****************************
 Self-hosted pastebin software written in PHP.
 Pastes are editable, may have multiple files and are stored in git repositories.
 
-Project page: http://sourceforge.net/p/phorkie/
+`Homepage <https://cweiske.de/phorkie.htm>`__
+| `Bug tracker <https://github.com/cweiske/phorkie/issues>`__
+| `Git repository <https://git.cweiske.de/phorkie.git>`__
+· `GitHub mirror <https://github.com/cweiske/phorkie/>`__
+| `News <https://cweiske.de/phorkie-news.htm>`__
 
 .. contents:: Table of Contents
 
@@ -42,6 +46,19 @@ 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
+- text file detection for unknown file types
+
+
+========
+Download
+========
+phorkie is released as self-contained ``.phar`` file that includes
+all dependencies, as well as a normal zip file.
+
+.. LATESTRELEASE
+
+See `phorkie downloads page <http://cweiske.de/phorkie-download.htm>`_
+for all released versions.
 
 
 ============
@@ -50,7 +67,7 @@ Installation
 
 .phar
 =====
-Download ``phorkie-0.6.0.phar`` and put it in your web server's document root
+Download ``phorkie-0.8.0.phar`` and put it in your web server's document root
 directory.
 
 No further setup needed.
@@ -59,17 +76,21 @@ No further setup needed.
    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.
 
+__ http://cweiske.de/tagebuch/phar-webserver.htm
+
 
 Zip package
 ===========
 1. Unzip the phorkie release file::
 
-   $ tar xjvf phorkie-0.6.0.tar.bz2
+   $ tar xjvf phorkie-0.8.0.tar.bz2
 
 2. Create the git directories::
 
@@ -113,6 +134,8 @@ on your machine:
 
 - Git v1.7.5 or later
 - PHP v5.3.0 or later
+
+  - optionally the ``mbstring`` extension
 - PEAR v1.9.2 or later
 
 ::
@@ -155,9 +178,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.
 
-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/
+__ https://www.elastic.co/guide/en/elasticsearch/plugins/2.0/plugins-delete-by-query.html
 
 
 Setup
@@ -366,9 +395,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]+)/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&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;
@@ -449,6 +478,7 @@ Releasing a new version
     $ phing phar
 #. Test.
 #. Tag the release in git
-#. Upload release to sourceforge::
+#. Run the script to update the homepage
 
-    $ phing deploy-sf
+    $ cd /home/cweiske/Dev/html/cweiske.de
+    $ ./scripts/update-phorkie.sh