Getting started
===============

Prerequisites
-------------

Install the Rust toolchain named by rust-toolchain.toml, Docker for the
container workflow, and Python 3.12 or later for documentation builds.

Build and test
--------------

From the repository root, run:

.. code-block:: console

   cargo build --locked --workspace
   cargo test --locked --workspace

The validator crate is located at crates/panda-rpki-validator. Its binary
accepts trust-anchor inputs and produces validated RPKI output. Use the local
help command to inspect the command surface available in the checkout:

.. code-block:: console

   cargo run --locked -p panda-rpki-validator -- --help

The bootstrap TAL and trust-anchor files in fixtures are not an offline
repository snapshot. To make a deterministic offline validation run, supply a
reviewed payload replay archive and locks file through the documented command
line options. Do not treat live RRDP or rsync retrieval as reproducible input.

Local container workflow
------------------------

The Docker scripts build a local image and run the repository verification
workflow:

.. code-block:: console

   bash scripts/docker/build_image.sh --arch amd64 --allow-dirty

For the Compose workflow, copy deploy/docker/.env.example to deploy/docker/.env
and use deploy/docker/scripts/start.sh. The image name in that file must match
the image tag built locally. Do not place credentials or generated outputs
under version control.