docs/grml-live.txt

   1 grml-live(8)
   2 ============
   3
   4 Name
   5 ----
   6 grml-live - generate a grml (based) live-cd
   7
   8 Synopsis
   9 --------
  10 grml-live [ todo...]
  11
  12 *******************************************************************************
  13 Important! grml-live is under heavy construction and everything but ready yet.
  14 *******************************************************************************
  15
  16 Introduction
  17 ------------
  18
  19 grml-live provides the build system for creating a grml (based) live-cd.  The
  20 build system is based on link:http://www.informatik.uni-koeln.de/fai/[FAI]
  21 (Fully Automatic Installation). If you are familiar with FAI already it is very
  22 easy to get a live-cd, if you don't know FAI yet don't despair: it's still very
  23 easy. :)
  24
  25 FAI uses a class based system. This gives you the flexibility to choose the
  26 packages you would like to include on your very own live-cd without having to
  27 deal with all the details in the core of the system.
  28
  29 Please notice that you should have a fast network connection as all the Debian
  30 packages will be installed via network. If you want to use a local mirror
  31 checkout
  32 link:http://www.informatik.uni-koeln.de/fai/download/mkdebmirror[mkdebmirror]
  33 and debmirror.
  34
  35 How to get your own live-cd - the easy, fast and simple way
  36 -----------------------------------------------------------
  37
  38 To get a small, Debian-stable and grml based live-cd:
  39
  40   # TARGET="/grml/chroot/grml_uncompressed"
  41   # CDDIR="/grml/chroot/grml_cd"
  42   # grml-live -c GRML -t $TARGET
  43   # mksquashfs $TARGET/* $CDDIR/live/grml.squashfs -noappend
  44   # cd $CDDIR
  45   # mkisofs -V "my personal grml" -l -r -J -no-emul-boot -boot-load-size 4 \
  46             -boot-info-table -c boot/isolinux/boot.cat \
  47             -b boot/isolinux/isolinux.bin -o /grml/grml.iso .
  48
  49 (TODO: provide the contenct of /grml/chroot/grml_cd through the package
  50 grml-live, in the meanwhil get the content from a current grml-ISO)
  51
  52 Files
  53 -----
  54
  55 Notice that grml-live ships FAI configuration files that do not use the same
  56 namespace as the FAI packages itself.  This ensures that grml-live does not
  57 clash with your usual FAI configuration, so instead of /etc/fai/fai.conf
  58 (package fai-client) grml uses /etc/grml/fai/fai.conf instead. For more details
  59 see below. To get an idea how another configuration or example files could look
  60 like check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
  61 fai-doc). /usr/share/doc/fai-doc/fai-guide.html/ch-config.html also provides
  62 documentation regarding configuration possibilities.
  63
  64   /usr/sbin/grml-live
  65
  66 Script for the main build process (being a wrapper around FAI currently).
  67 Requires root permissions for execution.
  68
  69   /etc/grml/fai/fai.conf
  70
  71 Main configuration file which specifies where all the configuration files and
  72 scripts for FAI/grml-live can be found. By default it is
  73 FAI_CONFIGDIR=/etc/grml/fai/config, a directory shipped by grml-live
  74 out-of-the-box so you shouldn't have to configure anything in this file.
  75
  76   /etc/grml/fai/make-fai-nfsroot.conf
  77
  78 TODO
  79
  80   /etc/grml/fai/NFSROOT
  81
  82 TODO
  83
  84   /etc/grml/fai/apt/sources.list
  85
  86 This file specifies which mirrors should be used for retreiving the Debian
  87 packages used for creating the ISO. If you want to use a local mirror you have
  88 to adjust this file.
  89
  90   /etc/grml/fai/config/
  91
  92 The main directory for configuration of FAI/grml-live. More details below.
  93
  94   /etc/grml/fai/config/class/
  95
  96 This directory contains files which specify main configuration variables for the
  97 FAI classes.
  98
  99   /etc/grml/fai/config/debconf/
 100
 101 This directory provides the files for preseeding/configuration of debconf
 102 through files.
 103
 104   /etc/grml/fai/config/hooks/
 105
 106 This directory provides files for customizing the build process through hooks.
 107 Hooks are user defined programs or scripts, which are called during the
 108 installation process.
 109
 110   /etc/grml/fai/config/package_config/
 111
 112 File with lists of software packages to be installed or removed.  The different
 113 classes describe what should find its way to your ISO.  When running 'fai -v -C
 114 /etc/grml/fai -cGRML dirinstall ...' only the files from the directory GRML/
 115 will be taken, if you use 'fai -v -C /etc/grml/fai -cGRML,FOOBAR dirinstall ...'
 116 then the files of GRML/ **plus** the files from FOOBAR/ will be taken. So just
 117 create a new class to adjust it to your needs. Please notice that the directory
 118 GRML contains a package list defining a minimum but still reasonable package
 119 configuration.
 120
 121   /etc/grml/fai/config/scripts/
 122
 123 Scripts for customising the ISO within build process.
 124
 125   /etc/grml/fai/live-initramfs/
 126
 127 This directory provides the files used for building the initramfs/initrd via
 128 live-initramfs(8).
 129
 130 TODO
 131 ----
 132
 133 * provide a wrapper script which runs all the necessary command in a single run
 134 (/usr/sbin/grml-live and /etc/grml/grml-live.conf are work in progress)
 135
 136 * support signed apt repositories
 137
 138 * provide buildprocess for boot/isolinux stuff
 139
 140 * explain and provide configuration for use of NFSROOT
 141
 142 Bugs
 143 ----
 144
 145 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes
 146 link:http://grml.org/contact/[to the grml-team]!
 147
 148 Authors
 149 -------
 150 Michael Prokop <mika@grml.org>.
 151