README

   1 Libguestfs is a library for accessing and modifying guest disk images.
   2 Amongst the things this is good for: making batch configuration
   3 changes to guests, getting disk used/free statistics (see also:
   4 virt-df), migrating between virtualization systems (see also:
   5 virt-p2v), performing partial backups, performing partial guest
   6 clones, cloning guests and changing registry/UUID/hostname info, and
   7 much else besides.
   8
   9 Libguestfs uses Linux kernel and qemu code, and can access any type of
  10 guest filesystem that Linux and qemu can, including but not limited
  11 to: ext2/3/4, btrfs, FAT and NTFS, LVM, many different disk partition
  12 schemes, qcow, qcow2, vmdk.
  13
  14 Libguestfs provides ways to enumerate guest storage (eg. partitions,
  15 LVs, what filesystem is in each LV, etc.).  It can also run commands
  16 in the context of the guest.  Also you can access filesystems over FTP.
  17
  18 Libguestfs is a library that can be linked with C and C++ management
  19 programs (or management programs written in other languages, if people
  20 contribute the language bindings).  You can also use it from shell
  21 scripts or the command line.
  22
  23 Libguestfs was written by Richard W.M. Jones (rjones@redhat.com).
  24 For discussion please use the fedora-virt mailing list:
  25
  26   https://www.redhat.com/mailman/listinfo/fedora-virt
  27
  28
  29 Requirements
  30 ----------------------------------------------------------------------
  31
  32 - recent QEMU with vmchannel support
  33
  34 - febootstrap >= 1.2
  35
  36 - XDR, rpcgen
  37
  38 - Augeas (http://augeas.net/)
  39
  40 - perldoc (pod2man, pod2text) to generate the manual pages and
  41 other documentation.
  42
  43 - (Optional) OCaml if you want to rebuild the generated files, and
  44 also to build the OCaml bindings
  45
  46 - (Optional) local Fedora mirror
  47
  48 - (Optional) Perl if you want to build the perl bindings
  49
  50 - (Optional) Python if you want to build the python bindings
  51
  52 Running ./configure will check you have all the requirements installed
  53 on your machine.
  54
  55
  56 Building
  57 ----------------------------------------------------------------------
  58
  59 Then make the daemon, library and root filesystem:
  60
  61   ./configure [--with-mirror=URI]
  62   make
  63
  64 Use the optional --with-mirror parameter to specify the URI of a local
  65 Fedora mirror.  See the discussion of the MIRROR parameter in the
  66 febootstrap(8) manpage.
  67
  68 Finally run the tests:
  69
  70   make check
  71
  72 If everything works, you can install the library and tools by running
  73 these commands as root:
  74
  75   make install
  76
  77
  78 Notes on cross-architecture support
  79 ----------------------------------------------------------------------
  80
  81 At the moment we basically don't support cross-architecture or
  82 32-on-64.  This limits what is possible for some guests.  Filesystem
  83 operations and FTP export will work fine, but running commands in
  84 guests may not be possible.
  85
  86 To enable this requires work for cross-architecture and 32-on-64
  87 support in febootstrap, fakeroot and fakechroot.
  88
  89 The daemon/ directory contains its own configure script.  This is so
  90 that in future we will be able to cross-compile the daemon.
  91
  92
  93 Mirroring tip
  94 ----------------------------------------------------------------------
  95
  96 Having a local Fedora mirror makes a massive difference to the time it
  97 takes to build and rebuild initramfs images.
  98
  99 Failing that, use squid to cache yum downloads, but read this first:
 100 https://lists.dulug.duke.edu/pipermail/yum/2006-August/009041.html
 101 (In brief, because yum chooses random mirrors each time, squid doesn't
 102 work very well with default yum configuration.  To get around this,
 103 choose a Fedora mirror which is close to you, set this with
 104 './configure --with-mirror=[...]', and then proxy the whole lot
 105 through squid by setting http_proxy environment variable).
 106
 107 You will also need to substantially increase the squid configuration
 108 limits:
 109 http://fedoraproject.org/wiki/Using_Mock_to_test_package_builds#Using_Squid_to_Speed_Up_Mock_package_downloads
 110
 111 IntelligentMirror is another possibility, although I couldn't get it
 112 to work for me.
 113
 114
 115 Copyright and license information
 116 ----------------------------------------------------------------------
 117
 118 Copyright (C) 2009 Red Hat Inc.
 119
 120 The library is distributed under the LGPLv2+.  The programs are
 121 distributed under the GPLv2+.  Please see the files COPYING and
 122 COPYING.LIB for full license information.