caterva2.sample.toml

# Example configuration file for Caterva2 components.
#
# This may be parsed by different programs, and each program may look up settings in its own section, or in other programs' sections, if present. For instance, there is no setting in the ``subscriber`` section for the broker endpoint; instead, the subscriber program will look ``broker.http`` up. For instance, in a subscriber configuration file::
#
#     [broker]
#     http = ...  # Broker HTTP endpoint, to be used by subscriber.
#     # No need for more broker settings unless the broker is to use this file.
#
#     [subscriber]
#     ...
#
# Some sections may appear multiple times, each with a different ID (see below). However, if you are to use a single program of each category, you should be file with ID-less sections.
#
# All sections and settings are optional.

# The configuration of the broker service.
# Only one of these is allowed for the moment.
[broker]
http = "localhost:8000"  # The ``host:port`` endpoint where the service listens for HTTP requests. Other programs may look ``broker.http`` up to find how to connect to a broker. Use ``*`` as a host to listen on all addresses.
statedir = "_caterva2/bro"  # The directory where the service will place state files.
loglevel = "warning"  # All service messages having this severity or worse will be logged.

# The configuration of the publisher service.
# Several of these are allowed, each with a different ID (the string after the dot). A publisher invoked with ``--id=something`` will look its configuration up in the ``publisher.something`` section.
[publisher.1]
http = "localhost:8001"  # The ``host:port`` endpoint where the service listens for HTTP requests. Use ``*`` as a host to listen on all addresses.
statedir = "_caterva2/pub"  # The directory where the service will place state files.
loglevel = "warning"  # All service messages having this severity or worse will be logged.
name = "foo"  # The name given to the root to be registered at the broker. This setting has no default, if it is not defined here, you need to give it to the publisher as an argument.
root = "root-examples"  # The location (directory, HDF5 file...) containing the datasets for the registered root.

# Only one of these is allowed. It will be used by a publisher invoked with no ID, or it may be used by other programs to find how to connect to a publisher (``publisher.http``).
[publisher]
http = "localhost:8001"
# ... other settings as above ...

# The configuration of the subscriber service.
# Several of these are allowed, each with a different ID (the string after the dot). A subscriber invoked with ``--id=something`` will look its configuration up in the ``subscriber.something`` section.
[subscriber.1]
http = "localhost:8002"  # The ``host:port`` endpoint where the service listens for HTTP requests. Use ``*`` as a host to listen on all addresses.
url = "https://cat2.example.com/"  # The base of URLs, if different from ``http://<subscriber.http>/``.
statedir = "_caterva2/sub"  # The directory where the service will place state files.
loglevel = "warning"  # All service messages having this severity or worse will be logged.

# Only one of these is allowed. It will be used by a subscriber invoked with no ID, or it may be used by other programs to find how to connect to a subscriber (``subscriber.url``).
[subscriber]
url = "https://cat2.example.com/"
# ... other settings as above ...

# Common configuration of client programs.
# Only one of these is allowed for the moment.
[client]
username = ""  # If present and not empty, a name to be used to authenticate the user to the subscriber and get an authorization token.
password = ""  # If present and not empty, a password for the previous user.