Add colors to status page to make it easy to spot problems

[phinde.git] / README.rst

diff --git a/README.rst b/README.rst
index e34cd15225ea71d9ac32877f4b7e9086720ef7b0..0008b601ec91cbfcd9fc24365b54d9766fce8d1e 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -30,6 +30,7 @@ Features
   - or use the ``site`` GET parameter:
     ``/?q=foo&site=example.org/dir``
 - OpenSearch support with HTML and Atom result lists
+* Instant indexing with WebSub (formerly PubSubHubbub)
 
 
 ============
@@ -42,6 +43,37 @@ Dependencies
 - Net_URL2
 
 
+=====
+Setup
+=====
+FIXME: This section is incomplete.
+
+
+System service
+==============
+When using systemd, you can let it run multiple worker instances when
+the system boots up:
+
+#. Copy files ``data/systemd/phinde*.service`` into ``/etc/systemd/system/``
+#. Adjust user and group names, and the work directories
+#. Enable three worker processes::
+
+     $ systemctl daemon-reload
+     $ systemctl enable phinde@1
+     $ systemctl enable phinde@2
+     $ systemctl enable phinde@3
+     $ systemctl enable phinde
+     $ systemctl start phinde
+#. Now three workers are running. Restarting the ``phinde`` service also
+   restarts the workers.
+
+
+
+Cron job
+========
+Run ``bin/renew-subscriptions.php`` once a day with cron.
+
+
 ============
 About phinde
 ============