diskimage-builder/doc/source/user_guide/installation.rst
Ian Wienand c48a40d479 Move several packages to bindep.txt
Move several parts of the "install_test_deps.sh" script into the more
standard bindep.txt.  This list is intentionally restricted as a first
step.

Developer documentation is updated to use bindep and clarified
slightly.

Change-Id: I7520902dc324d920a0c7c44a2d35fe49f9b05614
2018-10-29 09:52:13 +11:00

42 lines
1.3 KiB
ReStructuredText

Installation
============
If your distribution does not provide packages, you should install
``diskimage-builder`` via ``pip``, mostly likely in a ``virtualenv``
to keep it separate. For details, see the installation section in the
:ref:`dev_install`.
Once installed, you will be able to :doc:`build images
<building_an_image>` using ``disk-image-create`` and the elements
included in the main ``diskimage-builder`` repository.
Requirements
------------
Most image formats require the ``qemu-img`` tool which is provided by
the ``qemu-utils`` package on Ubuntu/Debian or the ``qemu`` package on
Fedora/RHEL/opensuse/Gentoo.
When generating images with partitions, the ``kpartx`` tool is needed,
which is provided by the ``kpartx`` package.
Some image formats, such as ``VHD``, may require additional
tools. Please see the ``disk-image-create`` help output for more
information.
Individual elements can also have additional dependencies for the build host.
It is recommended you check the documentation for each element you are using
to determine if there are any additional dependencies. Of particular note is
the need for the `dev-python/pyyaml` package on Gentoo hosts.
Package Installation
--------------------
On Gentoo you can emerge diskimage-builder directly.
::
emerge app-emulation/diskimage-builder