Download:
child 283:57eaea1e5258
parent 281:866cafced685
282:99b534a9b1f5
Anton Shestakov <av6@dwimlabs.net>, Tue, 22 Aug 2017 14:24:58 +0800
docs: more words about configuration

1 файлов изменено, 16 вставок(+), 1 удалений(-) [+]
README.rst file | annotate | diff | comparison | revisions
--- a/README.rst Tue Aug 22 13:39:22 2017 +0800
+++ b/README.rst Tue Aug 22 14:24:58 2017 +0800
@@ -34,7 +34,8 @@
Project configuration
=====================
-Here's an example similar to *candolint.yml* of this project itself:
+Here's an example similar to *candolint.yml* of this project itself (plus a
+couple more options for demonstration):
.. code:: yaml
@@ -136,12 +137,26 @@
Queue configuration
===================
+Individual components talk to each other using a message queue, and that needs
+a Redis instance. Here's a sample configuration to use Redis on localhost, it
+can be stored in a file and supplied using ``--config`` switch.
+
.. code:: yaml
redis-host: 127.0.0.1
redis-port: 6379
redis-password: hunter2
+
+Poller configuration
+====================
+
+poller-queue.py also needs a list of targets to poll and an interval in
+seconds. They can be stored together with queue configuration in the same
+file.
+
+.. code:: yaml
+
poll-interval: 3600
targets: