README.rst 1.08 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
Xbus Stdlib
===========

Xbus Stdlib is a Xbus client that provides a library of actor implentations,
and a few shared utilities.

Actors
------

- file-gateway actors: use a local or remote filesystem as a gateway to/from
  xbus messages. See filegateway/README.rst
- xbus2xbus: provides a consumer that forwards envelopes to another xbus
  instance. See xbus2xbus/README.rst

Utilities
---------

FileMessageReader
'''''''''''''''''

A helper to read messages that respect the
[File Message Format](https://project.orus.io/project/xbus-rd/wiki/file-message-format).

FileLocationS3
''''''''''''''

Provides support for "s3" location of file messages.

To work properly, access and secret keys must be provided in the client
configuration file for each potential provider endpoint.

For example:

.. code-block:: yaml

    account-name: accountname
    actors:
      # ...
    file-location:
      s3:
         "myminio:9002":
           access-key: myaccesskey
           secret-key: mysecretkey
           ssl: true


FileLocationHTTP
''''''''''''''''

Provides support for "http" location of file messages.