Document MySQL setup for websub
[phinde.git] / README.rst
index 1633f8607638297aa778a39ced3de59a4a6a0b7a..071f42d985a8d14211c61cd9c121533b9543028f 100644 (file)
@@ -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
@@ -54,15 +55,14 @@ Setup
 
      $ 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::