X-Git-Url: http://git.grml.org/?p=grml-live.git;a=blobdiff_plain;f=docs%2Fgrml-live.txt;h=9bb69488886dbd2ffb976c86be0ce2fb1375d886;hp=bc5e67ff0aa5bf41c2da1393b6be6148ba208984;hb=e08881cde5d29236a5992a0a501b43e88d66732d;hpb=e185d67c5e91b61274aa84575dd4d4243005ff95 diff --git a/docs/grml-live.txt b/docs/grml-live.txt index bc5e67f..9bb6948 100644 --- a/docs/grml-live.txt +++ b/docs/grml-live.txt @@ -3,51 +3,113 @@ grml-live(8) Name ---- -grml-live - generate a grml (based) live-cd +grml-live - build process script for generating a (grml based) Linux Live-ISO Synopsis -------- -grml-live [ todo...] +grml-live [-c ] [-t ] [-F] [-h|--help] ******************************************************************************* -Important! grml-live is under heavy construction and everything but ready yet. +Important! grml-live is under heavy construction, your feedback is highly +appreciated. This document is growing as requested. If you have questions which +aren't answered by this document yet please let me (mika@grml.org) know! ******************************************************************************* -Introduction ------------- +Description +----------- -grml-live provides the build system for creating a grml (based) live-cd. The +grml-live provides the build system for creating (a grml based) live-cd. The build system is based on link:http://www.informatik.uni-koeln.de/fai/[FAI] -(Fully Automatic Installation). If you are familiar with FAI already it is very -easy to get a live-cd, if you don't know FAI yet don't despair: it's still very -easy. :) +(Fully Automatic Installation). FAI uses a class based system. This gives you the flexibility to choose the -packages you would like to include on your very own live-cd without having to -deal with all the details in the core of the system. +packages you would like to include on your very own Linux live-cd without having +to deal with all the details of a build process. +CAUTION: grml-live does not use /etc/fai for configuration but instead provides +and uses /etc/grml/fai. This ensures that it does not clash with default FAI +configuration and packages, so you can use grml-live and FAI completely +independent! + +[NOTE] Please notice that you should have a fast network connection as all the Debian packages will be installed via network. If you want to use a local mirror -checkout -link:http://www.informatik.uni-koeln.de/fai/download/mkdebmirror[mkdebmirror] -and debmirror. +(strongly recommended!) checkout +mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror) +debmirro(1) and reprepro(1) (check out +/usr/share/doc/grml-live/examples/reprepro/ for a sample configuration). +To avoid downloading of the base system check out FAI's +NFSROOT (check docs for ../fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz). + +Options +------- + + -c **CLASSES**:: + +Specify the CLASSES to be used for building the ISO via fai. By default only +the classes GRMLBASE and I386 are assumed, resulting in a small base system +(being about ~150MB ISO size). + + -t **TARGET_DIRECTORY**:: + +Output directory of the build process of FAI - being the chroot +used for building the ISO. + + -F:: + +Force execution and do not display summary of configuration details. + + -h|--help:: + +Display short usage information and exit. How to get your own live-cd - the easy, fast and simple way ----------------------------------------------------------- -To get a small, Debian-stable and grml based live-cd: +To get a small, Debian-stable and grml based live-cd using /dev/shm/ +as build and output directory: + + # grml-live + +[NOTE] + +If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually +you have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm" and use +/dev/shm as build and output directory - resulting in very fast build process. +But please be aware of the fact that rebooting your system will result in an +empty /dev/shm, so please another directory for $CHROOT_TARGET, $BUILD_TARGET +and $ISO_TARGET if you plan to create more persistent output. :) + +The class concept +----------------- + +grml-live uses FAI and its class based concept for adjusting configuration +according to your needs. This gives you flexibility and strength without losing +the simplicity in the build process. + +The main and base class provided by grml-live is named GRMLBASE. It's strongly +recommended to **always** use the class GRMLBASE when building an ISO using +grml-live as well as the architecture dependend class (being 'I386' for x86_32 +currently only). The following files and directories are relevant for class GRML +by default: + + /etc/grml/fai/config/scripts/GRMLBASE/ + /etc/grml/fai/config/debconf/GRMLBASE + /etc/grml/fai/config/class/GRMLBASE.var + /etc/grml/fai/config/hooks/instsoft.GRMLBASE + /etc/grml/fai/config/package_config/GRMLBASE + +Take a look at the next section for information about the concept of those +files/directories. - # TARGET="/grml/chroot/grml_uncompressed" - # CDDIR="/grml/chroot/grml_cd" - # grml-live -c GRML -t $TARGET - # mksquashfs $TARGET/* $CDDIR/live/grml.squashfs -noappend - # cd $CDDIR - # mkisofs -V "my personal grml" -l -r -J -no-emul-boot -boot-load-size 4 \ - -boot-info-table -c boot/isolinux/boot.cat \ - -b boot/isolinux/isolinux.bin -o /grml/grml.iso . +If you want to use your own configuration, extend an existing configuration +and/or add additional packages to your ISO just invent a new class. For example +if you want to use your own class named "FOOBAR" just extend CLASSES="GRMLBASE" +inside /etc/grml/grml-live.conf to CLASSES="GRMLBASE,FOOBAR" or invoke grml-live +using the classes option: "grml-live -c GRMLBASE,FOOBAR ...". -(TODO: provide the contenct of /grml/chroot/grml_cd through the package -grml-live, in the meanwhil get the content from a current grml-ISO) +More details regarding the class concept can be found in the documentation of +FAI (available at /usr/share/doc/fai-doc/). Files ----- @@ -75,11 +137,11 @@ out-of-the-box so you shouldn't have to configure anything in this file. /etc/grml/fai/make-fai-nfsroot.conf -TODO +TODO: documentation /etc/grml/fai/NFSROOT -TODO +TODO: documentation /etc/grml/fai/apt/sources.list @@ -111,31 +173,78 @@ installation process. File with lists of software packages to be installed or removed. The different classes describe what should find its way to your ISO. When running 'fai -v -C -/etc/grml/fai -cGRML dirinstall ...' only the files from the directory GRML/ -will be taken, if you use 'fai -v -C /etc/grml/fai -cGRML,FOOBAR dirinstall ...' -then the files of GRML/ **plus** the files from FOOBAR/ will be taken. So just -create a new class to adjust it to your needs. Please notice that the directory -GRML contains a package list defining a minimum but still reasonable package -configuration. +/etc/grml/fai -cGRMLBASE dirinstall ...' only the files from the directory GRML/ +will be taken, if you use 'fai -v -C /etc/grml/fai -cGRMLBASE,FOOBAR dirinstall +...' then the files of GRML/ **plus** the files from FOOBAR/ will be taken. So +just create a new class to adjust it to your needs. Please notice that the +directory GRML contains a package list defining a minimum but still reasonable +package configuration. /etc/grml/fai/config/scripts/ Scripts for customising the ISO within build process. + /etc/grml/fai/files/ + +This directory provides files used inside the scripts of +/etc/grml/fai/config/scripts/*. For a full documentation what happens with the +files please refer to the source of the scripts. + /etc/grml/fai/live-initramfs/ This directory provides the files used for building the initramfs/initrd via live-initramfs(8). -TODO ----- +Requirements for the build system +--------------------------------- + +* any Debian based system should be sufficient (if not please send a bug +report), for example a grml2hd harddisk installation ships all you need + +* enough free disk space; at least 800MB are required for a minimal grml-live +run (\~400MB for the chroot [$CHROOT_TARGET], \~150MB for the build target +[$BUILD_TARGET] and \~150MB for the resulting ISO [$ISO_TARGET] plus some +temporary files) + +* fast network access for retreiving the Debian packages used for creating the +chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far +as possiblbe) + +Known TODOs +----------- + +* do not use /dev/shm/ als default target directory (which one do we want to use +instead?) + +* add support for amd64 [gebi?] + ppc [formorer?] (and identify all packages +that are arch specific so we have a clean package list in all classes) + +* support different grml-flavours through classes right out-of-the-box (being: +grml, grml64, grml-small for at least x86, amd64 and ppc) + +* support setting grml-live configuration on the command line to provide +different flavours using the commandline only + +* really support signed apt repositories (currently it's deactivated via fai's +dirinstall for some packages) + +* explain (and provide configuration for) the use of NFSROOT + +* support setting stuff like ISO name, version,... (especially for stuff inside +x86_files/boot/isolinux) + +* support "final builds" (including stuff like md5sums) + +* use hooks of FAI as far as possible in all grml-live scripts + +* the grml-live class(es) should send output as used inside FAI as well (so it's +not as verbose unless you specify it, make it configurable) -* provide a wrapper script which runs all the necessary command in a single run (/usr/sbin/grml-live and -/etc/grml/grml-live.conf are work in progress) +* provide possibility for cleanup of all created build directories -* provide buildprocess for boot/isolinux stuff +* support hooks to further allow customisation of the build process -* explain and provide configuration for use of NFSROOT +* support nocolor-option for /etc/grml/fai/grml/grml_cleanup_chroot Bugs ---- @@ -147,3 +256,6 @@ Authors ------- Michael Prokop . +///////////////////////////////////// +// vim:ai tw=80 ft=asciidoc expandtab +/////////////////////////////////////