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]>] [-C <configfile>] [-g
14 <grml_name>] [-i <iso_name> ] [-o <output_directory>] [-r <release_name>] [-s
15 <suite>] [-t <template_directory>] [-v <version_number>] [-U <username>] [
18 CAUTION: Please check out <<current_state,the 'Current state of grml-live with
19 squashfs-tools and kernel' section>> for details about current state of involved
20 tools before starting with grml-live or if you encounter any problems.
25 grml-live provides the build system for creating a grml and Debian based Linux
26 Live-CD. The build system is based on
27 link:http://fai-project.org/[FAI] (Fully Automatic
28 Installation). grml-live uses the "fai dirinstall" feature to generate a chroot
29 system based on the class concept of FAI (see later sections for further
30 details) and provides the framework to be able to generate a full-featured ISO.
31 It does not use all the FAI features by default though and you don't have to
32 know FAI to be able to use it.
34 The use of FAI gives you the flexibility to choose the packages you would like
35 to include on your very own Linux Live-CD without having to deal with all the
36 details of a build process.
38 CAUTION: grml-live does **not** use /etc/fai for configuration but instead
39 provides and uses ${GRML_FAI_CONFIG} which is pointing to /etc/grml/fai by default
40 (unless overriden using the ''-D'' option). This ensures that it does not clash
41 with 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 Clean up output directories before attempting the build. Packs the chroot
61 into a tar archive, and removes chroot and iso build directories before exiting.
65 Use the specified architecture instead of the currently running one. This
66 allows building a 32bit system on a 64bit host (though you can't build a 64bit
67 system on a 32bit system/kernel of course). Please notice that real
68 crosscompiling (like building a ppc system on x86) isn't possible due to the
69 nature and the need of working in a chroot. Currently supported values: i386
74 Build the ISO without updating the chroot via FAI. This option is useful for
75 example when working on stable releases: if you have a working base
76 system/chroot and do not want to execute any further updates (via "-u" option)
77 but intend to only build the ISO.
81 Build the ISO without touching the chroot at all. This option is useful if
82 you modified anything that FAI or grml-live might adjust via grml's FAI
83 scripts. It's like the '-b' option but even more advanced. Use only if you
84 really know that you do not want to update the chroot.
88 Specify the CLASSES to be used for building the ISO via FAI. By default only
89 the classes GRMLBASE, GRML_FULL and I386/AMD64 (depending on system
90 architecture) are assumed, resulting in a small base system (being about ~180MB
91 total ISO size). If using a non-I386 system (like AMD64) you should specify the
92 appropriate architecture as well. Additionally you can specify a class providing
93 a grml-kernel (see <<classes,the 'CLASSES' section in this document>> for
94 details about available classes). So instead of GRML_FULL you can also use
95 GRML_SMALL and GRML_FULL.
98 All class names should be written in uppercase letters. Do not use a dash, use
99 an underscore. So do not use "amd64" but "AMD64", do not use "FOO BAR" but
103 -C **CONFIGURATION_FILE**::
105 The specified file is used as configuration file for grml-live. By default
106 /etc/grml/grml-live.conf is used as default configuration. If a file named
107 /etc/grml/grml-live.local exists it is used as well (sourced after reading
108 /etc/grml/grml-live.conf meant as main file for local configuration). As a last
109 option the specified configuration file is sourced so it is possible to override
110 settings of /etc/grml/grml-live.conf as well as of /etc/grml/grml-live.local.
111 Please notice that all configuration files have to be adjusted during execution
112 of grml-live, so please make sure you use /etc/grml/grml-live.conf as a base for
113 your own configuration file (usually /etc/grml/grml-live.local). Please also
114 notice that the configuration file specified via this option is **not** (yet)
115 supported inside the scripts/hooks/classes at ${GRML_FAI_CONFIG}/config. Instead use
116 /etc/grml/grml-live.local for configuration stuff used inside
117 ${GRML_FAI_CONFIG}/config.
121 Use specified date as build date information on the ISO instead of the default.
122 The default is the date when grml-live is being executed (retrieved via
123 executing 'date +%Y-%m-%d'). The information is stored inside the file
124 /GRML/grml-version on the ISO, /etc/grml_version in the squashfs file and in all
125 the bootsplash related files. This option is useful if you want to provide an
126 ISO with release information for a specific date but have to build it in
127 advance. Usage example: '-d 2009-10-30'
129 -D **CONFIGURATION_DIRECTORY**::
131 The specified directory is used as configuration directory for grml-live and its
132 FAI. By default /etc/grml/fai is used as default configuration directory. If
133 you want to have different configuration scripts, package definitions, etc. with
134 without messing with the global configuration under /etc/grml/fai provided by
135 grml-live this option provides you the option to use your own configuration
136 directory. This directory is what's being referred to as ${GRML_FAI_CONFIG}
137 throughout this documentation.
141 Force execution and do not prompt for acknowledgment of configuration.
145 Set the grml flavour name. Common usage examples: grml, grml-small, grml64.
146 Please do NOT use blanks and any special characters like '/', ';' inside
147 GRML_NAME, otherwise you might notice problems while booting.
151 Display short usage information and exit.
155 Specify name of ISO which will be available inside $OUTPUT_DIRECTORY/grml_isos
158 -I **CHROOT_INSTALL**::
160 Specify name of source directory which provides files that should become part of
161 the chroot/ISO. Not enabled by default. Note: the files are installed under '/'
162 in the chroot so you have to create the rootfs structure on your own.
166 Skip creation of the ISO file. This option is useful if you want to build/update
167 the chroot and/or recreate the squashfs file without building an ISO file.
171 Bootstrap the chroot without building bootloader, squashfs, or finalizing the
172 ISO. Use this option if installation of some packages fails, you want to run
173 custom commands or similar.
174 The main use of this option is to save time by skipping stages which aren't
175 necessary for bootstrapping the chroot and which would get executed more than
176 once when iterating through the initial bootstrapping.
177 Alternatively, use this option as a test run of grml-live. Once you are
178 satisfied with the state of your grml_chroot, use grml-live **-u** to build the
179 remaining stages and finalize the ISO.
181 -o **OUTPUT_DIRECTORY**::
183 Main output directory of the build process of FAI. Some directories are created
184 inside this target directory, being: grml_cd (where the files for creating the
185 ISO are located, including the compressed squashfs file), grml_chroot (the
186 chroot system) and grml_isos (where the resulting ISO is stored).
190 Build the ISO without (re-)creating the squashfs compressed file using mksquashfs.
191 This option is useful if you just want to update parts outside the chroot in the ISO.
192 Consider combining this option with the build-only option '-b'.
196 Specify name of the release.
200 Specify the Debian suite you want to use for your live-system. Defaults to
201 "squeeze" (being current Debian/stable). Supported values are: etch, lenny,
202 squeeze, sid. Debian "squeeze" requires a recent base.tgz
203 (${GRML_FAI_CONFIG}/config/basefiles/$CLASSNAME.tar.gz) or a recent version of
206 -t **TEMPLATE_DIRECTORY**::
208 Specify place of the templates used for building the ISO. By default
209 (and if not manually specified) this is /usr/share/grml-live/templates/.
211 -T **CHROOT_ARCHIVE**::
213 Unpack chroot tar archive before starting. Most useful in combination with
218 Update existing chroot instead of rebuilding it from scratch. This option is
219 based on the softupdate feature of FAI.
223 Sets ownership of all build output files to specified username before exiting.
225 -v **VERSION_NUMBER**::
227 Specify version number of the release.
231 Increase verbosity in the build process.
235 Use ZLIB instead of LZMA/XZ compression in mksquashfs part of the build process.
241 To get a small, Debian-stable and grml-based Live-CD using /grml/grml-live
242 as build and output directory just run:
246 To get a small Debian-unstable and grml-small based Live-CD using
247 /home/mika/grml-live as build and output directory just use:
249 # grml-live -s sid -c GRMLBASE,GRML_SMALL,AMD64 -o /home/mika/grml-live
251 To get a medium sized, Debian-unstable and grml-based Live-CD for amd64
252 architecture using /grml/grml-live as build and output directory just run:
254 # grml-live -s sid -a amd64 -c GRMLBASE,GRML_FULL,AMD64
256 To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and
257 output directory and use grml_0.0-3.iso as ISO name (placed inside
258 /tmp/grml_isos) just invoke:
260 # grml-live -o /tmp -c GRMLBASE,GRML_SMALL,AMD64 -s sid -i grml_0.0-3.iso
264 If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
265 you should have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm"
266 and use /dev/shm as build and output directory - resulting in very fast build
267 process. But please be aware of the fact that rebooting your system will result
268 in an empty /dev/shm, so please use another directory for $CHROOT_OUTPUT,
269 $BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)
272 Main features of grml-live
273 --------------------------
275 * create a grml-/Debian-based Linux Live-CD with one single command
277 * class based concept, providing a maximum of flexibility
279 * supports integration of own hooks, scripts and configuration
281 * supports use and integration of own Software and/or Kernels via simple use of
284 * native support of FAI features
286 * multi-arch support (work in progress)
292 grml-live uses FAI and its class based concept for adjusting configuration and
293 setup according to your needs. This gives you flexibility and strength without
294 losing the simplicity in the build process.
296 The main and base class provided by grml-live is named GRMLBASE. It's strongly
297 recommended to **always** use the class GRMLBASE when building an ISO using
298 grml-live, as well as the architecture dependent class which provides the kernel
299 (being 'I386' for x86_32 and 'AMD64' for x86_64) and a GRML_* class (like
300 GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are
301 relevant for class GRMLBASE by default:
303 ${GRML_FAI_CONFIG}/config/scripts/GRMLBASE/
304 ${GRML_FAI_CONFIG}/config/debconf/GRMLBASE
305 ${GRML_FAI_CONFIG}/config/class/GRMLBASE.var
306 ${GRML_FAI_CONFIG}/config/hooks/instsoft.GRMLBASE
307 ${GRML_FAI_CONFIG}/config/package_config/GRMLBASE
309 Take a look at the next section for information about the concept of those
312 If you want to use your own configuration, extend an existing configuration
313 and/or add additional packages to your ISO just invent a new class (or extend an
314 existing one). For example if you want to use your own class named "FOOBAR" just
315 set CLASSES="GRMLBASE,GRML_SMALL,AMD64,FOOBAR" inside /etc/grml/grml-live.local
316 or invoke grml-live using the classes option: "grml-live -c
317 GRMLBASE,GRML_SMALL,AMD64,FOOBAR ...".
319 More details regarding the class concept can be found in the documentation of
320 FAI itself (being available at /usr/share/doc/fai-doc/).
327 The package selection part of the classes can be found in
328 ${GRML_FAI_CONFIG}/config/package_config whereas some further classes are defined for
329 example in ${GRML_FAI_CONFIG}/config/scripts/ so specific feature sets can be
330 selected. The following classes are predefined:
332 * DEBORPHAN: get rid of all packages listed in output of Deborphan
334 * GRMLBASE: the main class responsible for getting a minimal subset of what's
335 defining a Grml system. Important parts of the buildprocess are specified in
336 this class as well, so unless you have a really good reason you should always
339 * GRML_FULL: full featured grml, also known as the "normal", full grml as
340 introduced in november 2011 (~350MB ISO size).
342 * GRML_MEDIUM: medium sized grml version, used to be known as grml-medium
343 until november 2011 (~220MB ISO size).
345 * GRML_SMALL: minimum sized grml version, known as grml-small (~110MB ISO
348 * GRML_XL: large size Grml version, used to be known as "full grml" until
349 november 2011 (~700MB ISO size).
351 * LATEX: LaTeX(-related) packages like auctex, texlive,...
352 (which used to be shipped by grml before the LaTeX removal)
354 * LATEX_CLEANUP: get rid of several very large LaTeX directories
355 (like some /usr/share/doc/texlive-*, /usr/share/doc/texmf,...)
357 * LOCALES: use full featured locales setup (see /etc/locale.gen.grml). This
358 avoids to get rid of /usr/share/locale - which happens by default otherwise - as
361 * NO_ONLINE: do not run scripts during the chroot build process which require a
364 * RELEASE: run some specific scripts and commands to provide the workflow for an
365 official grml release
367 * REMOVE_DOCS: get rid of documentation directories (like /usr/share/doc,
368 /usr/share/man/, /usr/share/info,...)
370 * SOURCES: retrieve Debian source packages after installation. Files will be
371 placed in the output directory under grml_sources.
373 * XORG: providing important packages for use with a base grml-featured X.org
380 Notice that grml-live ships FAI configuration files that do not use the same
381 namespace as the FAI packages itself. This ensures that grml-live does not clash
382 with your usual FAI configuration, so instead of /etc/fai/fai.conf (package
383 fai-client) grml uses ${GRML_FAI_CONFIG}/fai.conf instead. For more details see
384 below. To get an idea how another configuration or example files could look like
385 check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
386 fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html
387 provides documentation regarding configuration possibilities.
391 Script for the main build process. Requires root permissions for execution.
393 /etc/grml/grml-live.conf
395 Main configuration file for grml-live which should be considered as a reference
396 configuration file only. Please use /etc/grml/grml-live.local for local
397 configuration instead.
399 /etc/grml/grml-live.local
401 All the local configuration should go to this file. This file overrides any
402 defaults of grml-live. Configurations via /etc/grml/grml-live.local are preferred
403 over the ones from /etc/grml/grml-live.conf. If you want to override settings
404 from /etc/grml/grml-live.local as well you have to specify them on the grml-live
407 ${GRML_FAI_CONFIG}/fai.conf
409 Main configuration file for FAI which specifies where all the configuration
410 files and scripts for FAI/grml-live can be found. By default the configuration
411 variables are FAI_CONFIG_SRC=file:///etc/grml/fai/config and
412 GRML_FAI_CONFIG=/etc/grml/fai/config - both pointing to a directory shipped by
413 grml-live out-of-the-box so you shouldn't have to configure anything in this
416 ${GRML_FAI_CONFIG}/make-fai-nfsroot.conf
418 This file is used by make-fai-nfsroot(8) only. Usually you don't have to change
419 anything inside this file. If you want to modify NFSROOT though you can adjust
422 ${GRML_FAI_CONFIG}/NFSROOT
424 This file specifies the package list for creating the NFSROOT.
426 ${GRML_FAI_CONFIG}/apt/sources.list
428 This file specifies which mirrors should be considered for retrieving the Debian
429 packages when creating the main chroot (including all the software you would
430 like to see included). Important: this file should *not* be adjusted manually!
431 Instead use the GRML_LIVE_SOURCES variable inside /etc/grml/grml-live.conf or
432 /etc/grml/grml-live.local which modifies ${GRML_FAI_CONFIG}/apt/sources.list
433 on-the-fly via grml-live then. If you want to generally adjust apt configuration
434 use FAI's fcopy command with ${GRML_FAI_CONFIG}/config/files instead.
436 ${GRML_FAI_CONFIG}/config/
438 The main directory for configuration of FAI/grml-live. More details below.
440 ${GRML_FAI_CONFIG}/config/class/
442 This directory contains files which specify main configuration variables for the
445 ${GRML_FAI_CONFIG}/config/debconf/
447 This directory provides the files for preseeding/configuration of debconf
450 ${GRML_FAI_CONFIG}/config/hooks/
452 This directory provides files for customising the build process through hooks.
453 Hooks are user defined programs or scripts, which are called during the
454 installation process.
456 ${GRML_FAI_CONFIG}/config/package_config/
458 Directory with lists of software packages to be installed or removed. The
459 different classes describe what should find its way to your ISO. When running
460 "grml-live -c GRMLBASE,GRML_SMALL,AMD64 ..." only the configuration of GRMLBASE,
461 GRML_SMALL and and AMD64 will be taken. If you use 'grml-live -c
462 GRMLBASE,GRML_SMALL,AMD64,FOOBAR ...' then the files of GRMLBASE, GRML_SMALL,
463 AMD64 **plus** the files from FOOBAR will be taken. So just create a new class to
464 adjust the package selection according to your needs. Please notice that the
465 directory GRMLBASE contains a package list defining a minimum but still
466 reasonable package configuration.
468 ${GRML_FAI_CONFIG}/config/scripts/
470 Scripts for customising the ISO within the build process.
472 ${GRML_FAI_CONFIG}/live-initramfs/
474 This directory provides the files used for building the initramfs/initrd via
481 grml-live itself logs to /var/log/grml-live.log. Unless you set PRESERVE_LOGFILE
482 in your grml-live configuration the file is cleared on each new invocation of
485 The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the
486 default being /var/log/fai/grml/.
488 If you are using the grml-live buildd you will find the logs of the grml-live
489 run at /var/log/grml-buildd.log.
491 If you want to store build information in a database just install the
492 grml-live-db Debian package. Further details available in the grml-live-db
496 Requirements for the build system
497 ---------------------------------
499 * any Debian based system should be sufficient (if it doesn't work it's a bug,
500 please send us a bug report then) [a usual
501 link:http://grml.org/grml2hd/[grml2hd] harddisk installation (using grml or
502 grml-medium) ships all you need]. Check out <<deploy-on-debian,How do I deploy
503 grml-live on a plain Debian installation>> for details how to set up grml-live
504 on a plain, original Debian system.
506 * enough free disk space; at least 800MB are required for a minimal grml-live
507 run (\~400MB for the chroot [$CHROOT_OUTPUT], \~150MB for the build target
508 [$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some
509 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
510 total free disk space
512 * fast network access for retrieving the Debian packages used for creating the
513 chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
516 For further information see next section.
520 Current state of grml-live with squashfs-tools and kernel
521 ---------------------------------------------------------
523 Use squashfs-tools >=4.2-1 (available from Grml repositories as well as from
524 Debian/unstable) to build Grml (based) ISOs featuring kernel version
527 ////////////////////////////////////////////////////////////////////////////////
528 Difference between squashfs-lzma-tools, squashfs-lzma-tools4 and squashfs-tools
529 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
531 Whereas the ZLIB compression is much faster in the build process, the LZMA
532 compression provides a smaller resulting ISO. If you're wondering: the official
533 Grml builds use the LZMA compression.
535 Squashfs-tools was introduced in Debian and once provided support for LZMA
536 compression. Sadly LZMA compression within squashfs-tools became unsupported and
537 therefore squashfs-lzma-tools[4] had to be introduced and maintained by the Grml
538 team. Different kernel versions provide different squashfs file formats. Kernel
539 versions until 2.6.28-grml[64] used the 3.x file format but those outdated
540 kernels aren't supported by grml-live automatically anymore nowdays (manual
541 handling through SQUASHFS_BINARY possible though). Kernel versions
542 2.6.31-grml[64] and 2.6.33-grml[64] use openwrt's squashfs lzma file format
543 version 4. Kernel versions starting with 2.6.35-grml[64] use the mainline ondisk
544 file format version 4.
546 If you're wondering which package supports what, here's a short overview:
548 * squashfs-lzma-tools4 4.0-x: ZLIB as default, LZMA support via '-comp lzma'
549 option (enabled by grml-live by default), file format version 4 (mainline
550 version), package maintained and available from Grml, recommended for current
551 grml-live builds featuring kernels >=2.6.35-grml[64]
553 * squashfs-lzma-tools 4.0-2: ZLIB as default, LZMA support via '-lzma' option
554 (enabled by grml-live by default), file format version 4 (openwrt style),
555 package maintained and available from Grml, recommended for any grml-live builds
556 with kernel versions 2.6.31-grml[64] and 2.6.33-grml[64]
558 * squashfs-tools 1:4.0-x: ZLIB as default, no LZMA support/options, file format
559 version 4, package maintained and available from Debian, recommended only for
560 ZLIB-only builds of any grml-live builds with kernel versions >=2.6.31-grml[64]
564 * squashfs-tools 1:3.3-7: ZLIB as default, no LZMA support/options, file format
567 * squashfs-tools 1:3.2r2-9exp1: LZMA as default, ZLIB support via '-nolzma'
568 option, file format version 3
570 * squashfs-lzma-tools 3.3-1: LZMA as default, ZLIB support via '-nolzma' option,
571 file format version 3
573 Now, depending on the kernel version you want to use you need different versions
574 of squashfs-tools/squashfs-lzma-tools[4]. Yes, that's a mess (don't ask how much
575 this sucks for us developers) - though we're putting lots of effort into our
576 toolchain to automatically handle this for you through the grml-live build
577 system and provide proper documentation. The situation is supposed to calm down
578 with the recent integration of the squashfs file format 4 in the mainline
579 kernel. Support for LZMA is pending and as soon as it's available mainline this
580 should dramatically simplify the situation for developers as well as users.
583 If you want to force usage of a specific mksquashfs binary just set the
584 SQUASHFS_BINARY configuration/environment variable. Set SQUASHFS_OPTIONS for
585 customizing the options that should be used by the mksquashfs binary during
588 Using squashfs-lzma-tools4 4.0-1 on the build system
589 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
591 squashfs-lzma-tools4 4.0-1 is available via the Grml repositories. It provides
592 the mksquashfs-lzma4 and unsquashfs-lzma4 binaries. The package does NOT
593 conflict with neither Debian's squashfs-tools package nor Grml's
594 squashfs-lzma-tools package, so you can install all of them at the same time and
595 the build system will try to figure out the best matching binary automatically
598 The packages can be downloaded from
599 link:http://deb.grml.org/pool/main/s/squashfs-lzma-tools4/[http://deb.grml.org/pool/main/s/squashfs-lzma-tools4/]
601 It provides support for the new squashfs file format version 4 (as available in
602 mainline, so *not* the one being used by squashfs-lzma-tools and kernel
603 2.6.33-grml) and therefore requires kernel versions starting with
604 2.6.35-grml[64]. It supports LZMA as well as ZLIB compression. Just use the
605 defaults for enabling LZMA or use grml-live's '-z' option if you want to use
606 ZLIB compression instead.
608 * Kernel 2.6.31-grml[64]: works with ZLIB compression, fails with LZMA
609 * Kernel 2.6.33-grml[64]: works with ZLIB compression, fails with LZMA
610 * Kernel 2.6.35-grml[64]: works with ZLIB *and* LZMA compression
611 * Kernel 2.6.36-grml[64]: works with ZLIB *and* LZMA compression
614 squashfs-tools >=4.1-1 and/or squashfs-lzma-tools4 are the recommended package
615 for building up2date ISOs with grml-live! Please use other squashfs-* packages
616 only if you want to build live systems providing kernel versions older than
617 2.6.35-grml*. Use squashfs-tools >=4.1-1 or squashfs-lzma-tools4 from Grml if
618 you want to remaster any Grml releases MORE RECENT than 2010.04.
620 Using squashfs-lzma-tools 4.0-2 on the build system
621 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
623 squashfs-lzma-tools 4.0-2 is available via the Grml repositories. It provides
624 the mksquashfs-lzma and unsquashfs-lzma binaries. The package does NOT conflict
625 with Debian's squashfs-tools package (you can install both of them at the same
628 The packages can be downloaded from
629 link:http://deb.grml.org/pool/main/s/squashfs-lzma-tools/[http://deb.grml.org/pool/main/s/squashfs-lzma-tools/]
631 It provides support for the new squashfs file format version 4 (based on openwrt
632 patches, this is *not* the mainline file format that's being used by kernel
633 2.6.35-grml and squashfs-lzma-tools4!) and therefore requires kernel versions
634 newer than 2.6.28-grml[64]. It supports LZMA as well as ZLIB compression. Just
635 use the defaults for enabling LZMA or use grml-live's '-z' option if you want to
638 * Kernel \<=2.6.28-grml[64]: does not work
639 * Kernel 2.6.31-grml[64]: works
640 * Kernel 2.6.33-grml[64]: works
641 * Kernel 2.6.35-grml[64]: works for ZLIB compression, fails for LZMA
644 Please use squashfs-lzma-tools >=4.0-2 from Grml only if you want to remaster
645 Grml releases 2009.10 and 2010.04 or live systems with their according kernel
648 Using squashfs-tools 1:4.0-X on the build system
649 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
651 squashfs-tools >=1:4.0-1 is available in Debian/unstable and Debian/testing. It
652 provides the mksquashfs and unsquashfs binaries. The package does NOT conflict
653 neither with the squashfs-lzma-tools 4.0-2 package nor with the
654 squashfs-lzma-tools4 package (so you can install all of them at the same time).
656 The packages can be downloaded from
657 link:ftp://ftp.de.debian.org/debian/pool/main/s/squashfs-tools/[ftp://ftp.de.debian.org/debian/pool/main/s/squashfs-tools/]
659 It provides support for the new squashfs file format version 4 and therefore
660 requires kernel versions newer than 2.6.28-grml[64].
662 It does NOT support LZMA compression (dropped with
663 link:http://packages.debian.org/changelogs/pool/main/s/squashfs-tools/current/changelog[version
664 1:3.3-4] and not yet re-integrated yet, see
665 link:http://bugs.debian.org/594595[#594595]). If you need LZMA support please
666 use Grml's squashfs-lzma-tools[4] (see sections above) instead.
668 * Kernels \<=2.6.28-grml[64]: does not work
669 * Kernel 2.6.31-grml[64]: works (ZLIB only)
670 * Kernel 2.6.33-grml[64]: works (ZLIB only)
671 * Kernel 2.6.35-grml[64]: works (ZLIB only)
672 * Kernel 2.6.36-grml[64]: works (ZLIB only)
675 Please use squashfs-tools between 4.0-1 and 4.1-1 only if you want to remaster
676 Grml releases starting with 2009.10 using the ZLIB compression, please use other
677 squashfs packages otherwise instead.
681 Using squashfs-lzma-tools 3.3-1 on the build system
682 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
684 squashfs-lzma-tools 3.3-1 from the Grml repository supports kernel
685 2.6.26-grml[64] and 2.6.28-grml[64] using both LZMA and ZLIB (-nolzma)
688 The packages can be downloaded from
689 link:http://deb.grml.org/pool/main/s/squashfs-lzma/[http://deb.grml.org/pool/main/s/squashfs-lzma/].
692 Please use squashfs-lzma-tools 3.3-1 only if you want to remaster Grml releases
695 Using squashfs-tools 1:3.3-7 on the build system
696 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
698 squashfs-tools 1:3.3-7 is available through
699 http://grml.org/squashfs/squashfs-tools_3.3-7_i386.deb (for x86) or
700 http://grml.org/squashfs/squashfs-tools_3.3-7_amd64.deb (for amd64) [both build
701 on and for Debian/etch but working with testing and unstable as well].
703 Please notice that squashfs-tools 1:3.3-7 does NOT support LZMA compression at
704 all (so you won't be able to remaster release 2008.11 and 2009.05 using LZMA for
705 example). The -nolzma option of mksquashfs is not available therefore (even
706 though grml-live will deactivate it for you automatically anyway). Please use
707 squashfs-lzma-tools instead.
709 * Kernel 2.6.23-grml: does NOT work, please use squashfs-tools 1:3.2r2-9exp1
710 instead if you still want to use kernel 2.6.23 (not
712 * Kernel 2.6.26-grml: works (without LZMA compression only of course!)
713 * Kernel 2.6.28-grml: works (without LZMA compression only of course!)
715 Using squashfs-tools 1:3.2r2-9exp1 on the build system
716 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
718 squashfs-tools 1:3.2r2-9exp1 is available via the grml-testing repository,
721 # aptitude install squashfs-tools=1:3.2r2-9exp1
723 or directly via downloading the files
724 http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_i386.deb (for x86) or
725 http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_amd64.deb (for amd64).
727 Using with ZLIB compression (SQUASHFS_OPTIONS='-nolzma' or -z
728 option in grml-live cmdline):
730 * Kernel 2.6.23-grml: works
731 * Kernel 2.6.26-grml: works
732 * Kernel 2.6.28-grml: supposed to work (not verified though)
734 Using with LZMA compression:
736 * Kernel 2.6.23-grml: works
737 * Kernel 2.6.26-grml: does NOT work, please use ZLIB mode instead or switch
738 to Debian package squashfs-lzma-tools 3.3-1 (see section above).
739 * Kernel 2.6.28-grml: does NOT work, please use ZLIB mode instead or switch
740 to Debian package squashfs-lzma-tools 3.3-1 (see section above).
741 //////////////////////////////////////////////////////////////////////////////////
748 How do I deploy grml-live on a plain Debian installation?
749 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
751 The easiest way to get a running grml-live setup is to install Grml or
752 grml-medium using grml2hd (for example inside KVM, Virtualbox, VMware,... if you
753 don't want to run it on a physical system). Of course using grml-live on a
754 plain, original Debian installation is supported as well. So there we go.
756 What we have: plain, original Debian Lenny (5.0).
758 What we want: build a grml-medium ISO based on Debian/squeeze for the amd64
759 architecture using grml-live.
763 If you encounter any problems while booting the resulting ISO please be aware of
764 <<current_state,the 'current state of grml-live with squashfs-tools and kernel'
770 # adjust sources.list:
771 cat >> /etc/apt/sources.list << EOF
773 # grml stable repository:
774 deb http://deb.grml.org/ grml-stable main
775 # deb-src http://deb.grml.org/ grml-stable main
777 # grml testing/development repository:
778 deb http://deb.grml.org/ grml-testing main
779 # deb-src http://deb.grml.org/ grml-testing main
782 # adjust apt-pinning (only prefer squashfs stuff from grml):
783 cat >> /etc/apt/preferences << EOF
785 Pin: origin deb.grml.org
788 Package: squashfs-tools
789 Pin: origin deb.grml.org
793 # get keyring for apt:
795 apt-get --allow-unauthenticated install grml-debian-keyring
797 # optionally(!) install basefile so we don't have to build basic
798 # chroot from scratch, grab from http://daily.grml.org/
799 # mkdir -p /etc/grml/fai/config/basefiles/
800 # mv base.tgz /etc/grml/fai/config/basefiles/I386.tar.gz
801 # mv base64.tgz /etc/grml/fai/config/basefiles/AMD64.tar.gz
803 # install relevant tools
804 # please check out http://grml.org/grml-live/#current_state when encountering problems!
805 apt-get -o APT::Install-Recommends=false install grml-live squashfs-tools
807 # adjust grml-live configuration for our needs:
808 cat > /etc/grml/grml-live.local << EOF
809 ## want a faster build process and don't need smaller ISOs?
810 ## if so use zlib compression
811 # SQUASHFS_OPTIONS="-comp gzip -b 256k"
812 ## want to use a specific squashfs binary?
813 # SQUASHFS_BINARY='/usr/bin/mksquashfs'
814 # install local files into the chroot
815 CHROOT_INSTALL="/etc/grml/fai/chroot_install"
816 ## adjust if necessary (defaults to /grml/grml-live):
817 ## OUTPUT="/srv/grml-live"
818 FAI_DEBOOTSTRAP="squeeze http://cdn.debian.net/debian/"
820 CLASSES="GRMLBASE,GRML_FULL,AMD64"
821 # PRESERVE_LOGFILE='1'
822 # ZERO_FAI_LOGFILE='1'
824 deb http://deb.grml.org/ grml-stable main
825 deb http://deb.grml.org/ grml-testing main
826 deb http://cdn.debian.net/debian squeeze main contrib non-free
830 # just optional(!) - upgrade FAI to latest available version:
831 cat >> /etc/apt/sources.list << EOF
833 deb http://fai-project.org/download lenny koeln
836 # get gpg key of FAI repos and install current FAI version:
837 gpg -a --recv-keys AB9B66FD; gpg -a --export AB9B66FD | apt-key add -
839 apt-get install fai-client fai-server fai-doc
841 That's it. Now invoking 'grml-live -V' should build the ISO. If everything
842 worked as expected the last line of the shell output should look like:
844 [*] Successfully finished execution of grml-live [running 687 seconds]
846 and the ISO can be found inside /grml-live/grml-live/grml_isos/ then.
848 [[grml_fai_config_variable]]
849 What is $GRML_FAI_CONFIG?
850 ~~~~~~~~~~~~~~~~~~~~~~~~~
852 The variable '$GRML_FAI_CONFIG' is pointing to the directory /etc/grml/fai by
853 default. To provide you a maximum of flexibility you can set up your own
854 configuration directory (e.g. based on /etc/grml/fai) and use this directory
855 running grml-live with the '-D <config_dir>' option. Now '$GRML_FAI_CONFIG'
856 points to the specified directory instead of using /etc/grml/fai and all the
857 configuration files, scripts and hooks will be taken from your
858 '$GRML_FAI_CONFIG' directory.
861 I've problems with the build process. How to start debugging?
862 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
864 Check out the logs inside /var/log/fai/... If you think it's a bug in grml-live
865 send a copy of your config, logs and the commandline with a short problem
866 description to <mika@grml.org>:
868 # history | grep grml-live > /etc/grml/grml_live.cmdline
869 # tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \
870 /etc/grml/grml_live.cmdline /etc/grml/grml-buildd.conf \
871 /var/log/fai /etc/grml/fai
872 -> finally mail grml_live_problem.tar.gz to <mika@grml.org>
874 If you need help with grml-live or would like to see new features as part of
875 grml-live you can get commercial support via
876 link:http://grml-solutions.com/[Grml Solutions].
879 How much is the difference between LZMA and ZLIB compression?
880 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
882 ISO size (bs = blocksize):
884 [width="45%",cols="3,^2,^2"]
885 |============================================================
886 |ISO |LZMA (256kB bs) |ZLIB
887 |grml_sid |666M | 771M
888 |grml_squeeze |659M | 761M
889 |grml_lenny |624M | 723M
890 |grml64_sid |677M | 791M
891 |grml64_squeeze |671M | 785M
892 |grml64_lenny |639M | 745M
893 |grml-medium_sid |208M | 236M
894 |grml-medium_squeeze |206M | 234M
895 |grml-medium_lenny |193M | 220M
896 |grml64-medium_sid |213M | 245M
897 |grml64-medium_squeeze |213M | 244M
898 |grml64-medium_lenny |201M | 231M
899 |grml-small_sid |102M | 118M
900 |grml-small_squeeze |101M | 117M
901 |grml-small_lenny |97M | 112M
902 |grml64-small_sid |103M | 120M
903 |grml64-small_squeeze |103M | 120M
904 |grml64-small_lenny |99M | 116M
905 |============================================================
907 Build time of grml-medium's squashfs file (depends on your system, though just
908 to get the ratio between the different options):
910 * 10 minutes and 4 seconds with LZMA default blocksize (128k)
911 * 7 minutes 27 seconds with LZMA and blocksize 256k
912 * 6 minutes and 8 seconds with LZMA blocksize 512k
913 * 1 minute and 40 seconds with ZLIB
915 [[install-local-files]]
916 How do I install further files into the chroot/ISO?
917 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
919 Just point the configuration variable CHROOT_INSTALL to the directory which
920 provides the files you would like to install. Note that the files are installed
921 under '/' in the chroot - so you have to create the rootfs structure on your
924 echo "CHROOT_INSTALL=\$GRML_FAI_CONFIG/chroot_install" >> /etc/grml/grml-live.local
925 mkdir -p /etc/grml/fai/chroot_install/usr/src/
926 wget example.org/foo.tar.gz
927 mv foo.tar.gz /etc/grml/fai/chroot_install/usr/src/
930 [[local-debian-mirror]]
931 Can I use my own (local) Debian mirror?
932 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
934 Yes. Set up an according sources.list configuration as class file in
935 ${GRML_FAI_CONFIG}/config/files/etc/apt/sources.list.d/ and adjust the variable
936 FAI_DEBOOTSTRAP (if not already using NFSROOT's base.tgz) inside
937 /etc/grml/grml-live.conf[.local]. If you're setting up your own class file don't
938 forget to include the class name in the class list (grml-live -c ...).
940 If you want to use a local (for example NFS mount) mirror additionally then
941 adjust MIRROR_DIRECTORY in /etc/grml/grml-live.conf[.local] as well.
943 If you want to use a HTTP Proxy (like apt-cacher-ng), set APT_PROXY. Example:
945 APT_PROXY="http://localhost:3142/"
947 [[add-additional-debian-packages]]
948 How do I add additional Debian package(s) to my CD/ISO?
949 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
951 Just create a new class (using the package_config directory):
953 # cat > /etc/grml/fai/config/package_config/MIKA << EOF
957 another_name_of_a_debian_package
961 and specify it when invoking grml-live then:
963 # grml-live -c GRMLBASE,GRML_SMALL,AMD64,MIKA
965 [[reset-grml-live-configuration]]
966 I fscked up my grml-live configuration. How do I reset it to the defaults?
967 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
969 Notice: this deletes all your grml-live configuration files. If that's really
970 what you are searching for just run:
972 rm -rf /etc/grml/fai /etc/grml/grml-live.conf
973 dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb
977 If you don't control your /etc using a version control system (VCS) yet it's a
978 good chance to start using it now. Check out
979 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/]
980 for more details how to maintain /etc using the mercurial VCS.
982 [[create-a-base-tgz]]
983 How do I create a base.tgz for use as NFSROOT?
984 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
986 First of all build the chroot system:
988 mkdir /tmp/nfsroot && cd /tmp/nfsroot
989 debootstrap squeeze /tmp/nfsroot/ http://cdn.debian.net/debian
992 Then check out where your NFSROOT is located:
994 # grep '^NFSROOT' /etc/grml/fai/make-fai-nfsroot.conf
995 NFSROOT=/grml/fai/nfsroot
997 So as /grml/fai/nfsroot is your NFSROOT place the file under
998 /grml/fai/nfsroot/live/filesystem.dir/var/tmp/:
1000 mv base.tgz /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
1002 or even better use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz instead.
1003 Use I386 as $CLASSNAME for i386 builds and AMD64 for amd64 builds.
1005 Now running "grml-live ..." will use this file as main system instead of
1006 executing debootstrap. Check out the output for the following lines if using
1010 Calling task_extrbase
1011 Unpacking Debian base archive
1012 Extracting /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
1016 or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:
1019 ftar: extracting /etc/grml/fai/config/basefiles///AMD64.tar.gz to
1020 /grml-live/grml-live_20071029.22138/grml_chroot//
1024 Existing base.tgz can be found at http://daily.grml.org/
1027 Set up apt-cacher-ng for use with grml-live
1028 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1030 Make sure /etc/grml/grml-live.local provides according APT_PROXY and
1033 # cat /etc/grml/grml-live.local
1035 APT_PROXY="http://localhost:3142/"
1037 FAI_DEBOOTSTRAP="squeeze http://localhost:3142/cdn.debian.net/debian squeeze main contrib non-free"
1039 Make sure apt-cacher-ng is running ('/etc/init.d/apt-cacher-ng restart').
1040 That's it. All downloaded files will be cached in /var/cache/apt-cacher-ng then.
1043 Set up approx for use with grml-live
1044 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1046 Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and
1049 # cat /etc/grml/grml-live.conf
1052 deb http://localhost:9999/grml grml-stable main
1053 deb http://localhost:9999/grml grml-testing main
1054 deb http://localhost:9999/debian squeeze main contrib non-free
1056 FAI_DEBOOTSTRAP="squeeze http://localhost:9999/debian"
1060 # cat /etc/approx/approx.conf
1062 debian http://ftp.at.debian.org/debian
1063 grml http://deb.grml.org/
1065 Don't forget to restart approx (/etc/init.d/approx restart). That's it.
1066 All downloaded files will be cached in /var/cache/approx now.
1069 How do I revert the manifold feature from an ISO?
1070 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1072 The so called manifold feature Grml ISOs use by default allows one to use the same
1073 ISO for CD boot and USB boot. If you notice any problems when booting just
1074 revert the manifold feature running:
1076 % dd if=/dev/zero of=grml.iso bs=512 count=1 conv=notrunc
1078 To switch from manifold to isohybrid mode (an alternative approach provided by
1079 syslinux) then just execute:
1081 % isohybrid grml.iso
1084 How do I create a base tar.gz (I386.tar.gz or AMD64.tar.gz)
1085 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1087 Execute the following commands (requires root):
1089 ARCH='amd64' # replace with i386 if necessary
1090 SUITE='squeeze' # using the current stable release should always work
1091 debootstrap --arch "$ARCH" --exclude=info,tasksel,tasksel-data "$SUITE" "$ARCH" http://debian.netcologne.de/debian
1093 rm var/cache/apt/archives/*.deb
1094 tar zcf ../"${ARCH}".tar.gz *
1096 And finally place the generated tarball in /etc/grml/fai/config/basefiles/ (note
1097 that it needs to be uppercase letters matching the class names, so: AMD64.tar.gz
1098 for amd64 and I386.tar.gz for i386).
1101 How do I set up an autobuild environment?
1102 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1104 If you want to set up a system like link:http://daily.grml.org/[daily.grml.org]
1105 the Debian package grml-live-buildd provides all you need to start. Start with
1106 figuring out the cron job script /usr/share/grml-live/buildd/cronjob.sh.
1108 If you want to automatically update the grml-live Debian package on your build
1109 system based on the git tree of grml-live (so you get bleeding edge of
1110 development which might is interesting for services like daily.grml.org) the
1111 provided release_helper.sh script provides everything you need. Execute as root:
1113 echo "deb file:/home/grml-live-git/grml-live.build-area/ ./" >> /etc/apt/sources.list.d/grml-live.list
1114 adduser --disabled-login --disabled-password grml-live-git
1116 Execute 'visudo' to update sudo configuration and add the following line:
1118 grml-live-git ALL=NOPASSWD: /usr/bin/apt-get
1120 Switch to user grml-live-git and configure the rest:
1123 mkdir grml-live.build-area
1124 git clone git://git.grml.org/grml-live.git
1125 git config --global user.name "Grml-Live Git Autobuild"
1126 git config --global user.email "grml-live-git@$(hostname)"
1128 Finally install a cron job (as user grml-live-git) like:
1130 30 00 * * * cd /home/grml-live-git/grml-live.git/ && env AUTOBUILD=1 scripts/release_helper.sh >/home/grml-live-git/grml-live-build.log
1132 Tip: To find out the build date of the installed grml-live package just execute:
1134 % apt-cache policy grml-live | grep 'Installed.*autobuild'
1135 Installed: 0.13.1~autobuild1300450381
1137 and run "date -ud @$STRING" where $STRING is the number behind the "autobuild",
1140 % date -ud @1300450081
1141 Fri Mar 18 12:08:01 UTC 2011
1144 I've a question which isn't answered by this document
1145 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1147 Don't hesitate to contact the author: <mika@grml.org>
1150 Download / install grml-live as a Debian package
1151 ------------------------------------------------
1153 Debian packages are available through the grml-repository at
1154 link:http://deb.grml.org/pool/main/g/grml-live/[deb.grml.org]. If you want to
1155 build a Debian package on your own (using for example a specific version or the
1156 current development tree), just execute:
1158 git clone git://git.grml.org/grml-live
1166 The source of grml-live is available at
1167 link:http://git.grml.org/?p=grml-live.git[http://git.grml.org/?p=grml-live.git]
1173 Check out the link:http://git.grml.org/?p=grml-live.git;a=blob;f=TODO;hb=HEAD[TODO file].
1179 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes
1180 link:http://grml.org/contact/[to the grml-team]!
1186 The most recent grml-live documentation is available online at
1187 http://grml.org/grml-live/ and for offline reading also available
1188 in different formats:
1190 * http://grml.org/grml-live/grml-live.epub
1191 * http://grml.org/grml-live/grml-live.pdf
1196 Michael Prokop <mika@grml.org>
1198 /////////////////////////////////////
1199 // vim:ai tw=80 ft=asciidoc expandtab
1200 /////////////////////////////////////