README

   1 Libguestfs is tools and a library for accessing and modifying guest
   2 disk images.  For more information see the home page:
   3
   4   http://libguestfs.org/
   5
   6 For discussion, development, patches, etc. please use the mailing
   7 list:
   8
   9   http://www.redhat.com/mailman/listinfo/libguestfs
  10
  11
  12 Requirements
  13 ----------------------------------------------------------------------
  14
  15 Running ./configure will check you have all the requirements installed
  16 on your machine.
  17
  18 Fedora/RHEL users:
  19
  20   A useful tip is to run:
  21
  22     yum-builddep libguestfs
  23
  24   which will install all build dependencies automatically.  If that is
  25   successful, you don't need to bother with the rest of this section.
  26
  27 Debian/Ubuntu users:
  28
  29   Take a look at the debian/control file and install everything listed
  30   in "Build-Depends".  If that is successful, you don't need to bother
  31   with the rest of this section.
  32
  33 The full requirements are described below.
  34
  35 For basic functionality and the C tools:
  36
  37 - look at appliance/packagelist.in and install as many of the packages
  38   that apply to your distro as possible
  39
  40 - recent QEMU >= 0.13 (0.14 or later is better) with virtio-serial support
  41
  42 - kernel >= 2.6.34 with virtio-serial support enabled.
  43
  44 - virtio-block and virtio-net drivers should be compiled into your
  45   host kernel (strictly speaking this is optional, but you will have
  46   to make complex changes to the ./configure command line to get it
  47   to work if you don't have virtio)
  48
  49 - febootstrap >= 3.3 (it is best to use the latest version)
  50
  51   Notes: (1) febootstrap 2.x WILL NOT WORK
  52          (2) febootstrap 3.x is distro-independent, and is required on
  53              Debian and other distros as well as Fedora
  54
  55 - XDR, rpcgen (on Linux these are provided by glibc)
  56
  57 - cpio
  58
  59 - gperf
  60
  61 - genisoimage (NOT mkisofs any more)
  62
  63 - hivex >= 1.2.7 (http://libguestfs.org/download) (optional)
  64
  65 - pcre (Perl Compatible Regular Expressions C library) (optional)
  66
  67 - libmagic (the library that corresponds to the 'file' command) (optional)
  68
  69 - libvirt (optional)
  70
  71 - libxml2 (optional)
  72
  73 - libconfig (optional)
  74
  75 - augeas >= 0.5.0 (http://augeas.net/) (optional)
  76
  77 - Berkeley DB 'db_dump' and 'db_load' utilities
  78   (db4-utils or db4.X-util or similar) (optional)
  79
  80 - perldoc (pod2man, pod2text, pod2html) to generate the manual pages
  81   and other documentation.
  82
  83 - Readline to have nicer command-line editing in guestfish (optional)
  84
  85 - xmllint (part of libxml2) to validate virt-inspector
  86   RELAX NG schema (optional)
  87
  88 - OCaml if you want to rebuild the generated files, and
  89   also to build the OCaml bindings (optional)
  90
  91 - po4a for translating manpages and POD files.
  92   This is optional when compiling from the tarball, but mandatory
  93   if you compile from git.
  94
  95 - getfacl, getfattr libraries and programs (optional)
  96
  97 To build FUSE support (guestmount):
  98
  99 - FUSE libraries and kernel module (optional)
 100
 101 To build virt-resize:
 102
 103 - OCaml PCRE bindings (ocaml-pcre) (optional)
 104
 105 To build language bindings:
 106
 107 - Perl if you want to build the perl bindings (optional)
 108
 109 - Python if you want to build the python bindings (optional)
 110
 111 - Ruby, rake if you want to build the ruby bindings (optional)
 112
 113 - Java, JNI, jpackage-utils if you want to build the java
 114   bindings (optional)
 115
 116 - GHC if you want to build the Haskell bindings (optional)
 117
 118 - PHP, phpize if you want to build the PHP bindings (optional)
 119
 120 To build the Perl tools:
 121
 122 - Perl Sys::Virt module (optional)
 123
 124 - Perl Win::Hivex module (optional)
 125
 126 - Perl Pod::Usage module (optional)
 127
 128 - Perl Test::More module (from perl Test::Simple) (optional)
 129
 130 - Perl String::ShellQuote module (optional)
 131
 132 - perl-libintl for translating perl code (optional)
 133
 134
 135 Building
 136 ----------------------------------------------------------------------
 137
 138 Then make the daemon, library and root filesystem:
 139
 140   ./configure
 141   make
 142
 143 Finally run the tests:
 144
 145   make check
 146
 147 If everything works, you can install the library and tools by running
 148 this command as root:
 149
 150   make install
 151
 152 You can run guestfish, guestmount and the virt tools without needing
 153 to install, using the "run" script in the top directory.  This script
 154 sets up some environment variables.  For example:
 155
 156   ./run ./fish/guestfish [usual guestfish args ...]
 157
 158   ./run ./inspector/virt-inspector [usual virt-inspector args ...]
 159
 160 If you are already in the fish/ subdirectory, then the following
 161 command will also work:
 162
 163   ../run ./guestfish [...]
 164
 165 You can also make a symlink (note: NOT a hard link) from your $PATH to
 166 the run script, eg:
 167
 168   cd ~/bin
 169   ln -s ~/libguestfs/run libguestfs-run
 170   cd ~/libguestfs
 171   libguestfs-run ./inspector/virt-inspector [...]
 172
 173 You can also run the C programs under valgrind like this:
 174
 175   ./run valgrind [valgrind opts...] ./cat/virt-cat [virt-cat opts...]
 176
 177 This also works with sudo (eg. if you need root access for libvirt or
 178 to access a block device):
 179
 180   sudo ./run ./cat/virt-cat -d LinuxGuest /etc/passwd
 181
 182
 183 qemu
 184 ----------------------------------------------------------------------
 185
 186 By far the most common problem is with broken or incompatible
 187 qemu releases.
 188
 189 Different versions of qemu have problems booting the appliance for
 190 different reasons.  This varies between versions of qemu, and Linux
 191 distributions which add their own patches.
 192
 193 If you find a problem, you could try using your own qemu built from
 194 source (qemu is very easy to build from source), with a 'qemu
 195 wrapper'.  Qemu wrappers are described in the guestfs(3) manpage.
 196
 197
 198 Note on using KVM
 199 ----------------------------------------------------------------------
 200
 201 By default the configure script will look for qemu-kvm (KVM support).
 202 You will need a reasonably recent processor for this to work.  KVM is
 203 much faster than using plain Qemu.
 204
 205 You may also need to enable KVM support for non-root users, by following
 206 these instructions:
 207
 208   http://www.linux-kvm.org/page/FAQ#How_can_I_use_kvm_with_a_non-privileged_user.3F
 209
 210 On some systems, this will work too:
 211
 212   chmod o+rw /dev/kvm
 213
 214 On some systems, the chmod will not survive a reboot, and you will
 215 need to make edits to the udev configuration.
 216
 217
 218 Mirroring tip
 219 ----------------------------------------------------------------------
 220
 221 On my machines I can usually rebuild the appliance in around 3
 222 minutes.  If it takes much longer for you, use a local distro mirror
 223 or squid.
 224
 225 To use squid to cache yum downloads, read this first:
 226 https://lists.dulug.duke.edu/pipermail/yum/2006-August/009041.html
 227 (In brief, because yum chooses random mirrors each time, squid doesn't
 228 work very well with default yum configuration.  To get around this,
 229 choose a Fedora mirror which is close to you, set this with
 230 './configure --with-mirror=[...]', and then proxy the whole lot
 231 through squid by setting http_proxy environment variable).
 232
 233 You will also need to substantially increase the squid configuration
 234 limits:
 235 http://fedoraproject.org/wiki/Using_Mock_to_test_package_builds#Using_Squid_to_Speed_Up_Mock_package_downloads
 236
 237
 238 Porting to other Linux distros / non-Linux
 239 ----------------------------------------------------------------------
 240
 241 libguestfs itself should be fairly portable to other Linux
 242 distributions.  Non-Linux ports are trickier, but we will accept
 243 patches if they aren't too invasive.
 244
 245 The main porting issues are with the dependencies needed to build the
 246 appliance.  You will need to port the febootstrap first
 247 (http://people.redhat.com/~rjones/febootstrap/).
 248
 249
 250 Copyright and license information
 251 ----------------------------------------------------------------------
 252
 253 Copyright (C) 2009-2011 Red Hat Inc.
 254
 255 The library is distributed under the LGPLv2+.  The programs are
 256 distributed under the GPLv2+.  Please see the files COPYING and
 257 COPYING.LIB for full license information.