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 <<X8,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 <<X7,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 Available classes
 239 -----------------
 240
 241 The package selection part of the classes can be found in
 242 /etc/grml/fai/config/package_config whereas some further classes are defined for
 243 example in /etc/grml/fai/config/scripts/ so specific feature sets can be
 244 selected. The following classes are predefined:
 245
 246 * DEBORPHAN: get rid of all packages listed in output of Deborphan
 247
 248 * GRMLBASE: the main class responsible for getting a minimal subset of what's
 249 defining a grml system. Important parts of the buildprocess are specified in
 250 this class as well, so unless you have a really good reason you should always
 251 use this class.
 252
 253 * GRML_FORENSIC: tools for forensic investigations which has been created
 254 by people from link:http://www.forensic-geeks.org/[forensic-geeks.org].
 255
 256 * GRML_FULL: full featured grml, also known as the "normal", full grml.
 257
 258 * GRML_MEDIUM: medium sized grml version, known as grml-medium
 259
 260 * GRML_POWERPC: grml for PowerPC architecture, not supported yet (still work in
 261 progress)
 262
 263 * GRML_SMALL: minimum sized grml version, known as grml-small
 264
 265 * LATEX_CLEANUP: get rid of several very large LaTeX directories
 266 (like some /usr/share/doc/texlive-*, /usr/share/doc/texmf,...)
 267
 268 * LOCALES: use full featured locales setup (see /etc/locale.gen.grml)
 269
 270 * NO_ONLINE: do not run scripts during the chroot build process which require a
 271 network connection
 272
 273 * RELEASE: run some specific scripts and commands to provide the workflow for an
 274 official grml release
 275
 276 * REMOVE_DOCS: get rid of documentation directories (like /usr/share/doc,
 277 /usr/share/man/, /usr/share/info,...)
 278
 279 * XORG: providing important packages for use with a base grml-featured X.org
 280 setup
 281
 282 Files
 283 -----
 284
 285 Notice that grml-live ships FAI configuration files that do not use the same
 286 namespace as the FAI packages itself. This ensures that grml-live does not clash
 287 with your usual FAI configuration, so instead of /etc/fai/fai.conf (package
 288 fai-client) grml uses /etc/grml/fai/fai.conf instead. For more details see
 289 below. To get an idea how another configuration or example files could look like
 290 check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
 291 fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html
 292 provides documentation regarding configuration possibilities.
 293
 294   /usr/sbin/grml-live
 295
 296 Script for the main build process. Requires root permissions for execution.
 297
 298   /etc/grml/grml-live.conf
 299
 300 Main configuration file for grml-live. All the important steps can be configured
 301 at this stage.
 302
 303   /etc/grml/fai/fai.conf
 304
 305 Main configuration file for FAI which specifies where all the configuration
 306 files and scripts for FAI/grml-live can be found. By default it is set to
 307 FAI_CONFIGDIR=/etc/grml/fai/config, a directory shipped by grml-live
 308 out-of-the-box so you shouldn't have to configure anything in this file.
 309
 310   /etc/grml/fai/make-fai-nfsroot.conf
 311
 312 This file is used by make-fai-nfsroot(8) only. Usually you don't have to change
 313 anything inside this file. If you want to modify NFSROOT though you can adjust
 314 it there.
 315
 316   /etc/grml/fai/NFSROOT
 317
 318 This file specifies the package list for creating the NFSROOT.
 319
 320   /etc/grml/fai/apt/sources.list
 321
 322 This file specifies which mirrors should be used for retreiving the Debian
 323 packages used for creating the main chroot (including all the software you would
 324 like to see included). If you want to use a local mirror you either have to
 325 adjust this file or use the GRML_LIVE_SOURCES variable inside
 326 /etc/grml/grml-live.conf which modifies /etc/grml/fai/apt/sources.list
 327 on-the-fly then.
 328
 329   /etc/grml/fai/config/
 330
 331 The main directory for configuration of FAI/grml-live. More details below.
 332
 333   /etc/grml/fai/config/class/
 334
 335 This directory contains files which specify main configuration variables for the
 336 FAI classes.
 337
 338   /etc/grml/fai/config/debconf/
 339
 340 This directory provides the files for preseeding/configuration of debconf
 341 through files.
 342
 343   /etc/grml/fai/config/hooks/
 344
 345 This directory provides files for customising the build process through hooks.
 346 Hooks are user defined programs or scripts, which are called during the
 347 installation process.
 348
 349   /etc/grml/fai/config/package_config/
 350
 351 Directory with lists of software packages to be installed or removed.  The
 352 different classes describe what should find its way to your ISO.  When running
 353 "grml-live -c GRMLBASE,GRML_SMALL,I386 ..." only the configuration of GRMLBASE,
 354 GRML_SMALL and and I386 will be taken. If you use 'grml-live -c
 355 GRMLBASE,GRML_SMALL,I386,FOOBAR ...' then the files of GRMLBASE, GRML_SMALL,
 356 I386 **plus** the files from FOOBAR will be taken. So just create a new class to
 357 adjust the package selection according to your needs.  Please notice that the
 358 directory GRMLBASE contains a package list defining a minimum but still
 359 reasonable package configuration.
 360
 361   /etc/grml/fai/config/scripts/
 362
 363 Scripts for customising the ISO within the build process.
 364
 365   /etc/grml/fai/files/
 366
 367 This directory provides files used inside the scripts of
 368 /etc/grml/fai/config/scripts/*. For a full documentation what happens with the
 369 files please refer to the source of the scripts.
 370
 371   /etc/grml/fai/live-initramfs/
 372
 373 This directory provides the files used for building the initramfs/initrd via
 374 live-initramfs(8).
 375
 376 Available log files
 377 -------------------
 378
 379 grml-live itself logs to /var/log/grml-live.log. Unless you set ZERO_LOGFILE in
 380 /etc/grml/grml-live.conf the output is appended to the file. If you set the
 381 ZERO_LOGFILE configuration option the logfile will be truncated on each new
 382 invocation of grml-live.
 383
 384 The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the
 385 default being /var/log/fai/grml/.
 386
 387 If you are using the grml-live buildd you will find the logs of the grml-live
 388 run at /var/log/grml-buildd.stdout and /var/log/grml-buildd.stderr.
 389
 390 Requirements for the build system
 391 ---------------------------------
 392
 393 * any Debian based system should be sufficient (if not it's a bug, so please
 394 send us a bug report then) [a usual link:http://grml.org/grml2hd/[grml2hd]
 395 harddisk installation ships all you need]
 396
 397 * enough free disk space; at least 800MB are required for a minimal grml-live
 398 run (\~400MB for the chroot [$CHROOT_OUTPUT], \~150MB for the build target
 399 [$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some
 400 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
 401 total free disk space
 402
 403 * fast network access for retreiving the Debian packages used for creating the
 404 chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
 405 as possiblbe)
 406
 407 For further information see next section.
 408
 409 [[X8]]
 410 Current state of grml-live with squashfs-tools and kernel
 411 ---------------------------------------------------------
 412
 413 To make it easier to track problems this section documents current state of
 414 grml-live playing together with squashfs-tools (for building the compressed
 415 file) and the kernel version. Documentation of this section is up2date by 18th
 416 august 2008.
 417
 418 System
 419 ~~~~~~
 420
 421 * grml-live 0.9
 422
 423 * building grml-medium (Debian/unstable)
 424
 425 * software versions used in the ISO (being installed automatically, recorded
 426 just as a reference):
 427
 428   ii  busybox                 1:1.10.2-1              Tiny utilities for small and embedded systems
 429   ii  initramfs-tools         0.92f                   tools for generating an initramfs
 430   ii  klibc-utils             1.5.12-2                small utilities built with klibc for early boot
 431   ii  live-initramfs          1.136.3-2~grml.04       Debian Live initramfs hook
 432   ii  lvm2                    2.02.39-2               The Linux Logical Volume Manager
 433   ii  mdadm                   2.6.7-3                 tool to administer Linux MD arrays (software RAID)
 434   ii  udev                    0.124-0grml3            /dev/ and hotplug management daemon
 435
 436 Using squashfs-tools 1:3.3-7 on the build system
 437 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 438
 439 squashfs-tools 1:3.3-7 is available via Debian/unstable and Debian/testing
 440 (lenny) pool running:
 441
 442   # aptitude install squashfs-tools=1:3.3-7
 443
 444 or directly via downloading the files
 445 http://grml.org/squashfs/squashfs-tools_3.3-7_i386.deb (for x86) or
 446 http://grml.org/squashfs/squashfs-tools_3.3-7_amd64.deb (for amd64) [both build
 447 on and for Debian/etch but working with testing and unstable as well].
 448
 449 Please notice that squashfs-tools 1:3.3-7 does NOT support LZMA compression at
 450 all (yet). The -nolzma option of mksquashfs is not available therefore (even
 451 though grml-live will deactivate it for you automatically anyway).
 452
 453 * Kernel 2.6.23-grml: does NOT work, please use squashfs-tools 1:3.2r2-9exp1
 454                     instead if you still want to use kernel 2.6.23
 455 * Kernel 2.6.26-grml: works
 456
 457 Using squashfs-tools 1:3.2r2-9exp1 on the build system
 458 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 459
 460 squashfs-tools 1:3.2r2-9exp1 is available via the grml-testing repository,
 461 running:
 462
 463   # aptitude install squashfs-tools=1:3.2r2-9exp1
 464
 465 or directly via downloading the files
 466 http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_i386.deb (for x86) or
 467 http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_amd64.deb (for amd64).
 468
 469 Versions with ZLIB compression (SQUASHFS_OPTIONS='-nolzma' or -z
 470 option in grml-live cmdline):
 471
 472 * Kernel 2.6.23-grml: works
 473 * Kernel 2.6.26-grml: works
 474
 475 Versions with LZMA compression:
 476
 477 * Kernel 2.6.23-grml: works
 478 * Kernel 2.6.26-grml: does NOT work, please use zlib mode instead
 479
 480 FAQ
 481 ---
 482
 483 Help, I'm using Debian etch and I don't have FAI version >3.2
 484 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 485
 486   wget http://www.informatik.uni-koeln.de/fai/download/etch/fai-client_3.2.8_all.deb \
 487        http://www.informatik.uni-koeln.de/fai/download/etch/fai-server_3.2.8_all.deb \
 488        http://www.informatik.uni-koeln.de/fai/download/etch/fai-doc_3.2.8_all.deb
 489   dpkg -i fai-client_3.2.8_all.deb fai-server_3.2.8_all.deb fai-doc_3.2.8_all.deb
 490
 491 or check out the link:http://www.informatik.uni-koeln.de/fai/[FAI-homepage] for
 492 further details.
 493
 494 I've problems with the build process. How to start debugging?
 495 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 496
 497 Check out the logs inside /var/log/fai/... If you don't have the time to debug
 498 the problem in further detail or don't know how to proceed just send a copy of
 499 your config, logs and the commandline with a short problem description to
 500 <mika@grml.org>:
 501
 502   # history | grep grml-live > /etc/grml/grml_live.cmdline
 503   # tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \
 504             /etc/grml/grml-buildd.conf /var/log/fai /etc/grml/fai
 505
 506 Can I use my own (local) Debian mirror?
 507 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 508
 509 Sure. Just adjust the variables GRML_LIVE_SOURCES and FAI_DEBOOTSTRAP (if not
 510 already using NFSROOT's base.tgz) inside /etc/grml/grml-live.conf according to
 511 your needs. Please don't forget that you should use the grml servers as well
 512 (see default configuration) so all the grml packages can be downloaded as well.
 513
 514 If you want to use a local (for example NFS mount) mirror additionally, just
 515 adjust MIRROR_DIRECTORY and MIRROR_SOURCES inside /etc/grml/grml-live.conf as
 516 well.
 517
 518 Unless you specify GRML_LIVE_SOURCES and/or FAI_DEBOOTSTRAP the default from
 519 /etc/grml/fai/apt/sources.list and /etc/grml/fai/make-fai-nfsroot.conf will be
 520 taken. If you customise the variables in /etc/grml/grml-live.conf then the two
 521 files will be adjusted during runtime automatically.
 522
 523 If MIRROR_DIRECTORY and MIRROR_SOURCES are specified the local mirror will be
 524 taken as first entry in the generated sources.list so it's prefered over
 525 non-local mirrors. Using a fallback mirror (via providing several mirrors in
 526 GRML_LIVE_SOURCES as used by default) is a recommended setting.
 527
 528 How do I add additional Debian package(s) to my CD/ISO?
 529 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 530
 531 Just create a new class (using the package_config directory):
 532
 533   # cat > /etc/grml/fai/config/package_config/MIKA << EOF
 534   PACKAGES aptitude
 535
 536   vim
 537   another_name_of_a_debian_package
 538   and_another_one
 539   EOF
 540
 541 and specify it when invoking grml-live then:
 542
 543   # grml-live -c GRMLBASE,GRML_SMALL,I386,MIKA
 544
 545 I fscked up my grml-live configuration. How do I reset it to the defaults?
 546 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 547
 548 Notice: this deletes all your grml-live configuration files. If that's really
 549 what you are searching for just run:
 550
 551   rm -rf /etc/grml/fai /etc/grml/grml-live.conf
 552   dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb
 553
 554 [NOTE]
 555
 556 If you don't control your /etc using a version control system (VCS) yet it's a
 557 good chance to start using it now. Check out
 558 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/]
 559 for more details how to maintain /etc using the mercurial VCS.
 560
 561 How do I create a base.tgz for use as NFSROOT?
 562 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 563
 564 First of all build the chroot system:
 565
 566   mkdir /tmp/nfsroot && cd /tmp/nfsroot
 567   debootstrap etch /tmp/nfsroot/ http://ftp.de.debian.org/debian
 568   tar zcf base.tgz ./
 569
 570 Then check out where your NFSROOT is located:
 571
 572   # grep '^NFSROOT' /etc/grml/fai/make-fai-nfsroot.conf
 573   NFSROOT=/grml/fai/nfsroot
 574
 575 So as /grml/fai/nfsroot is your NFSROOT place the file under
 576 /grml/fai/nfsroot/live/filesystem.dir/var/tmp/:
 577
 578   mv base.tgz /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
 579
 580 or even better use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz instead.
 581 Use I386 as $CLASSNAME for i386 builds and AMD64 for amd64 builds.
 582
 583 Now running "grml-live ..." will use this file as main system instead of
 584 executing debootstrap. Check out the output for the following lines if using
 585 NFSROOT:
 586
 587   [...]
 588   Calling task_extrbase
 589   Unpacking Debian base archive
 590   Extracting /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
 591   Calling task_mirror
 592   [...]
 593
 594 or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:
 595
 596   [...]
 597   ftar: extracting /etc/grml/fai/config/basefiles///AMD64.tar.gz to
 598   /grml-live/grml-live_20071029.22138/grml_chroot//
 599   [...]
 600
 601 Set up apt-cacher for use with grml-live
 602 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 603
 604 Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and
 605 FAI_DEBOOTSTRAP:
 606
 607   # cat /etc/grml/grml-live.conf
 608   [...]
 609   GRML_LIVE_SOURCES="
 610   deb http://localhost:3142/deb.grml.org grml-stable  main
 611   deb http://localhost:3142/deb.grml.org grml-testing main
 612   deb http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free
 613   "
 614   [...]
 615   FAI_DEBOOTSTRAP="etch http://localhost:3142/ftp.de.debian.org/debian etch main contrib non-free"
 616
 617 Make sure apt-cacher is running (/etc/init.d/apt-cacher restart). That's it.
 618 All downloaded files will be cached in /var/cache/apt-cacher/ now.
 619
 620 Set up approx for use with grml-live
 621 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 622
 623 Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and
 624 FAI_DEBOOTSTRAP:
 625
 626   # cat /etc/grml/grml-live.conf
 627   [...]
 628   GRML_LIVE_SOURCES="
 629   deb http://localhost:9999/grml            grml-stable  main
 630   deb http://localhost:9999/grml            grml-testing main
 631   deb http://localhost:9999/debian etch     main contrib non-free
 632   "
 633   FAI_DEBOOTSTRAP="etch http://localhost:9999/debian"
 634
 635 Configure approx:
 636
 637   # cat /etc/approx/approx.conf
 638   [...]
 639   debian http://ftp.at.debian.org/debian
 640   grml   http://deb.grml.org/
 641
 642 Don't forget to restart approx (/etc/init.d/approx restart). That's it.
 643 All downloaded files will be cached in /var/cache/approx now.
 644
 645 I've a question which isn't answered by this document
 646 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 647
 648 Don't hesitate to ask on IRC (channel #grml on irc.freenode.org) or just drop me
 649 a mail: <mika@grml.org>
 650
 651 Download / install grml-live as a Debian package
 652 ------------------------------------------------
 653
 654 Debian packages are available through the grml-repository at
 655 link:http://deb.grml.org/pool/main/g/grml-live/[deb.grml.org].  If you want to
 656 build a Debian package on your own (using for example a specific version or the
 657 current development tree), just execute:
 658
 659   hg clone http://hg.grml.org/grml-live
 660   cd grml-live
 661   debuild -us -uc
 662
 663 Source
 664 ------
 665
 666 The source of grml-live is available at
 667 link:http://hg.grml.org/grml-live/[http://hg.grml.org/grml-live/]
 668
 669 TODO list
 670 ---------
 671
 672 Check out link:http://wiki.grml.org/doku.php?id=grml-live[grml-live@grml-wiki]
 673 for details.
 674
 675 Bugs
 676 ----
 677
 678 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes
 679 link:http://grml.org/contact/[to the grml-team]!
 680
 681 Authors
 682 -------
 683 Michael Prokop <mika@grml.org>
 684
 685 /////////////////////////////////////
 686 // vim:ai tw=80 ft=asciidoc expandtab
 687 /////////////////////////////////////