============
- 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
$ git clone https://git.cweiske.de/phinde.git phinde
-#. Install dependencies via PEAR::
+#. Install dependencies via composer::
- $ pear install console_commandline net_url2
- $ pear channel-discover pear.twig-project.org
- $ pear install twig/Twig
+ $ composer install
#. 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::
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 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.
+
============
About phinde
============