Nimbus
======

.. note::
    Nimbus includes both ``nimbus`` (base install) and ``nimbus_beacon`` inventory groups.
    The base role installs the binary and creates the JWT secret; the beacon role
    deploys the systemd service. The beacon role depends on the base role having run first.

.. warning::
    The ``nimbus_jwt_secret`` in ``.credentials.yml`` is **required** and must match
    the secret used by the paired execution client.

Nimbus is a lightweight Ethereum consensus client (beacon node) developed by Status.

For additional information see `Nimbus official docs <https://nimbus.guide/>`_

Deployment Vars
---------------

Secrets
*******

``nimbus_jwt_secret``:
    * Required
    * Must match the JWT secret used by the execution layer (Geth, Nethermind, etc.)
    * Generate with: ``openssl rand -hex 32 | tr -d "\n"``

Host variables
**************

None required.

Configuration File
******************

The ``beacon.service`` systemd unit in ``/host_vars/files`` controls the beacon node flags,
including ``--network``, ``--data-dir``, ``--web3-url``, ``--jwt-secret``, and
``--suggested-fee-recipient``. Edit that file before deploying to set the correct
execution client URL and fee recipient address.