document systemd service setup

[phinde.git] / README.rst

diff --git a/README.rst b/README.rst
index 3d10657a381b155ae8d76808a5ebad7ce8de1ca2..0008b601ec91cbfcd9fc24365b54d9766fce8d1e 100644 (file)
--- a/README.rst
+++ b/README.rst
@@ -19,11 +19,18 @@ Features
   - ``foo OR bar``
   - ``title:foo`` searches for ``foo`` only in the page title
 - Facets for tag, domain, language and type
+- Date search:
+
+  - ``before:2016-08-30`` - modification date before that day
+  - ``after:2016-08-30`` - modified after that day
+  - ``date::2016-08-30`` - exact modification day match
 - Site search
 
   - Query: ``foo bar site:example.org/dir/``
   - 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)
 
 
 ============
@@ -36,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
 ============