do not run setupcheck on every page load

[phorkie.git] / README.rst

diff --git a/README.rst b/README.rst
index 0e8cadf90f2192effb7ef725de70178e8b6c72b5..c53d497198c04356a363075059b547b117faf442 100644 (file)
--- 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
 
 
 ============
@@ -68,7 +69,10 @@ Installation
    must also set the ``RewriteBase`` in the ``.htaccess`` file or adjust
    the nginx configuration accordingly.
 
-6. Open phorkie in your web browser
+6. Open http://yourhost/setup in your web browser to see if everything
+   is working fine.
+
+7. Go to http://yourhost/
 
 
 Dependencies
@@ -89,6 +93,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
@@ -102,6 +107,9 @@ on your machine:
   $ pear channel-discover pear.michelf.ca
   $ pear install michelf/Markdown
 
+  $ pear channel-discover pear2.php.net
+  $ pear install pear2/services_linkback-alpha
+
 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
@@ -208,6 +216,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
 =================
@@ -253,6 +292,8 @@ URLs
   Shows form for new paste
 ``/login``
   Login page for protecting site
+``/setup``
+  Check if everything is setup correctly and all dependencies are installed
 ``/user``
   Edit logged-in user information
 
@@ -298,5 +339,6 @@ If you use nginx, place the following lines into your ``server`` block:
     rewrite ^/search/([0-9]+)$ /search.php?page=$1;
 
     rewrite ^/login$ /login.php;
+    rewrite ^/setup$ /setup.php;
     rewrite ^/user$ /user.php;
   }