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 Notes on cross-architecture support
  85 ----------------------------------------------------------------------
  86
  87 At the moment we basically don't support cross-architecture or
  88 32-on-64.  This limits what is possible for some guests.  Filesystem
  89 operations and FTP export will work fine, but running commands in
  90 guests may not be possible.
  91
  92 To enable this requires work for cross-architecture and 32-on-64
  93 support in febootstrap, fakeroot and fakechroot.
  94
  95 The daemon/ directory contains its own configure script.  This is so
  96 that in future we will be able to cross-compile the daemon.
  97
  98
  99 Mirroring tip
 100 ----------------------------------------------------------------------
 101
 102 Having a local Fedora mirror makes a massive difference to the time it
 103 takes to build and rebuild initramfs images.
 104
 105 Failing that, use squid to cache yum downloads, but read this first:
 106 https://lists.dulug.duke.edu/pipermail/yum/2006-August/009041.html
 107 (In brief, because yum chooses random mirrors each time, squid doesn't
 108 work very well with default yum configuration.  To get around this,
 109 choose a Fedora mirror which is close to you, set this with
 110 './configure --with-mirror=[...]', and then proxy the whole lot
 111 through squid by setting http_proxy environment variable).
 112
 113 You will also need to substantially increase the squid configuration
 114 limits:
 115 http://fedoraproject.org/wiki/Using_Mock_to_test_package_builds#Using_Squid_to_Speed_Up_Mock_package_downloads
 116
 117 IntelligentMirror is another possibility, although I couldn't get it
 118 to work for me.
 119
 120
 121 Copyright and license information
 122 ----------------------------------------------------------------------
 123
 124 Copyright (C) 2009 Red Hat Inc.
 125
 126 The library is distributed under the LGPLv2+.  The programs are
 127 distributed under the GPLv2+.  Please see the files COPYING and
 128 COPYING.LIB for full license information.