docs/grml-live.txt

   1 grml-live(8)
   2 ============
   3
   4 Name
   5 ----
   6
   7 grml-live - build framework based on FAI for generating a grml and Debian based
   8 Linux Live system (CD/ISO)
   9
  10 Synopsis
  11 --------
  12
  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>] [-bFhuVz]
  16
  17 CAUTION: Please check out <<current_state,the 'Current state of grml-live with
  18 squashfs-tools and kernel' section>> for details about current state of involved
  19 tools before starting with grml-live or if you encounter any problems.
  20
  21 Description
  22 -----------
  23
  24 grml-live provides the build system for creating a grml and Debian based Linux
  25 Live-CD. The build system is based on
  26 link:http://www.informatik.uni-koeln.de/fai/[FAI] (Fully Automatic
  27 Installation). grml-live uses the "fai dirinstall" feature to generate a chroot
  28 system based on the class concept of FAI (see later sections for further
  29 details) and provides the framework to be able to generate a full-featured ISO.
  30 It does not use all the FAI features by default though and you don't have to
  31 know FAI to be able to use it.
  32
  33 The use of FAI gives you the flexibility to choose the packages you would like
  34 to include on your very own Linux Live-CD without having to deal with all the
  35 details of a build process.
  36
  37 CAUTION: grml-live does **not** use /etc/fai for configuration but instead
  38 provides and uses /etc/grml/fai. This ensures that it does not clash with
  39 default FAI configuration and packages, so you can use grml-live and FAI
  40 completely independent at the same time!
  41
  42 [NOTE]
  43
  44 Please notice that you should have a fast network connection as all the Debian
  45 packages will be downloaded and installed via network. If you want to use a
  46 local mirror (strongly recommended if you plan to use grml-live more than once)
  47 checkout mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror),
  48 debmirror(1), reprepro(1) (see /usr/share/doc/grml-live/examples/reprepro/ for a
  49 sample configuration), apt-cacher(1) and approx(8). To avoid downloading the
  50 base system again and again check out FAI's NFSROOT (see FAQ of this document
  51 for details).
  52
  53 Options
  54 -------
  55
  56   -a **ARCHITECTURE**::
  57
  58 Use the specified architecture instead of the currently running one.  This
  59 allows building a 32bit system on a 64bit host (though you can't build a 64bit
  60 system on a 32bit system/kernel of course). Please notice that real
  61 crosscompiling (like building a ppc system on x86) isn't possible due to the
  62 nature and the need of working in a chroot. Currently supported values: i386
  63 and amd64.
  64
  65   -b::
  66
  67 Build the ISO without updating the chroot via FAI. This option is useful for
  68 example when working on stable releases: if you have a working base
  69 system/chroot and do not want to execute any further updates (via "-u" option)
  70 but intend to only build the ISO.
  71
  72   -c **CLASSES**::
  73
  74 Specify the CLASSES to be used for building the ISO via FAI.  By default only
  75 the classes GRMLBASE, GRML_SMALL and I386 are assumed, resulting in a small base
  76 system (being about ~150MB total ISO size). If using a non-I386 system (like
  77 amd64) you should specify the appropriate architecture as well. Additionally you
  78 can specify a class providing a grml-kernel (see
  79 <<classes,the 'CLASSES' section in this document>> for details about available classes).
  80 So instead of GRML_SMALL you can also use GRML_MEDIUM and GRML_FULL.
  81
  82   -C **CONFIGURATION_FILE**::
  83
  84 The specified file is used as configuration file for grml-live. By default
  85 /etc/grml/grml-live.conf is used for main configuration. If a file named
  86 /etc/grml/grml-live.local exists it is used as well (sourced after reading
  87 /etc/grml/grml-live.conf to allow overriding settings). As a last option the
  88 specified configuration file is sourced so it is possible to override settings
  89 of /etc/grml/grml-live.conf as well as of /etc/grml/grml-live.local. Please
  90 notice that all configuration files have to be adjusted during execution of
  91 grml-live, so please make sure you use /etc/grml/grml-live.conf as a base for
  92 your own configuration file. Please also notice that the configuration file
  93 specified via this option is **not** (yet) supported inside the
  94 scripts/hooks/classes at /etc/grml/fai/config. Instead use
  95 /etc/grml/grml-live.conf and/or /etc/grml/grml-live.local for configuration
  96 stuff used inside /etc/grml/fai/config.
  97
  98   -F::
  99
 100 Force execution and do not prompt for acknowledgment of configuration.
 101
 102   -g **GRML_NAME**::
 103
 104 Set the grml flavour name. Common usage examples: grml, grml-small, grml64.
 105 Please do NOT use blanks and any special characters like '/', ';' inside
 106 GRML_NAME, otherwise you might notice problems with booting.
 107
 108   -h::
 109
 110 Display short usage information and exit.
 111
 112   -i **ISO_NAME**::
 113
 114 Specify name of ISO which will be available inside $OUTPUT_DIRECTORY/grml_isos
 115 by default.
 116
 117   -o **OUTPUT_DIRECTORY**::
 118
 119 Main output directory of the build process of FAI.  Some directories are created
 120 inside this target directory, being: grml_cd (where the files for creating the
 121 ISO are located, including the compressed squashfs file), grml_chroot (the
 122 chroot system) and grml_isos (where the resulting ISO is stored).
 123
 124   -r **RELEASENAME**::
 125
 126 Specify name of the release.
 127
 128   -s **SUITE**::
 129
 130 Specify the Debian suite you want to use for your live-system.  Defaults to
 131 "etch" (being current Debian/stable). Supported values are: etch, lenny, sid.
 132
 133   -t **TEMPLATE_DIRECTORY**::
 134
 135 Specify place of the templates used for building the ISO. By default
 136 (and if not manually specified) this is /usr/share/grml-live/templates/.
 137
 138   -u::
 139
 140 Update existing chroot instead of rebuilding it from scratch. This option is
 141 based on the softupdate feature of FAI.
 142
 143   -v **VERSION_NUMBER**::
 144
 145 Specify version number of the release.
 146
 147   -V::
 148
 149 Increase verbosity in the build process.
 150
 151   -z::
 152
 153 Use ZLIB instead of LZMA compression in mksquashfs part of the build process.
 154
 155 Usage examples
 156 --------------
 157
 158 To get a small, Debian-stable and grml-based Live-CD using /grml/grml-live
 159 as build and output directory just run:
 160
 161   # grml-live
 162
 163 To get a small Debian-unstable and grml-small based Live-CD using
 164 /home/mika/grml-live as build and output directory just use:
 165
 166   # grml-live -s sid -c GRMLBASE,GRML_SMALL,I386 -o /home/mika/grml-live
 167
 168 To get a medium sized, Debian-unstable and grml-based Live-CD for i386
 169 architecture using /grml/grml-live as build and output directory just run:
 170
 171   # grml-live -s sid -a i386 -c GRMLBASE,GRML_MEDIUM,I386
 172
 173 To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and
 174 output directory and use grml_0.0-3.iso as ISO name (placed inside
 175 /tmp/grml_isos) just invoke:
 176
 177   # grml-live -o /tmp -c GRMLBASE,GRML_SMALL,I386 -s sid -i grml_0.0-3.iso
 178
 179 [NOTE]
 180
 181 If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
 182 you should have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm"
 183 and use /dev/shm as build and output directory - resulting in very fast build
 184 process.  But please be aware of the fact that rebooting your system will result
 185 in an empty /dev/shm, so please use another directory for $CHROOT_OUTPUT,
 186 $BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)
 187
 188 Main features of grml-live
 189 --------------------------
 190
 191 * create a grml-/Debian-based Linux Live-CD with one single command
 192
 193 * class based concept, providing a maximum of flexibility
 194
 195 * supports integration of own hooks, scripts and configuration
 196
 197 * supports use and integration of own Software and/or Kernels via simple use of
 198 Debian repositories
 199
 200 * native support of FAI features
 201
 202 * multi-arch support (work in progress)
 203
 204 The class concept
 205 -----------------
 206
 207 grml-live uses FAI and its class based concept for adjusting configuration and
 208 setup according to your needs. This gives you flexibility and strength without
 209 losing the simplicity in the build process.
 210
 211 The main and base class provided by grml-live is named GRMLBASE. It's strongly
 212 recommended to **always** use the class GRMLBASE when building an ISO using
 213 grml-live, as well as the architecture dependent class which provides the kernel
 214 (being 'I386' for x86_32 and 'AMD64' for x86_64) and a GRML_* class (like
 215 GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are
 216 relevant for class GRMLBASE by default:
 217
 218   /etc/grml/fai/config/scripts/GRMLBASE/
 219   /etc/grml/fai/config/debconf/GRMLBASE
 220   /etc/grml/fai/config/class/GRMLBASE.var
 221   /etc/grml/fai/config/hooks/instsoft.GRMLBASE
 222   /etc/grml/fai/config/package_config/GRMLBASE
 223
 224 Take a look at the next section for information about the concept of those
 225 files/directories.
 226
 227 If you want to use your own configuration, extend an existing configuration
 228 and/or add additional packages to your ISO just invent a new class (or extend an
 229 existing one). For example if you want to use your own class named "FOOBAR" just
 230 extend CLASSES="GRMLBASE,GRML_SMALL,I386" inside /etc/grml/grml-live.conf to
 231 CLASSES="GRMLBASE,GRML_SMALL,I386,FOOBAR" or invoke grml-live using the classes
 232 option: "grml-live -c GRMLBASE,GRML_SMALL,I386,FOOBAR ...".
 233
 234 More details regarding the class concept can be found in the documentation of
 235 FAI itself (being available at /usr/share/doc/fai-doc/).
 236
 237 [[X7]]
 238 [[classes]]
 239 Available classes
 240 -----------------
 241
 242 The package selection part of the classes can be found in
 243 /etc/grml/fai/config/package_config whereas some further classes are defined for
 244 example in /etc/grml/fai/config/scripts/ so specific feature sets can be
 245 selected. The following classes are predefined:
 246
 247 * DEBORPHAN: get rid of all packages listed in output of Deborphan
 248
 249 * GRMLBASE: the main class responsible for getting a minimal subset of what's
 250 defining a grml system. Important parts of the buildprocess are specified in
 251 this class as well, so unless you have a really good reason you should always
 252 use this class.
 253
 254 * GRML_FORENSIC: tools for forensic investigations which has been created
 255 by people from link:http://www.forensic-geeks.org/[forensic-geeks.org].
 256
 257 * GRML_FULL: full featured grml, also known as the "normal", full grml.
 258
 259 * GRML_MEDIUM: medium sized grml version, known as grml-medium
 260
 261 * GRML_POWERPC: grml for PowerPC architecture, not supported yet (still work in
 262 progress)
 263
 264 * GRML_SMALL: minimum sized grml version, known as grml-small
 265
 266 * LATEX_CLEANUP: get rid of several very large LaTeX directories
 267 (like some /usr/share/doc/texlive-*, /usr/share/doc/texmf,...)
 268
 269 * LOCALES: use full featured locales setup (see /etc/locale.gen.grml)
 270
 271 * NO_ONLINE: do not run scripts during the chroot build process which require a
 272 network connection
 273
 274 * RELEASE: run some specific scripts and commands to provide the workflow for an
 275 official grml release
 276
 277 * REMOVE_DOCS: get rid of documentation directories (like /usr/share/doc,
 278 /usr/share/man/, /usr/share/info,...)
 279
 280 * XORG: providing important packages for use with a base grml-featured X.org
 281 setup
 282
 283 Files
 284 -----
 285
 286 Notice that grml-live ships FAI configuration files that do not use the same
 287 namespace as the FAI packages itself. This ensures that grml-live does not clash
 288 with your usual FAI configuration, so instead of /etc/fai/fai.conf (package
 289 fai-client) grml uses /etc/grml/fai/fai.conf instead. For more details see
 290 below. To get an idea how another configuration or example files could look like
 291 check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
 292 fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html
 293 provides documentation regarding configuration possibilities.
 294
 295   /usr/sbin/grml-live
 296
 297 Script for the main build process. Requires root permissions for execution.
 298
 299   /etc/grml/grml-live.conf
 300
 301 Main configuration file for grml-live. All the important steps can be configured
 302 at this stage.
 303
 304   /etc/grml/fai/fai.conf
 305
 306 Main configuration file for FAI which specifies where all the configuration
 307 files and scripts for FAI/grml-live can be found. By default it is set to
 308 FAI_CONFIGDIR=/etc/grml/fai/config, a directory shipped by grml-live
 309 out-of-the-box so you shouldn't have to configure anything in this file.
 310
 311   /etc/grml/fai/make-fai-nfsroot.conf
 312
 313 This file is used by make-fai-nfsroot(8) only. Usually you don't have to change
 314 anything inside this file. If you want to modify NFSROOT though you can adjust
 315 it there.
 316
 317   /etc/grml/fai/NFSROOT
 318
 319 This file specifies the package list for creating the NFSROOT.
 320
 321   /etc/grml/fai/apt/sources.list
 322
 323 This file specifies which mirrors should be used for retreiving the Debian
 324 packages used for creating the main chroot (including all the software you would
 325 like to see included). If you want to use a local mirror you either have to
 326 adjust this file or use the GRML_LIVE_SOURCES variable inside
 327 /etc/grml/grml-live.conf which modifies /etc/grml/fai/apt/sources.list
 328 on-the-fly then.
 329
 330   /etc/grml/fai/config/
 331
 332 The main directory for configuration of FAI/grml-live. More details below.
 333
 334   /etc/grml/fai/config/class/
 335
 336 This directory contains files which specify main configuration variables for the
 337 FAI classes.
 338
 339   /etc/grml/fai/config/debconf/
 340
 341 This directory provides the files for preseeding/configuration of debconf
 342 through files.
 343
 344   /etc/grml/fai/config/hooks/
 345
 346 This directory provides files for customising the build process through hooks.
 347 Hooks are user defined programs or scripts, which are called during the
 348 installation process.
 349
 350   /etc/grml/fai/config/package_config/
 351
 352 Directory with lists of software packages to be installed or removed.  The
 353 different classes describe what should find its way to your ISO.  When running
 354 "grml-live -c GRMLBASE,GRML_SMALL,I386 ..." only the configuration of GRMLBASE,
 355 GRML_SMALL and and I386 will be taken. If you use 'grml-live -c
 356 GRMLBASE,GRML_SMALL,I386,FOOBAR ...' then the files of GRMLBASE, GRML_SMALL,
 357 I386 **plus** the files from FOOBAR will be taken. So just create a new class to
 358 adjust the package selection according to your needs.  Please notice that the
 359 directory GRMLBASE contains a package list defining a minimum but still
 360 reasonable package configuration.
 361
 362   /etc/grml/fai/config/scripts/
 363
 364 Scripts for customising the ISO within the build process.
 365
 366   /etc/grml/fai/files/
 367
 368 This directory provides files used inside the scripts of
 369 /etc/grml/fai/config/scripts/*. For a full documentation what happens with the
 370 files please refer to the source of the scripts.
 371
 372   /etc/grml/fai/live-initramfs/
 373
 374 This directory provides the files used for building the initramfs/initrd via
 375 live-initramfs(8).
 376
 377 Available log files
 378 -------------------
 379
 380 grml-live itself logs to /var/log/grml-live.log. Unless you set ZERO_LOGFILE in
 381 /etc/grml/grml-live.conf the output is appended to the file. If you set the
 382 ZERO_LOGFILE configuration option the logfile will be truncated on each new
 383 invocation of grml-live.
 384
 385 The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the
 386 default being /var/log/fai/grml/.
 387
 388 If you are using the grml-live buildd you will find the logs of the grml-live
 389 run at /var/log/grml-buildd.stdout and /var/log/grml-buildd.stderr.
 390
 391 Requirements for the build system
 392 ---------------------------------
 393
 394 * any Debian based system should be sufficient (if not it's a bug, so please
 395 send us a bug report then) [a usual link:http://grml.org/grml2hd/[grml2hd]
 396 harddisk installation ships all you need]
 397
 398 * enough free disk space; at least 800MB are required for a minimal grml-live
 399 run (\~400MB for the chroot [$CHROOT_OUTPUT], \~150MB for the build target
 400 [$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some
 401 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
 402 total free disk space
 403
 404 * fast network access for retreiving the Debian packages used for creating the
 405 chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
 406 as possiblbe)
 407
 408 For further information see next section.
 409
 410 [[X8]]
 411 [[current_state]]
 412 Current state of grml-live with squashfs-tools and kernel
 413 ---------------------------------------------------------
 414
 415 To make it easier to track problems this section documents current state of
 416 grml-live playing together with squashfs-tools (for building the compressed
 417 file) and the kernel version. Documentation of this section is up2date by 18th
 418 august 2008.
 419
 420 System
 421 ~~~~~~
 422
 423 * grml-live 0.9
 424
 425 * building grml-medium (Debian/unstable)
 426
 427 * software versions used in the ISO (being installed automatically, recorded
 428 just as a reference):
 429
 430   ii  busybox                 1:1.10.2-1              Tiny utilities for small and embedded systems
 431   ii  initramfs-tools         0.92f                   tools for generating an initramfs
 432   ii  klibc-utils             1.5.12-2                small utilities built with klibc for early boot
 433   ii  live-initramfs          1.136.3-2~grml.04       Debian Live initramfs hook
 434   ii  lvm2                    2.02.39-2               The Linux Logical Volume Manager
 435   ii  mdadm                   2.6.7-3                 tool to administer Linux MD arrays (software RAID)
 436   ii  udev                    0.124-0grml3            /dev/ and hotplug management daemon
 437
 438 Using squashfs-tools 1:3.3-7 on the build system
 439 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 440
 441 squashfs-tools 1:3.3-7 is available via Debian/unstable and Debian/testing
 442 (lenny) pool running:
 443
 444   # aptitude install squashfs-tools=1:3.3-7
 445
 446 or directly via downloading the files
 447 http://grml.org/squashfs/squashfs-tools_3.3-7_i386.deb (for x86) or
 448 http://grml.org/squashfs/squashfs-tools_3.3-7_amd64.deb (for amd64) [both build
 449 on and for Debian/etch but working with testing and unstable as well].
 450
 451 Please notice that squashfs-tools 1:3.3-7 does NOT support LZMA compression at
 452 all (yet). The -nolzma option of mksquashfs is not available therefore (even
 453 though grml-live will deactivate it for you automatically anyway).
 454
 455 * Kernel 2.6.23-grml: does NOT work, please use squashfs-tools 1:3.2r2-9exp1
 456                     instead if you still want to use kernel 2.6.23
 457 * Kernel 2.6.26-grml: works
 458
 459 Using squashfs-tools 1:3.2r2-9exp1 on the build system
 460 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 461
 462 squashfs-tools 1:3.2r2-9exp1 is available via the grml-testing repository,
 463 running:
 464
 465   # aptitude install squashfs-tools=1:3.2r2-9exp1
 466
 467 or directly via downloading the files
 468 http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_i386.deb (for x86) or
 469 http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_amd64.deb (for amd64).
 470
 471 Versions with ZLIB compression (SQUASHFS_OPTIONS='-nolzma' or -z
 472 option in grml-live cmdline):
 473
 474 * Kernel 2.6.23-grml: works
 475 * Kernel 2.6.26-grml: works
 476
 477 Versions with LZMA compression:
 478
 479 * Kernel 2.6.23-grml: works
 480 * Kernel 2.6.26-grml: does NOT work, please use zlib mode instead
 481
 482 FAQ
 483 ---
 484
 485 Help, I'm using Debian etch and I don't have FAI version >3.2
 486 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 487
 488   wget http://www.informatik.uni-koeln.de/fai/download/etch/fai-client_3.2.8_all.deb \
 489        http://www.informatik.uni-koeln.de/fai/download/etch/fai-server_3.2.8_all.deb \
 490        http://www.informatik.uni-koeln.de/fai/download/etch/fai-doc_3.2.8_all.deb
 491   dpkg -i fai-client_3.2.8_all.deb fai-server_3.2.8_all.deb fai-doc_3.2.8_all.deb
 492
 493 or check out the link:http://www.informatik.uni-koeln.de/fai/[FAI-homepage] for
 494 further details.
 495
 496 I've problems with the build process. How to start debugging?
 497 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 498
 499 Check out the logs inside /var/log/fai/... If you don't have the time to debug
 500 the problem in further detail or don't know how to proceed just send a copy of
 501 your config, logs and the commandline with a short problem description to
 502 <mika@grml.org>:
 503
 504   # history | grep grml-live > /etc/grml/grml_live.cmdline
 505   # tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \
 506             /etc/grml/grml-buildd.conf /var/log/fai /etc/grml/fai
 507
 508 Can I use my own (local) Debian mirror?
 509 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 510
 511 Sure. Just adjust the variables GRML_LIVE_SOURCES and FAI_DEBOOTSTRAP (if not
 512 already using NFSROOT's base.tgz) inside /etc/grml/grml-live.conf according to
 513 your needs. Please don't forget that you should use the grml servers as well
 514 (see default configuration) so all the grml packages can be downloaded as well.
 515
 516 If you want to use a local (for example NFS mount) mirror additionally, just
 517 adjust MIRROR_DIRECTORY and MIRROR_SOURCES inside /etc/grml/grml-live.conf as
 518 well.
 519
 520 Unless you specify GRML_LIVE_SOURCES and/or FAI_DEBOOTSTRAP the default from
 521 /etc/grml/fai/apt/sources.list and /etc/grml/fai/make-fai-nfsroot.conf will be
 522 taken. If you customise the variables in /etc/grml/grml-live.conf then the two
 523 files will be adjusted during runtime automatically.
 524
 525 If MIRROR_DIRECTORY and MIRROR_SOURCES are specified the local mirror will be
 526 taken as first entry in the generated sources.list so it's prefered over
 527 non-local mirrors. Using a fallback mirror (via providing several mirrors in
 528 GRML_LIVE_SOURCES as used by default) is a recommended setting.
 529
 530 How do I add additional Debian package(s) to my CD/ISO?
 531 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 532
 533 Just create a new class (using the package_config directory):
 534
 535   # cat > /etc/grml/fai/config/package_config/MIKA << EOF
 536   PACKAGES aptitude
 537
 538   vim
 539   another_name_of_a_debian_package
 540   and_another_one
 541   EOF
 542
 543 and specify it when invoking grml-live then:
 544
 545   # grml-live -c GRMLBASE,GRML_SMALL,I386,MIKA
 546
 547 I fscked up my grml-live configuration. How do I reset it to the defaults?
 548 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 549
 550 Notice: this deletes all your grml-live configuration files. If that's really
 551 what you are searching for just run:
 552
 553   rm -rf /etc/grml/fai /etc/grml/grml-live.conf
 554   dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb
 555
 556 [NOTE]
 557
 558 If you don't control your /etc using a version control system (VCS) yet it's a
 559 good chance to start using it now. Check out
 560 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/]
 561 for more details how to maintain /etc using the mercurial VCS.
 562
 563 How do I create a base.tgz for use as NFSROOT?
 564 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 565
 566 First of all build the chroot system:
 567
 568   mkdir /tmp/nfsroot && cd /tmp/nfsroot
 569   debootstrap etch /tmp/nfsroot/ http://ftp.de.debian.org/debian
 570   tar zcf base.tgz ./
 571
 572 Then check out where your NFSROOT is located:
 573
 574   # grep '^NFSROOT' /etc/grml/fai/make-fai-nfsroot.conf
 575   NFSROOT=/grml/fai/nfsroot
 576
 577 So as /grml/fai/nfsroot is your NFSROOT place the file under
 578 /grml/fai/nfsroot/live/filesystem.dir/var/tmp/:
 579
 580   mv base.tgz /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
 581
 582 or even better use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz instead.
 583 Use I386 as $CLASSNAME for i386 builds and AMD64 for amd64 builds.
 584
 585 Now running "grml-live ..." will use this file as main system instead of
 586 executing debootstrap. Check out the output for the following lines if using
 587 NFSROOT:
 588
 589   [...]
 590   Calling task_extrbase
 591   Unpacking Debian base archive
 592   Extracting /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
 593   Calling task_mirror
 594   [...]
 595
 596 or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:
 597
 598   [...]
 599   ftar: extracting /etc/grml/fai/config/basefiles///AMD64.tar.gz to
 600   /grml-live/grml-live_20071029.22138/grml_chroot//
 601   [...]
 602
 603 Set up apt-cacher for use with grml-live
 604 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 605
 606 Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and
 607 FAI_DEBOOTSTRAP:
 608
 609   # cat /etc/grml/grml-live.conf
 610   [...]
 611   GRML_LIVE_SOURCES="
 612   deb http://localhost:3142/deb.grml.org grml-stable  main
 613   deb http://localhost:3142/deb.grml.org grml-testing main
 614   deb http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free
 615   "
 616   [...]
 617   FAI_DEBOOTSTRAP="etch http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free"
 618
 619 Make sure apt-cacher is running (/etc/init.d/apt-cacher restart). That's it.
 620 All downloaded files will be cached in /var/cache/apt-cacher/ now.
 621
 622 Set up approx for use with grml-live
 623 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 624
 625 Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and
 626 FAI_DEBOOTSTRAP:
 627
 628   # cat /etc/grml/grml-live.conf
 629   [...]
 630   GRML_LIVE_SOURCES="
 631   deb http://localhost:9999/grml            grml-stable  main
 632   deb http://localhost:9999/grml            grml-testing main
 633   deb http://localhost:9999/debian etch     main contrib non-free
 634   "
 635   FAI_DEBOOTSTRAP="etch http://localhost:9999/debian"
 636
 637 Configure approx:
 638
 639   # cat /etc/approx/approx.conf
 640   [...]
 641   debian http://ftp.at.debian.org/debian
 642   grml   http://deb.grml.org/
 643
 644 Don't forget to restart approx (/etc/init.d/approx restart). That's it.
 645 All downloaded files will be cached in /var/cache/approx now.
 646
 647 I've a question which isn't answered by this document
 648 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 649
 650 Don't hesitate to ask on IRC (channel #grml on irc.freenode.org) or just drop me
 651 a mail: <mika@grml.org>
 652
 653 Download / install grml-live as a Debian package
 654 ------------------------------------------------
 655
 656 Debian packages are available through the grml-repository at
 657 link:http://deb.grml.org/pool/main/g/grml-live/[deb.grml.org].  If you want to
 658 build a Debian package on your own (using for example a specific version or the
 659 current development tree), just execute:
 660
 661   hg clone http://hg.grml.org/grml-live
 662   cd grml-live
 663   debuild -us -uc
 664
 665 Source
 666 ------
 667
 668 The source of grml-live is available at
 669 link:http://hg.grml.org/grml-live/[http://hg.grml.org/grml-live/]
 670
 671 TODO list
 672 ---------
 673
 674 Check out link:http://wiki.grml.org/doku.php?id=grml-live[grml-live@grml-wiki]
 675 for details.
 676
 677 Bugs
 678 ----
 679
 680 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes
 681 link:http://grml.org/contact/[to the grml-team]!
 682
 683 Authors
 684 -------
 685 Michael Prokop <mika@grml.org>
 686
 687 /////////////////////////////////////
 688 // vim:ai tw=80 ft=asciidoc expandtab
 689 /////////////////////////////////////