.. program:: xbusd serve

.. _program-xbusd_serve:

xbusd serve - Run Xbus servers
------------------------------

Synopsis
~~~~~~~~


Run one or several of the Xbus servers.
The servers are:
- nats: A genuine nats server
- broker: Exchanges envelopes with actors
- control: Handle control API

::

  xbusd serve [flags]

Options
~~~~~~~

.. option:: --broker

    Start the broker service

.. option:: --clientapi

    Start the clientapi service

.. option:: --control

    Start the control service

.. option:: --debug-sql-bindings

    Logs sql bindings to debug. Very verbose

.. option:: --debug-sql-queries

    Logs sql queries to debug. Very verbose

.. option:: --director

    Start the director service

.. option:: --emitter

    Start the emitter service

.. option:: --envelopestorage

    Start the envelopestorage service

.. option:: --gnatsd.http_host

    User host for http monitoring

.. option:: --gnatsd.http_port

    User port for http monitoring

.. option:: --gnatsd.https_port

    User port for https monitoring

.. option:: --help

    help for serve

.. option:: --instance.logo

    A logo url (can be a 'http(s)', 'file' or 'data' uri), or a webpath  relative to the http gateway /ui path

.. option:: --instance.name

    Name of the xbus instance

.. option:: --instance.production

    Indicate that the instance is in a production environment

.. option:: --metrics

    Start the metrics service

.. option:: --metrics-delay-hint

    Optimize metrics gathering for the given delay between collections

.. option:: --metrics-http-host

    User host for http metrics (prometheus)

.. option:: --metrics-http-port

    User port for http metrics (prometheus)

.. option:: --metrics-merge-global

    Merge the bus-wide metrics (/metrics/global) into the xbusd instance metrics (/metrics)

.. option:: --nats

    Start a NATS server

.. option:: --postmortem

    Start the postmortem service

.. option:: --processstate

    Start the processstate service

.. option:: --registration

    Start the registration service

.. option:: --sentinel

    Start the sentinel service

.. option:: --sentinel-survey-onlinestatus-delay

    If non-zero, enables a 'onlinestatus' survey every given duration

.. option:: --sentry.dsn

    DSN of a sentry instance

.. option:: --sentry.environment

    DSN of a sentry instance

.. option:: --storage.envelope.cache.enabled

    Enables the envelope storage cache.

.. option:: --storage.envelope.cache.max-size

    Envelope storage cache max size.

.. option:: --storage.envelope.fallback

    Select the envelope storage fallback implementation. Can be one of 'sql' and 'sql-ng'.
    If an envelope is not found in the initial storage, the fallback storage will be used.
    The fallback is read-only except for the purges

.. option:: --storage.envelope.impl

    Select the envelope storage implementation. Can be one of 'sql' and 'sql-ng'.


Options inherited from parent commands
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. option:: --cert-dir

    The directory where certificates and private keys of use to this program reside.

.. option:: --config

    config file (default is the first existing file in: $HOME/.config/xbus/xbusd.yaml, /etc/xbus/xbusd.yaml)

.. option:: --database-dsn

    PostgreSQL database connection string (ex: "sslmode=disable dbname=xbus")

.. option:: --database-max-connections

    Maximum allowed number of open database connections

.. option:: --debug

    Enable debugging mode, with lots of logging to the console

.. option:: --full-version

    Show version and commit hash

.. option:: --nats-host

    Host of the nats server

.. option:: --nats-port

    Port of the nats server

.. option:: --storage-process-db-max-connections

    Maximum number of db connections for the process storage (defaults to 30% of database.max-connections)

.. option:: --tls-timeout

    TLS handshake timeout

.. option:: --trace

    Enable even more logging than --debug.

.. option:: --version

    Show version


SEE ALSO
~~~~~~~~

* :ref:`xbusd <program-xbusd>` 	 - xbus main command

*Auto generated by spf13/cobra on 24-Nov-2023*