7 grml-live - build framework based on FAI for generating a grml and Debian based
8 Linux Live system (CD/ISO)
13 grml-live [-a <architecture>] [-c <classe[s]>] [-g <grml_name>] [-i <iso_name> ]
14 [-o <output_directory>] [-r <release_name>] [-s <suite>] [-t
15 <template_directory>] [-v <version_number>] [-FVhu]
17 *******************************************************************************
18 Important! This document is growing as requested. If you have questions which
19 aren't answered by this document yet please let me know: <mika@grml.org>!
20 This document currently applies to grml-live version 0.0.10.
21 *******************************************************************************
26 grml-live provides the build system for creating a grml and Debian based Linux
27 Live-CD. The build system is based on
28 link:http://www.informatik.uni-koeln.de/fai/[FAI] (Fully Automatic
29 Installation). grml-live uses the "fai dirinstall" feature to generate a chroot
30 system based on the class concept of FAI (see later sections for further
31 details) and provides the framework to be able to generate a full-featured ISO.
32 It does not use all the FAI features by default though and you don't have to
33 know FAI to be able to use it.
35 The use of FAI gives you the flexibility to choose the packages you would like
36 to include on your very own Linux Live-CD without having to deal with all the
37 details of a build process.
39 CAUTION: grml-live does **not** use /etc/fai for configuration but instead
40 provides and uses /etc/grml/fai. This ensures that it does not clash with
41 default FAI configuration and packages, so you can use grml-live and FAI
42 completely independent at the same time!
46 Please notice that you should have a fast network connection as all the Debian
47 packages will be downloaded and installed via network. If you want to use a
48 local mirror (strongly recommended if you plan to use grml-live more than once)
49 checkout mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror),
50 debmirror(1), reprepro(1) (see /usr/share/doc/grml-live/examples/reprepro/ for a
51 sample configuration), apt-cacher(1) and approx(8). To avoid downloading the
52 base system again and again check out FAI's NFSROOT (see FAQ of this document
60 Use the specified architecture instead of the currently running one. This
61 allows building a 32bit system on a 64bit host. Please notice that real
62 crosscompiling (like building a ppc system on x86) isn't possible due to the
63 nature and the need of working in a chroot.
67 Specify the CLASSES to be used for building the ISO via FAI. By default only
68 the classes GRMLBASE, GRML_SMALL and I386 are assumed, resulting in a small base
69 system (being about ~150MB total ISO size). If using a non-I386 system (like
70 amd64) you should specify the appropriate architecture as well. Additionally you
71 can specify a class providing a grml-kernel (see
72 /etc/grml/fai/config/package_config/ for a full list). So instead of GRML_SMALL
73 you can also use GRML_MEDIUM and GRML_FULL instead.
75 -C **CONFIGURATION_FILE**::
77 The specified file is used as configuration file for grml-live. By default
78 /etc/grml/grml-live.conf is used for main configuration. If a file named
79 /etc/grml/grml-live.local exists it is used as well (sourced after reading
80 /etc/grml/grml-live.conf to allow overriding settings). As a last option the
81 specified configuration file is sourced so it is possible to override settings
82 of /etc/grml/grml-live.conf as well as of /etc/grml/grml-live.local. Please
83 notice that all configuration files have to be adjusted during execution of
84 grml-live, so please make sure you use /etc/grml/grml-live.conf as a base for
85 your own configuration file. Please also notice that the configuration file
86 specified via this option is **not** (yet) supported inside the
87 scripts/hooks/classes at /etc/grml/fai/config. Instead use
88 /etc/grml/grml-live.conf and/or /etc/grml/grml-live.local for configuration
89 stuff used inside /etc/grml/fai/config.
93 Force execution and do not prompt for acknowledgment of configuration.
97 Set the grml flavour name. Common usage examples: grml, grml-small, grml64.
101 Display short usage information and exit.
105 Specify name of ISO which will be available inside $OUTPUT_DIRECTORY/grml_isos
108 -o **OUTPUT_DIRECTORY**::
110 Main output directory of the build process of FAI. Some directories are created
111 inside this target directory, being: grml_cd (where the files for creating the
112 ISO are located, including the compressed squashfs file), grml_chroot (the
113 chroot system) and grml_isos (where the resulting ISO is stored).
117 Specify name of the release.
121 Specify the Debian suite you want to use for your live-system. Defaults to
122 "etch" (being current Debian/stable). Supported values are: etch, lenny, sid.
124 -t **TEMPLATE_DIRECTORY**::
126 Specify place of the templates used for building the ISO. By default
127 (and if not manually specified) this is /usr/share/grml-live/templates/.
131 Update existing chroot instead of rebuilding it from scratch. This option is
132 based on the softupdate feature of FAI.
134 -v **VERSION_NUMBER**::
136 Specify version number of the release.
140 Increase verbosity in the build process.
145 To get a small, Debian-stable and grml-based Live-CD using /grml/grml-live
146 as build and output directory just run:
150 To get a small Debian-unstable and grml-small based Live-CD using
151 /home/mika/grml-live as build and output directory just use:
153 # grml-live -c GRMLBASE,GRML_SMALL,I386 -o /home/mika/grml-live
155 To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and
156 output directory and use grml_0.0-3.iso as ISO name (placed inside
157 /tmp/grml_isos) just invoke:
159 # grml-live -o /tmp -c GRMLBASE,GRML_SMALL,I386 -s sid -i grml_0.0-3.iso
163 If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
164 you should have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm"
165 and use /dev/shm as build and output directory - resulting in very fast build
166 process. But please be aware of the fact that rebooting your system will result
167 in an empty /dev/shm, so please another directory for $CHROOT_OUTPUT,
168 $BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)
170 Main features of grml-live
171 --------------------------
173 * create a grml-/Debian-based Linux Live-CD with one single command
175 * class based concept, providing a maximum of flexibility
177 * supports integration of own hooks, scripts and configuration
179 * supports use and integration of own Software and/or Kernels via simple use of
182 * native support of FAI features
184 * multi-arch support (work in progress)
189 grml-live uses FAI and its class based concept for adjusting configuration and
190 setup according to your needs. This gives you flexibility and strength without
191 losing the simplicity in the build process.
193 The main and base class provided by grml-live is named GRMLBASE. It's strongly
194 recommended to **always** use the class GRMLBASE when building an ISO using
195 grml-live, as well as the architecture dependent class which provides the kernel
196 (being 'I386' for x86_32 and 'AMD64' for x86_64) and a GRML_* class (like
197 GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are
198 relevant for class GRMLBASE by default:
200 /etc/grml/fai/config/scripts/GRMLBASE/
201 /etc/grml/fai/config/debconf/GRMLBASE
202 /etc/grml/fai/config/class/GRMLBASE.var
203 /etc/grml/fai/config/hooks/instsoft.GRMLBASE
204 /etc/grml/fai/config/package_config/GRMLBASE
206 Take a look at the next section for information about the concept of those
209 If you want to use your own configuration, extend an existing configuration
210 and/or add additional packages to your ISO just invent a new class (or extend an
211 existing one). For example if you want to use your own class named "FOOBAR" just
212 extend CLASSES="GRMLBASE,GRML_SMALL,I386" inside /etc/grml/grml-live.conf to
213 CLASSES="GRMLBASE,GRML_SMALL,I386,FOOBAR" or invoke grml-live using the classes
214 option: "grml-live -c GRMLBASE,GRML_SMALL,I386,FOOBAR ...".
216 More details regarding the class concept can be found in the documentation of
217 FAI itself (being available at /usr/share/doc/fai-doc/).
222 Documentation to be done...
227 Notice that grml-live ships FAI configuration files that do not use the same
228 namespace as the FAI packages itself. This ensures that grml-live does not clash
229 with your usual FAI configuration, so instead of /etc/fai/fai.conf (package
230 fai-client) grml uses /etc/grml/fai/fai.conf instead. For more details see
231 below. To get an idea how another configuration or example files could look like
232 check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
233 fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html
234 provides documentation regarding configuration possibilities.
238 Script for the main build process. Requires root permissions for execution.
240 /etc/grml/grml-live.conf
242 Main configuration file for grml-live. All the important steps can be configured
245 /etc/grml/fai/fai.conf
247 Main configuration file for FAI which specifies where all the configuration
248 files and scripts for FAI/grml-live can be found. By default it is set to
249 FAI_CONFIGDIR=/etc/grml/fai/config, a directory shipped by grml-live
250 out-of-the-box so you shouldn't have to configure anything in this file.
252 /etc/grml/fai/make-fai-nfsroot.conf
254 This file is used by make-fai-nfsroot(8) only. Usually you don't have to change
255 anything inside this file. If you want to modify NFSROOT though you can adjust
258 /etc/grml/fai/NFSROOT
260 This file specifies the package list for creating the NFSROOT.
262 /etc/grml/fai/apt/sources.list
264 This file specifies which mirrors should be used for retreiving the Debian
265 packages used for creating the main chroot (including all the software you would
266 like to see included). If you want to use a local mirror you either have to
267 adjust this file or use the GRML_LIVE_SOURCES variable inside
268 /etc/grml/grml-live.conf which modifies /etc/grml/fai/apt/sources.list
271 /etc/grml/fai/config/
273 The main directory for configuration of FAI/grml-live. More details below.
275 /etc/grml/fai/config/class/
277 This directory contains files which specify main configuration variables for the
280 /etc/grml/fai/config/debconf/
282 This directory provides the files for preseeding/configuration of debconf
285 /etc/grml/fai/config/hooks/
287 This directory provides files for customising the build process through hooks.
288 Hooks are user defined programs or scripts, which are called during the
289 installation process.
291 /etc/grml/fai/config/package_config/
293 Directory with lists of software packages to be installed or removed. The
294 different classes describe what should find its way to your ISO. When running
295 "grml-live -c GRMLBASE,GRML_SMALL,I386 ..." only the configuration of GRMLBASE,
296 GRML_SMALL and and I386 will be taken. If you use 'grml-live -c
297 GRMLBASE,GRML_SMALL,I386,FOOBAR ...' then the files of GRMLBASE, GRML_SMALL,
298 I386 **plus** the files from FOOBAR will be taken. So just create a new class to
299 adjust the package selection according to your needs. Please notice that the
300 directory GRMLBASE contains a package list defining a minimum but still
301 reasonable package configuration.
303 /etc/grml/fai/config/scripts/
305 Scripts for customising the ISO within the build process.
309 This directory provides files used inside the scripts of
310 /etc/grml/fai/config/scripts/*. For a full documentation what happens with the
311 files please refer to the source of the scripts.
313 /etc/grml/fai/live-initramfs/
315 This directory provides the files used for building the initramfs/initrd via
321 grml-live itself logs to /var/log/grml-live.log. Unless you set ZERO_LOGFILE in
322 /etc/grml/grml-live.conf the output is appended to the file. If you set the
323 ZERO_LOGFILE configuration option the logfile will be truncated on each new
324 invocation of grml-live.
326 The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the
327 default being /var/log/fai/grml/.
329 If you are using the grml-live buildd you will find the logs of the grml-live
330 run at /var/log/grml-buildd.stdout and /var/log/grml-buildd.stderr.
332 Requirements for the build system
333 ---------------------------------
335 * any Debian based system should be sufficient (if not it's a bug, so please
336 send us a bug report then) [a usual link:http://grml.org/grml2hd/[grml2hd]
337 harddisk installation ships all you need]
339 * enough free disk space; at least 800MB are required for a minimal grml-live
340 run (\~400MB for the chroot [$CHROOT_OUTPUT], \~150MB for the build target
341 [$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some
342 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
343 total free disk space
345 * fast network access for retreiving the Debian packages used for creating the
346 chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
352 Help, I'm using Debian etch and I don't have FAI version >3.2
353 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
355 wget http://www.informatik.uni-koeln.de/fai/download/etch/fai-client_3.2.3_all.deb \
356 http://www.informatik.uni-koeln.de/fai/download/etch/fai-server_3.2.3_all.deb \
357 http://www.informatik.uni-koeln.de/fai/download/etch/fai-doc_3.2.3_all.deb
358 dpkg -i fai-client_3.2.3_all.deb fai-server_3.2.3_all.deb fai-doc_3.2.3_all.deb
360 or check out the link:http://www.informatik.uni-koeln.de/fai/[FAI-homepage] for
363 I've problems with the build process. How to start debugging?
364 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
366 Check out the logs inside /var/log/fai/... If you don't have the time to debug
367 the problem in further detail or don't know how to proceed just send a copy of
368 your config, logs and the commandline with a short problem description to
371 # history | grep grml-live > /etc/grml/grml_live.cmdline
372 # tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \
373 /etc/grml/grml-buildd.conf /var/log/fai /etc/grml/fai
375 Can I use my own (local) Debian mirror?
376 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
378 Sure. Just adjust the variables GRML_LIVE_SOURCES and FAI_DEBOOTSTRAP (if not
379 already using NFSROOT's base.tgz) inside /etc/grml/grml-live.conf according to
380 your needs. Please don't forget that you should use the grml servers as well
381 (see default configuration) so all the grml packages can be downloaded as well.
383 If you want to use a local (for example NFS mount) mirror additionally, just
384 adjust MIRROR_DIRECTORY and MIRROR_SOURCES inside /etc/grml/grml-live.conf as
387 Unless you specify GRML_LIVE_SOURCES and/or FAI_DEBOOTSTRAP the default from
388 /etc/grml/fai/apt/sources.list and /etc/grml/fai/make-fai-nfsroot.conf will be
389 taken. If you customise the variables in /etc/grml/grml-live.conf then the two
390 files will be adjusted during runtime automatically.
392 If MIRROR_DIRECTORY and MIRROR_SOURCES are specified the local mirror will be
393 taken as first entry in the generated sources.list so it's prefered over
394 non-local mirrors. Using a fallback mirror (via providing several mirrors in
395 GRML_LIVE_SOURCES as used by default) is a recommended setting.
397 How do I add additional Debian package(s) to my CD/ISO?
398 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
400 Just create a new class (using the package_config directory):
402 # cat > /etc/grml/fai/config/package_config/MIKA << EOF
406 another_name_of_a_debian_package
410 and specify it when invoking grml-live then:
412 # grml-live -c GRMLBASE,GRML_SMALL,I386,MIKA
414 I fscked up my grml-live configuration. How do I reset it to the defaults?
415 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
417 Notice: this deletes all your grml-live configuration files. If that's really
418 what you are searching for just run:
420 rm -rf /etc/grml/fai /etc/grml/grml-live.conf
421 dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb
425 If you don't control your /etc using a version control system (VCS) yet it's a
426 good chance to start using it now. Check out
427 link:http://michael-prokop.at/blog/2007/03/14/maintain-etc-with-mercurial-on-debian/[http://michael-prokop.at/blog/2007/03/14/maintain-etc-with-mercurial-on-debian/]
428 for more details how to maintain /etc using the mercurial VCS.
430 How do I create a base.tgz for use as NFSROOT?
431 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
433 First of all build the chroot system:
435 mkdir /tmp/nfsroot && cd /tmp/nfsroot
436 debootstrap etch /tmp/nfsroot/ http://ftp.de.debian.org/debian
439 Then check out where your NFSROOT is located:
441 # grep '^NFSROOT' /etc/grml/fai/make-fai-nfsroot.conf
442 NFSROOT=/grml/fai/nfsroot
444 So as /grml/fai/nfsroot is your NFSROOT place the file under
445 /grml/fai/nfsroot/live/filesystem.dir/var/tmp/:
447 mv base.tgz /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
449 or even better use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz instead.
450 Use I386 as $CLASSNAME for i386 builds and AMD64 for amd64 builds.
452 Now running "grml-live ..." will use this file as main system instead of
453 executing debootstrap. Check out the output for the following lines if using
457 Calling task_extrbase
458 Unpacking Debian base archive
459 Extracting /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
463 or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:
466 ftar: extracting /etc/grml/fai/config/basefiles///AMD64.tar.gz to
467 /grml-live/grml-live_20071029.22138/grml_chroot//
470 Set up apt-cacher for use with grml-live
471 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
473 Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and
476 # cat /etc/grml/grml-live.conf
479 deb http://localhost:3142/deb.grml.org grml-stable main
480 deb http://localhost:3142/deb.grml.org grml-testing main
481 deb http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free
484 FAI_DEBOOTSTRAP="etch http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free"
486 Make sure apt-cacher is running (/etc/init.d/apt-cacher restart). That's it.
487 All downloaded files will be cached in /var/cache/apt-cacher/ now.
489 Set up approx for use with grml-live
490 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
492 Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and
495 # cat /etc/grml/grml-live.conf
498 deb http://localhost:9999/grml grml-stable main
499 deb http://localhost:9999/grml grml-testing main
500 deb http://localhost:9999/debian etch main contrib non-free
502 FAI_DEBOOTSTRAP="etch http://localhost:9999/debian"
506 # cat /etc/approx/approx.conf
508 debian http://ftp.at.debian.org/debian
509 grml http://deb.grml.org/
511 Don't forget to restart approx (/etc/init.d/approx restart). That's it.
512 All downloaded files will be cached in /var/cache/approx now.
514 I've a question which isn't answered by this document
515 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
517 Don't hesitate to ask on IRC (channel #grml on irc.freenode.org) or just drop me
518 a mail: <mika@grml.org>
520 Download / install grml-live as a Debian package
521 ------------------------------------------------
523 Debian packages are available through the grml-repository at
524 link:http://deb.grml.org/pool/main/g/grml-live/[deb.grml.org]. If you want to
525 build a Debian package on your own (using for example a specific version or the
526 current development tree), just execute:
528 hg clone http://hg.grml.org/grml-live
535 The source of grml-live is available at
536 link:http://hg.grml.org/grml-live/[http://hg.grml.org/grml-live/]
541 Check out link:http://wiki.grml.org/doku.php?id=grml-live[grml-live@grml-wiki]
547 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes
548 link:http://grml.org/contact/[to the grml-team]!
552 Michael Prokop <mika@grml.org>.
554 /////////////////////////////////////
555 // vim:ai tw=80 ft=asciidoc expandtab
556 /////////////////////////////////////