summaryrefslogtreecommitdiffstats
path: root/README
diff options
context:
space:
mode:
authorRichard W.M. Jones <rjones@redhat.com>2010-12-03 13:17:00 +0000
committerRichard W.M. Jones <rjones@redhat.com>2010-12-05 09:33:25 +0000
commit66a9d53e48f14d7fe1d9f4b801a1c5582d83efa6 (patch)
tree555e29f52452cd88a6deb086b86bb55ab85f5fff /README
parent304ee3695e41904d8b2184922732f47aa6ccc0d4 (diff)
downloadfebootstrap-66a9d53e48f14d7fe1d9f4b801a1c5582d83efa6.tar.gz
febootstrap-66a9d53e48f14d7fe1d9f4b801a1c5582d83efa6.tar.xz
febootstrap-66a9d53e48f14d7fe1d9f4b801a1c5582d83efa6.zip
Rewrite febootstrap as a general supermin appliance building tool.3.0
This complete rewrite of the building tools turns febootstrap into a general purpose, cross-distro, supermin appliance only build tool. There is now only one program 'febootstrap' which is used to build a supermin appliance from a list of packages. Normal appliances are not supported. The tools are incompatible with febootstrap 2.x (use the febootstrap-2.x branch from git to get the old package).
Diffstat (limited to 'README')
-rw-r--r--README83
1 files changed, 28 insertions, 55 deletions
diff --git a/README b/README
index 5383dcb..ee28067 100644
--- a/README
+++ b/README
@@ -1,32 +1,29 @@
-febootstrap - Bootstrap a basic Fedora system
+febootstrap - Bootstrapping tool for creating supermin appliances
by Richard W.M. Jones (rjones@redhat.com)
http://people.redhat.com/~rjones/febootstrap
----------------------------------------------------------------------
-febootstrap is a Fedora equivalent to Debian's debootstrap. You can
-use it to create a basic Fedora filesystem.
+febootstrap is a tool for building supermin appliances. These are
+tiny appliances [similar to virtual machines], usually around 100KB in
+size, which get fully instantiated on-the-fly in a fraction of a
+second when you need to boot one of them.
-There are currently some restrictions compared to debootstrap.
+A complete description is in the febootstrap(8) man page.
-For instructions, restrictions, examples etc. please read the manpage
-febootstrap(8).
+IMPORTANT NOTE FOR USERS OF FEBOOTSTRAP 2.x:
+ febootstrap 3.x is a complete rewrite. febootstrap 2.x could only
+ build Fedora distributions. This version can build many varieties
+ of Linux distros. 3.x only builds supermin appliances, it does not
+ build chroots. 3.x does not build cross-distro, cross-release or
+ cross-architecture systems. If you want febootstrap 2.x, please use
+ the 'febootstrap-2.x' branch from the git repository.
Requirements
------------
- fakeroot
- - Tested with version 1.11.
+ ocaml
- fakechroot >= 2.9 or 2.8 + patch
- - **** NB. KNOWN NOT TO WORK WITH 2.8 ***** You MUST apply
- the patch 'fakechroot-2.8-relchroot.patch' to the fakechroot
- sources and recompile. Hopefully this patch will be included
- in future versions of fakechroot.
-
- yum
- - Tested with version 3.2 (works best with 3.2.21 or above)
- - Needs network access to a Fedora repository, or a local
- Fedora mirror.
+ ocaml findlib ("ocamlfind" program)
perldoc
- This is just used to generate the manpage.
@@ -36,12 +33,21 @@ Requirements
gcc
qemu
- - If you want to test-run your systems.
+ - Only if you need to test-boot appliances.
libext2fs
/sbin/mke2fs
- These are part of e2fsprogs.
+Optional
+--------
+(but you will need a package manager for your Linux distro)
+
+ yum
+ rpm
+ apt-get
+ dpkg
+
Building and installing
-----------------------
@@ -49,42 +55,9 @@ Building and installing
make
sudo make install
-Note, if you want to run the scripts locally without installing,
-you have to set the $PATH to the current directory, ie:
-
- PATH=$(pwd):$PATH
- febootstrap [...]
-
-Debugging
----------
-
-If you get segfaults while running febootstrap or errors in the %post
-scripts, these are often caused by some incompatibility in the
-emulation provided by fakeroot/fakechroot. You can track them down by
-running the yum command explicitly. Try:
-
- fakeroot fakechroot -s \
- yum -y -c /tmp/repo \
- --disablerepo=\* --enablerepo=febootstrap \
- --noplugins --nogpgcheck \
- --installroot=/tmp/root \
- install "@Core"
-
-where /tmp/repo would be a file like this (change repo and arch
-parameters as appropriate):
-
- [febootstrap]
- name=febootstrap
- failovermethod=priority
- enabled=1
- gpgcheck=0
- mirrorlist=http://mirrors.fedoraproject.org/mirrorlist?repo=rawhide&arch=x86_64
-
-You can insert gdb in the appropriate place in the fakeroot /
-fakechroot / yum command.
-
Feedback and bugs
-----------------
-Send feedback to rjones@redhat.com. You can file bugs in
-http://bugzilla.redhat.com/
+Send feedback to libguestfs@redhat.com. You can file bugs in
+https://bugzilla.redhat.com/ (under "Fedora", "febootstrap")
+