link websub on status page

[phinde.git] / README.rst

diff --git a/README.rst b/README.rst
index f52e00175bb41212e6d4d7848b0e1422c5548b26..e52581db8bfcc2d0f177bcb30f6e18609ab2ce79 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -38,7 +38,8 @@ Dependencies
 ============
 - PHP 5.5+
 - Elasticsearch 2.0
-- Gearman
+- MySQL or MariaDB for WebSub subscriptions
+- Gearman (Debian 9: ``gearman-job-server``, not ``gearman-server``)
 - PHP Gearman extension
 - Console_CommandLine
 - Net_URL2
@@ -61,6 +62,7 @@ Setup
 #. Point your webserver's document root to phinde's ``www`` directory
 #. Copy ``data/config.php.dist`` to ``data/config.php`` and adjust it.
    Make sure your add your domain to the crawl whitelist.
+#. Create a MySQL database and import the schema from ``data/schema.sql``
 #. Run ``bin/setup.php`` which sets up the Elasticsearch schema
 #. Put your homepage into the queue::
 
@@ -142,6 +144,27 @@ That's delete-by-query 2.0, see
 https://www.elastic.co/guide/en/elasticsearch/plugins/2.0/delete-by-query-usage.html
 
 
+Subscribe to a website/feed
+===========================
+Phinde supports WebSub__ to get subscribe to changes of a website.
+When phinde gets notified by the website's hub about changes,
+it will immediately crawl and index the changed pages.
+
+Subscribe to a website's feed::
+
+    $ php bin/subscribe.php http://example.org/feed.atom
+
+Phinde will determine the website's hub and send a registration request to it.
+
+The status page will show the number of working, and the number of open
+subscriptions.
+
+Unsubscribing also happens on command line::
+
+    $ php bin/unsubscribe.php http://example.org/feed.atom
+
+__ https://www.w3.org/TR/websub/
+
 ============
 About phinde
 ============