Boxer installation
==================

Preparations
------------

On Debian 8+ (Jessie or newer), or Debian unstable (Sid),
boxer is available as a regular package:

    apt install boxer

Alternatively install from CPAN, and only helper tools from Debian:

    cpanm Boxer
    apt install mmdebstrap || apt install debootstrap


Usage
-----

    cp /usr/share/doc/boxer/examples/nodes/parl-greens.yml .
    boxer compose parl-greens

    cp /usr/share/doc/boxer/examples/nodes/lxp5.yml .
    boxer bootstrap lxp5 -- lxp5_rootfs
    sudo -- boxer bootstrap --helper debootstrap lxp5 -- lxp5_rootfs

NB! If code was pulled from CPAN or git, you may need to adapt location
of example file and environment variables PATH PYTHONPATH PERL5LIB.


Development
-----------

    git clone https://salsa.debian.org/boxer-team/boxer
    cd boxer
    PERL5LIB=lib bin/boxer compose --skeldir share/skel --datadir examples parl-greens
    PERL5LIB=lib bin/boxer bootstrap --skeldir share/skel --datadir examples lxp5

You may want to explore the larger dataset in active use:

    git clone https://salsa.debian.org/boxer-team/boxer-data.git

System compositions are expressed using a set of YAML files.
See the README in the sample data dir for more info on its structure.