Source

araldo-redis / doc / araldo-redis.rst

Full commit
bb b...@gmx.de 0b2f776 











































araldo-redis
############

`Redis <http://http://redis.io/>`_ endpoint for 
`araldo <http://bitbucket.org/ganymed/araldo>`_, a routing-based 
communication relay.

The plugin allows receiving messages from a Redis PubSub queue and to forward
these messages to one or more endpoints. Likewise, incoming messages can be published
to a Redis PubSub queue.

Installation
============

  pip install araldo-redis

The plugin will be automatically available to *araldo*.

Plugin Configuration
====================


============== ========= ============================================
Parameter      Type      Description
============== ========= ============================================
host           str       Host name or IP address of Redis server
port           int       TCP port of Redis server
channel        str       Redis PubSub channel to listen to
                         (for inbound endpoint instances) or to 
                         publish messages to (for outbound endpoint
                         instances)
============== ========= ============================================

Sample Configuration
====================

Plugin-specific Configuration block::

  - name: redis_1
    id: endpoint-redis
    host: localhost
    port: 6379
    channel: channel_1
    marshalling: marshal-raw