bootstrap-vz/bootstrapvz/plugins/file_copy/README.rst
Peter Wagner bc895292cd file_copy: Fix documentation typo
Slipping into open PR as both should be trivial.
2016-06-02 16:12:57 -07:00

27 lines
1.2 KiB
ReStructuredText

File copy
---------
This plugin lets you copy files from the host to the VM under construction,
create directories, and set permissions and ownership.
Note that this necessarily violates the `first development guideline`_.
.. _first development guideline: https://github.com/andsens/bootstrap-vz/blob/master/CONTRIBUTING.rst#the-manifest-should-always-fully-describe-the-resulting-image
Settings
~~~~~~~~
The ``file_copy`` plugin takes a (non-empty) ``files`` list, and optionally a ``mkdirs`` list.
Files (items in the ``files`` list) must be objects with the following properties:
- ``src`` and ``dst`` (required) are the source and destination paths.
``src`` is relative to the current directory, whereas ``dst`` is a path in the VM.
- ``permissions`` (optional) is a permission string in a format appropriate for ``chmod(1)``.
- ``owner`` and ``group`` (optional) are respectively a user and group specification,
in a format appropriate for ``chown(1)`` and ``chgrp(1)``.
Folders (items in the ``mkdirs`` list) must be objects with the following properties:
- ``dir`` (required) is the path of the directory.
- ``permissions``, ``owner`` and ``group`` are the same as for files.