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 OCaml, Perl, Python, Ruby, Java
  20 or Haskell).  You can also use it from shell scripts or the command line.
  21
  22 Libguestfs was written by Richard W.M. Jones (rjones@redhat.com).
  23 For discussion please use the fedora-virt mailing list:
  24
  25   https://www.redhat.com/mailman/listinfo/fedora-virt
  26
  27
  28 Requirements
  29 ----------------------------------------------------------------------
  30
  31 - recent QEMU >= 0.10 with vmchannel support
  32   http://lists.gnu.org/archive/html/qemu-devel/2009-02/msg01042.html
  33
  34 - febootstrap >= 2.0
  35
  36 - fakeroot
  37
  38 - fakechroot >= 2.9
  39
  40 - XDR, rpcgen (on Linux these are provided by glibc)
  41
  42 - squashfs-tools (mksquashfs only)
  43
  44 - (Optional) Augeas (http://augeas.net/)
  45
  46 - perldoc (pod2man, pod2text) to generate the manual pages and
  47   other documentation.
  48
  49 - (Optional) Readline to have nicer command-line editing in guestfish.
  50
  51 - (Optional) 'reged' program from chntpw to decode Windows registry
  52   entries (http://home.eunet.no/~pnordahl/ntpasswd/)
  53
  54 - (Optional) OCaml if you want to rebuild the generated files, and
  55   also to build the OCaml bindings
  56
  57 - (Optional) local Fedora mirror
  58
  59 - (Optional) Perl if you want to build the perl bindings
  60
  61 - (Optional) Python if you want to build the python bindings
  62
  63 - (Optional) Ruby, rake if you want to build the ruby bindings
  64
  65 - (Optional) Java, JNI, jpackage-utils if you want to build the java
  66 bindings
  67
  68 - (Optional) GHC if you want to build the Haskell bindings
  69
  70 Running ./configure will check you have all the requirements installed
  71 on your machine.
  72
  73
  74 Building
  75 ----------------------------------------------------------------------
  76
  77 Then make the daemon, library and root filesystem:
  78
  79   ./configure [--with-mirror=URI]
  80   make
  81
  82 Use the optional --with-mirror parameter to specify the URI of a local
  83 Fedora mirror.  See the discussion of the MIRROR parameter in the
  84 febootstrap(8) manpage.
  85
  86 Finally run the tests:
  87
  88   make check
  89
  90 If everything works, you can install the library and tools by running
  91 this command as root:
  92
  93   make install
  94
  95
  96 Fedora
  97 ----------------------------------------------------------------------
  98
  99 We provide packages for Fedora >= 11 in Fedora.  Use those, or build
 100 from our source RPMs - it's far simpler that way.
 101
 102 You can compile libguestfs on Fedora 10 but you cannot use it with the
 103 version of qemu in Fedora 10.  You need to compile your own qemu, see
 104 section 'qemu' below.
 105
 106
 107 RHEL / EPEL / CentOS etc
 108 ----------------------------------------------------------------------
 109
 110 We provide packages in EPEL which cover RHEL/CentOS >= 5.  Use those
 111 or build from our source RPMs.
 112
 113
 114 Debian
 115 ----------------------------------------------------------------------
 116
 117 libguestfs should build and run on Debian.  At the moment we don't
 118 provide Debian packages, and because of the appliance it's rather
 119 complicated to provide a package which could be accepted into the
 120 Debian repositories.  Want to help?  Please contact us.
 121
 122
 123 qemu
 124 ----------------------------------------------------------------------
 125
 126 By far the most common problem is with broken or incompatible
 127 qemu releases.
 128
 129 First of all, you need qemu >= 0.10.4, which contains a vmchannel
 130 implementation.  There are several, conflicting, incompatible things
 131 called 'vmchannel' which at one time or another have been added or
 132 proposed for qemu/KVM.  The _only_ one we support is this one:
 133
 134   http://lists.gnu.org/archive/html/qemu-devel/2009-02/msg01042.html
 135
 136 Secondly, different versions of qemu have problems booting the
 137 appliance for different reasons.  This varies between versions of
 138 qemu, and Linux distributions which add their own patches.
 139
 140 If you find a problem, you could try using your own qemu built from
 141 source (qemu is very easy to build from source), with a 'qemu
 142 wrapper'.  Qemu wrappers are described in the guestfs(3) manpage.
 143
 144
 145 Note on using KVM
 146 ----------------------------------------------------------------------
 147
 148 By default the configure script will look for qemu-kvm (KVM support).
 149 You will need a reasonably recent processor for this to work.  KVM is
 150 much faster than using plain Qemu.
 151
 152 You may also need to enable KVM support for non-root users, by following
 153 these instructions:
 154
 155   http://www.linux-kvm.org/page/FAQ#How_can_I_use_kvm_with_a_non-privileged_user.3F
 156
 157 On some systems, this will work too:
 158
 159   chmod o+rw /dev/kvm
 160
 161 On some systems, the chmod will not survive a reboot, and you will
 162 need to make edits to the udev configuration.
 163
 164
 165 Notes on cross-architecture support
 166 ----------------------------------------------------------------------
 167
 168 At the moment we basically don't support cross-architecture or
 169 32-on-64.  This limits what is possible for some guests.  Filesystem
 170 operations and FTP export will work fine, but running commands in
 171 guests may not be possible.
 172
 173 To enable this requires work for cross-architecture and 32-on-64
 174 support in febootstrap, fakeroot and fakechroot.
 175
 176 The daemon/ directory contains its own configure script.  This is so
 177 that in future we will be able to cross-compile the daemon.
 178
 179
 180 Mirroring tip
 181 ----------------------------------------------------------------------
 182
 183 On my machines I can usually rebuild the appliance in around 3
 184 minutes.  If it takes much longer for you, use a local Fedora mirror
 185 or squid.
 186
 187 To use squid to cache yum downloads, read this first:
 188 https://lists.dulug.duke.edu/pipermail/yum/2006-August/009041.html
 189 (In brief, because yum chooses random mirrors each time, squid doesn't
 190 work very well with default yum configuration.  To get around this,
 191 choose a Fedora mirror which is close to you, set this with
 192 './configure --with-mirror=[...]', and then proxy the whole lot
 193 through squid by setting http_proxy environment variable).
 194
 195 You will also need to substantially increase the squid configuration
 196 limits:
 197 http://fedoraproject.org/wiki/Using_Mock_to_test_package_builds#Using_Squid_to_Speed_Up_Mock_package_downloads
 198
 199
 200 Porting to other Linux distros / non-Linux
 201 ----------------------------------------------------------------------
 202
 203 libguestfs itself should be fairly portable to other Linux
 204 distributions.  Non-Linux ports are trickier, but we will accept
 205 patches if they aren't too invasive.
 206
 207 The main porting issues are with the dependencies needed to build the
 208 appliance.  You will need to find or port the following packages
 209 first:
 210
 211  - fakeroot
 212  - fakechroot
 213  - python
 214  - rpm-python    http://www.rpm.org/
 215  - yum           http://yum.baseurl.org/
 216  - febootstrap   http://et.redhat.com/~rjones/febootstrap/
 217
 218
 219 Copyright and license information
 220 ----------------------------------------------------------------------
 221
 222 Copyright (C) 2009 Red Hat Inc.
 223
 224 The library is distributed under the LGPLv2+.  The programs are
 225 distributed under the GPLv2+.  Please see the files COPYING and
 226 COPYING.LIB for full license information.