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 or Java).
  20 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 with vmchannel support
  32
  33 - febootstrap >= 1.5
  34
  35 - XDR, rpcgen
  36
  37 - Augeas (http://augeas.net/)
  38
  39 - perldoc (pod2man, pod2text) to generate the manual pages and
  40 other documentation.
  41
  42 - (Optional) Readline to have nicer command-line editing in guestfish.
  43
  44 - (Optional) OCaml if you want to rebuild the generated files, and
  45 also to build the OCaml bindings
  46
  47 - (Optional) local Fedora mirror
  48
  49 - (Optional) Perl if you want to build the perl bindings
  50
  51 - (Optional) Python if you want to build the python bindings
  52
  53 - (Optional) Ruby, rake if you want to build the ruby bindings
  54
  55 - (Optional) Java, JNI, jpackage-utils if you want to build the java
  56 bindings
  57
  58 Running ./configure will check you have all the requirements installed
  59 on your machine.
  60
  61
  62 Building
  63 ----------------------------------------------------------------------
  64
  65 Then make the daemon, library and root filesystem:
  66
  67   ./configure [--with-mirror=URI]
  68   make
  69
  70 Use the optional --with-mirror parameter to specify the URI of a local
  71 Fedora mirror.  See the discussion of the MIRROR parameter in the
  72 febootstrap(8) manpage.
  73
  74 Finally run the tests:
  75
  76   make check
  77
  78 If everything works, you can install the library and tools by running
  79 these commands as root:
  80
  81   make install
  82
  83
  84 Note on using KVM
  85 ----------------------------------------------------------------------
  86
  87 If you are using x86-64, then by default the configure script will
  88 look for qemu-kvm (KVM support).  You will need a reasonably recent
  89 processor for this to work.  KVM is much faster than using plain QEMU.
  90
  91 You may also need to enable KVM support for non-root users, by following
  92 these instructions:
  93
  94   http://www.linux-kvm.org/page/FAQ#How_can_I_use_kvm_with_a_non-privileged_user.3F
  95
  96 On some systems, this will work too:
  97
  98   chmod o+rw /dev/kvm
  99
 100 On some systems, the chmod will not survive a reboot, and you will
 101 need to make edits to the udev configuration.
 102
 103
 104 Notes on cross-architecture support
 105 ----------------------------------------------------------------------
 106
 107 At the moment we basically don't support cross-architecture or
 108 32-on-64.  This limits what is possible for some guests.  Filesystem
 109 operations and FTP export will work fine, but running commands in
 110 guests may not be possible.
 111
 112 To enable this requires work for cross-architecture and 32-on-64
 113 support in febootstrap, fakeroot and fakechroot.
 114
 115 The daemon/ directory contains its own configure script.  This is so
 116 that in future we will be able to cross-compile the daemon.
 117
 118
 119 Mirroring tip
 120 ----------------------------------------------------------------------
 121
 122 Having a local Fedora mirror makes a massive difference to the time it
 123 takes to build and rebuild initramfs images.
 124
 125 Failing that, use squid to cache yum downloads, but read this first:
 126 https://lists.dulug.duke.edu/pipermail/yum/2006-August/009041.html
 127 (In brief, because yum chooses random mirrors each time, squid doesn't
 128 work very well with default yum configuration.  To get around this,
 129 choose a Fedora mirror which is close to you, set this with
 130 './configure --with-mirror=[...]', and then proxy the whole lot
 131 through squid by setting http_proxy environment variable).
 132
 133 You will also need to substantially increase the squid configuration
 134 limits:
 135 http://fedoraproject.org/wiki/Using_Mock_to_test_package_builds#Using_Squid_to_Speed_Up_Mock_package_downloads
 136
 137 IntelligentMirror is another possibility, although I couldn't get it
 138 to work for me.
 139
 140
 141 Copyright and license information
 142 ----------------------------------------------------------------------
 143
 144 Copyright (C) 2009 Red Hat Inc.
 145
 146 The library is distributed under the LGPLv2+.  The programs are
 147 distributed under the GPLv2+.  Please see the files COPYING and
 148 COPYING.LIB for full license information.