Document MySQL setup for websub

[phinde.git] / README.rst

diff --git a/README.rst b/README.rst
index b00136bcb6a016509f3e2d12d9465bb10b3079e3..071f42d985a8d14211c61cd9c121533b9543028f 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -38,26 +38,31 @@ 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
+- Twig 1.x
 
 
 =====
 Setup
 =====
 #. Install and run Elasticsearch and Gearman
+#. Install ``php-gearman``
 #. Get a local copy of the code::
 
      $ git clone https://git.cweiske.de/phinde.git phinde
 
-#. Install dependencies via PEAR::
+#. Install dependencies via composer::
 
-     $ pear install console_commandline net_url2
+     $ 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::