X-Git-Url: https://git.cweiske.de/phorkie.git/blobdiff_plain/6d769643d342032c06bc6fe00c7864b81c423bac..1e852867ef61f99a5b96369b986b9a858310af56:/README.rst

diff --git a/README.rst b/README.rst
index a11d327..f70796a 100644
--- a/README.rst
+++ b/README.rst
@@ -36,6 +36,7 @@ Features
 - search across pastes: description, file names and file content
 
   - options: quoting, logical and, or, not, partial words
+- webhook support - get notified when pastes are created, edited or deleted
 
 
 ============
@@ -61,6 +62,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
 
@@ -83,6 +90,7 @@ on your machine:
   $ pear install http_request2
   $ pear install pager
   $ pear install date_humandiff-alpha
+  $ pear install openid-alpha
 
   $ pear channel-discover pear.twig-project.org
   $ pear install twig/Twig
@@ -101,6 +109,7 @@ way to install it.
 If you install it manually be sure to update the
 path from ``data/config.default.php``.
 
+
 ======
 Search
 ======
@@ -111,6 +120,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
@@ -118,6 +128,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
@@ -137,6 +148,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
@@ -195,6 +210,37 @@ It is possible to get this information for each single commit::
     http://cweiske.de/
 
 
+Notifications via webhooks
+==========================
+Depending on how you use phorkie, it might be nice to notify some other service
+when pastes are added or updated.
+Phorkie contains a simply mechanism to post data to a given URL which
+you can then use as needed.
+
+The data are json-encoded POSTed to the URLs contained in the
+``$GLOBALS['phorkie']['cfg']['webhooks']`` setting array, with
+a MIME type of ``application/vnd.phorkie.webhook+json``::
+
+  {
+      'event': 'create',
+      'author': {
+          'name':'Anonymous',
+          'email': 'anonymous@phorkie',
+      },
+      'repository': {
+          'name': 'webhooktest',
+          'url': 'http://example.org/33',
+          'description': 'webhooktest',
+          'owner': {
+              'name': 'Anonymous',
+              'email': 'anonymous@phorkie',
+          }
+      }
+  }
+
+The event may be ``create``, ``edit`` or ``delete``.
+
+
 =================
 Technical details
 =================
@@ -276,6 +322,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;