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>] [-U <username>] [
  16 -AbBFnNquVz]
  17
  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.
  21
  22 Description
  23 -----------
  24
  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.
  33
  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.
  37
  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!
  43
  44 [NOTE]
  45
  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
  53 for details).
  54
  55 Options
  56 -------
  57
  58   -A::
  59
  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.
  62
  63   -a **ARCHITECTURE**::
  64
  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
  70 and amd64.
  71
  72   -b::
  73
  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.
  78
  79   -B::
  80
  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.
  85
  86   -c **CLASSES**::
  87
  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.
  96
  97 [IMPORTANT]
  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
 100 "FOO_BAR".
 101
 102
 103   -C **CONFIGURATION_FILE**::
 104
 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.
 118
 119   -d **DATE**::
 120
 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'
 128
 129   -D **CONFIGURATION_DIRECTORY**::
 130
 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.
 138
 139   -F::
 140
 141 Force execution and do not prompt for acknowledgment of configuration.
 142
 143   -g **GRML_NAME**::
 144
 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.
 148
 149   -h::
 150
 151 Display short usage information and exit.
 152
 153   -i **ISO_NAME**::
 154
 155 Specify name of ISO which will be available inside $OUTPUT_DIRECTORY/grml_isos
 156 by default.
 157
 158   -I **CHROOT_INSTALL**::
 159
 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.
 163
 164   -n::
 165
 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.
 168
 169   -N::
 170
 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.
 180
 181   -o **OUTPUT_DIRECTORY**::
 182
 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).
 187
 188   -q::
 189
 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'.
 193
 194   -r **RELEASENAME**::
 195
 196 Specify name of the release.
 197
 198   -s **SUITE**::
 199
 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
 204 debootstrap.
 205
 206   -t **TEMPLATE_DIRECTORY**::
 207
 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/.
 210
 211   -u::
 212
 213 Update existing chroot instead of rebuilding it from scratch. This option is
 214 based on the softupdate feature of FAI.
 215
 216   -U **USERNAME**::
 217
 218 Sets ownership of all build output files to specified username before exiting.
 219
 220   -v **VERSION_NUMBER**::
 221
 222 Specify version number of the release.
 223
 224   -V::
 225
 226 Increase verbosity in the build process.
 227
 228   -z::
 229
 230 Use ZLIB instead of LZMA/XZ compression in mksquashfs part of the build process.
 231
 232 [[usage-examples]]
 233 Usage examples
 234 --------------
 235
 236 To get a small, Debian-stable and grml-based Live-CD using /grml/grml-live
 237 as build and output directory just run:
 238
 239   # grml-live
 240
 241 To get a small Debian-unstable and grml-small based Live-CD using
 242 /home/mika/grml-live as build and output directory just use:
 243
 244   # grml-live -s sid -c GRMLBASE,GRML_SMALL,AMD64 -o /home/mika/grml-live
 245
 246 To get a medium sized, Debian-unstable and grml-based Live-CD for amd64
 247 architecture using /grml/grml-live as build and output directory just run:
 248
 249   # grml-live -s sid -a amd64 -c GRMLBASE,GRML_FULL,AMD64
 250
 251 To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and
 252 output directory and use grml_0.0-3.iso as ISO name (placed inside
 253 /tmp/grml_isos) just invoke:
 254
 255   # grml-live -o /tmp -c GRMLBASE,GRML_SMALL,AMD64 -s sid -i grml_0.0-3.iso
 256
 257 [NOTE]
 258
 259 If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
 260 you should have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm"
 261 and use /dev/shm as build and output directory - resulting in very fast build
 262 process.  But please be aware of the fact that rebooting your system will result
 263 in an empty /dev/shm, so please use another directory for $CHROOT_OUTPUT,
 264 $BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)
 265
 266 [[main-features]]
 267 Main features of grml-live
 268 --------------------------
 269
 270 * create a grml-/Debian-based Linux Live-CD with one single command
 271
 272 * class based concept, providing a maximum of flexibility
 273
 274 * supports integration of own hooks, scripts and configuration
 275
 276 * supports use and integration of own Software and/or Kernels via simple use of
 277 Debian repositories
 278
 279 * native support of FAI features
 280
 281 * multi-arch support (work in progress)
 282
 283 [[class-concept]]
 284 The class concept
 285 -----------------
 286
 287 grml-live uses FAI and its class based concept for adjusting configuration and
 288 setup according to your needs. This gives you flexibility and strength without
 289 losing the simplicity in the build process.
 290
 291 The main and base class provided by grml-live is named GRMLBASE. It's strongly
 292 recommended to **always** use the class GRMLBASE when building an ISO using
 293 grml-live, as well as the architecture dependent class which provides the kernel
 294 (being 'I386' for x86_32 and 'AMD64' for x86_64) and a GRML_* class (like
 295 GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are
 296 relevant for class GRMLBASE by default:
 297
 298   ${GRML_FAI_CONFIG}/config/scripts/GRMLBASE/
 299   ${GRML_FAI_CONFIG}/config/debconf/GRMLBASE
 300   ${GRML_FAI_CONFIG}/config/class/GRMLBASE.var
 301   ${GRML_FAI_CONFIG}/config/hooks/instsoft.GRMLBASE
 302   ${GRML_FAI_CONFIG}/config/package_config/GRMLBASE
 303
 304 Take a look at the next section for information about the concept of those
 305 files/directories.
 306
 307 If you want to use your own configuration, extend an existing configuration
 308 and/or add additional packages to your ISO just invent a new class (or extend an
 309 existing one). For example if you want to use your own class named "FOOBAR" just
 310 set CLASSES="GRMLBASE,GRML_SMALL,AMD64,FOOBAR" inside /etc/grml/grml-live.local
 311 or invoke grml-live using the classes option: "grml-live -c
 312 GRMLBASE,GRML_SMALL,AMD64,FOOBAR ...".
 313
 314 More details regarding the class concept can be found in the documentation of
 315 FAI itself (being available at /usr/share/doc/fai-doc/).
 316
 317 [[X7]]
 318 [[classes]]
 319 Available classes
 320 -----------------
 321
 322 The package selection part of the classes can be found in
 323 ${GRML_FAI_CONFIG}/config/package_config whereas some further classes are defined for
 324 example in ${GRML_FAI_CONFIG}/config/scripts/ so specific feature sets can be
 325 selected. The following classes are predefined:
 326
 327 * DEBORPHAN: get rid of all packages listed in output of Deborphan
 328
 329 * GRMLBASE: the main class responsible for getting a minimal subset of what's
 330 defining a Grml system. Important parts of the buildprocess are specified in
 331 this class as well, so unless you have a really good reason you should always
 332 use this class.
 333
 334 * GRML_FULL: full featured grml, also known as the "normal", full grml as
 335 introduced in november 2011 (~350MB ISO size).
 336
 337 * GRML_MEDIUM: medium sized grml version, used to be known as grml-medium
 338 until november 2011 (~220MB ISO size).
 339
 340 * GRML_SMALL: minimum sized grml version, known as grml-small (~110MB ISO
 341 size).
 342
 343 * GRML_XL: large size Grml version, used to be known as "full grml" until
 344 november 2011 (~700MB ISO size).
 345
 346 * LATEX: LaTeX(-related) packages like auctex, texlive,...
 347 (which used to be shipped by grml before the LaTeX removal)
 348
 349 * LATEX_CLEANUP: get rid of several very large LaTeX directories
 350 (like some /usr/share/doc/texlive-*, /usr/share/doc/texmf,...)
 351
 352 * LOCALES: use full featured locales setup (see /etc/locale.gen.grml). This
 353 avoids to get rid of /usr/share/locale - which happens by default otherwise - as
 354 well.
 355
 356 * NO_ONLINE: do not run scripts during the chroot build process which require a
 357 network connection
 358
 359 * RELEASE: run some specific scripts and commands to provide the workflow for an
 360 official grml release
 361
 362 * REMOVE_DOCS: get rid of documentation directories (like /usr/share/doc,
 363 /usr/share/man/, /usr/share/info,...)
 364
 365 * SOURCES: retrieve Debian source packages after installation. Files will be
 366 placed in the output directory under grml_sources.
 367
 368 * XORG: providing important packages for use with a base grml-featured X.org
 369 setup
 370
 371 [[files]]
 372 Files
 373 -----
 374
 375 Notice that grml-live ships FAI configuration files that do not use the same
 376 namespace as the FAI packages itself. This ensures that grml-live does not clash
 377 with your usual FAI configuration, so instead of /etc/fai/fai.conf (package
 378 fai-client) grml uses ${GRML_FAI_CONFIG}/fai.conf instead. For more details see
 379 below. To get an idea how another configuration or example files could look like
 380 check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
 381 fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html
 382 provides documentation regarding configuration possibilities.
 383
 384   /usr/sbin/grml-live
 385
 386 Script for the main build process. Requires root permissions for execution.
 387
 388   /etc/grml/grml-live.conf
 389
 390 Main configuration file for grml-live which should be considered as a reference
 391 configuration file only. Please use /etc/grml/grml-live.local for local
 392 configuration instead.
 393
 394   /etc/grml/grml-live.local
 395
 396 All the local configuration should go to this file. This file overrides any
 397 defaults of grml-live. Configurations via /etc/grml/grml-live.local are preferred
 398 over the ones from /etc/grml/grml-live.conf. If you want to override settings
 399 from /etc/grml/grml-live.local as well you have to specify them on the grml-live
 400 commandline.
 401
 402   ${GRML_FAI_CONFIG}/fai.conf
 403
 404 Main configuration file for FAI which specifies where all the configuration
 405 files and scripts for FAI/grml-live can be found. By default the configuration
 406 variables are FAI_CONFIG_SRC=file:///etc/grml/fai/config and
 407 GRML_FAI_CONFIG=/etc/grml/fai/config - both pointing to a directory shipped by
 408 grml-live out-of-the-box so you shouldn't have to configure anything in this
 409 file.
 410
 411   ${GRML_FAI_CONFIG}/make-fai-nfsroot.conf
 412
 413 This file is used by make-fai-nfsroot(8) only. Usually you don't have to change
 414 anything inside this file. If you want to modify NFSROOT though you can adjust
 415 it there.
 416
 417   ${GRML_FAI_CONFIG}/NFSROOT
 418
 419 This file specifies the package list for creating the NFSROOT.
 420
 421   ${GRML_FAI_CONFIG}/apt/sources.list
 422
 423 This file specifies which mirrors should be considered for retrieving the Debian
 424 packages when creating the main chroot (including all the software you would
 425 like to see included). Important: this file should *not* be adjusted manually!
 426 Instead use the GRML_LIVE_SOURCES variable inside /etc/grml/grml-live.conf or
 427 /etc/grml/grml-live.local which modifies ${GRML_FAI_CONFIG}/apt/sources.list
 428 on-the-fly via grml-live then. If you want to generally adjust apt configuration
 429 use FAI's fcopy command with ${GRML_FAI_CONFIG}/config/files instead.
 430
 431   ${GRML_FAI_CONFIG}/config/
 432
 433 The main directory for configuration of FAI/grml-live. More details below.
 434
 435   ${GRML_FAI_CONFIG}/config/class/
 436
 437 This directory contains files which specify main configuration variables for the
 438 FAI classes.
 439
 440   ${GRML_FAI_CONFIG}/config/debconf/
 441
 442 This directory provides the files for preseeding/configuration of debconf
 443 through files.
 444
 445   ${GRML_FAI_CONFIG}/config/hooks/
 446
 447 This directory provides files for customising the build process through hooks.
 448 Hooks are user defined programs or scripts, which are called during the
 449 installation process.
 450
 451   ${GRML_FAI_CONFIG}/config/package_config/
 452
 453 Directory with lists of software packages to be installed or removed.  The
 454 different classes describe what should find its way to your ISO.  When running
 455 "grml-live -c GRMLBASE,GRML_SMALL,AMD64 ..." only the configuration of GRMLBASE,
 456 GRML_SMALL and and AMD64 will be taken. If you use 'grml-live -c
 457 GRMLBASE,GRML_SMALL,AMD64,FOOBAR ...' then the files of GRMLBASE, GRML_SMALL,
 458 AMD64 **plus** the files from FOOBAR will be taken. So just create a new class to
 459 adjust the package selection according to your needs.  Please notice that the
 460 directory GRMLBASE contains a package list defining a minimum but still
 461 reasonable package configuration.
 462
 463   ${GRML_FAI_CONFIG}/config/scripts/
 464
 465 Scripts for customising the ISO within the build process.
 466
 467   ${GRML_FAI_CONFIG}/live-initramfs/
 468
 469 This directory provides the files used for building the initramfs/initrd via
 470 live-initramfs(8).
 471
 472 [[log-files]]
 473 Available log files
 474 -------------------
 475
 476 grml-live itself logs to /var/log/grml-live.log. Unless you set PRESERVE_LOGFILE
 477 in your grml-live configuration the file is cleared on each new invocation of
 478 grml-live.
 479
 480 The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the
 481 default being /var/log/fai/grml/.
 482
 483 If you are using the grml-live buildd you will find the logs of the grml-live
 484 run at /var/log/grml-buildd.log.
 485
 486 If you want to store build information in a database just install the
 487 grml-live-db Debian package. Further details available in the grml-live-db
 488 manpage.
 489
 490 [[requirements]]
 491 Requirements for the build system
 492 ---------------------------------
 493
 494 * any Debian based system should be sufficient (if it doesn't work it's a bug,
 495 please send us a bug report then) [a usual
 496 link:http://grml.org/grml2hd/[grml2hd] harddisk installation (using grml or
 497 grml-medium) ships all you need]. Check out <<deploy-on-debian,How do I deploy
 498 grml-live on a plain Debian installation>> for details how to set up grml-live
 499 on a plain, original Debian system.
 500
 501 * enough free disk space; at least 800MB are required for a minimal grml-live
 502 run (\~400MB for the chroot [$CHROOT_OUTPUT], \~150MB for the build target
 503 [$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some
 504 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
 505 total free disk space
 506
 507 * fast network access for retrieving the Debian packages used for creating the
 508 chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
 509 as possible)
 510
 511 For further information see next section.
 512
 513 [[X8]]
 514 [[current_state]]
 515 Current state of grml-live with squashfs-tools and kernel
 516 ---------------------------------------------------------
 517
 518 Use squashfs-tools >=4.2-1 (available from Grml repositories as well as from
 519 Debian/unstable) to build Grml (based) ISOs featuring kernel version
 520 2.6.38-grml[64].
 521
 522 ////////////////////////////////////////////////////////////////////////////////
 523 Difference between squashfs-lzma-tools, squashfs-lzma-tools4 and squashfs-tools
 524 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 525
 526 Whereas the ZLIB compression is much faster in the build process, the LZMA
 527 compression provides a smaller resulting ISO. If you're wondering: the official
 528 Grml builds use the LZMA compression.
 529
 530 Squashfs-tools was introduced in Debian and once provided support for LZMA
 531 compression. Sadly LZMA compression within squashfs-tools became unsupported and
 532 therefore squashfs-lzma-tools[4] had to be introduced and maintained by the Grml
 533 team. Different kernel versions provide different squashfs file formats. Kernel
 534 versions until 2.6.28-grml[64] used the 3.x file format but those outdated
 535 kernels aren't supported by grml-live automatically anymore nowdays (manual
 536 handling through SQUASHFS_BINARY possible though). Kernel versions
 537 2.6.31-grml[64] and 2.6.33-grml[64] use openwrt's squashfs lzma file format
 538 version 4. Kernel versions starting with 2.6.35-grml[64] use the mainline ondisk
 539 file format version 4.
 540
 541 If you're wondering which package supports what, here's a short overview:
 542
 543 * squashfs-lzma-tools4 4.0-x: ZLIB as default, LZMA support via '-comp lzma'
 544 option (enabled by grml-live by default), file format version 4 (mainline
 545 version), package maintained and available from Grml, recommended for current
 546 grml-live builds featuring kernels >=2.6.35-grml[64]
 547
 548 * squashfs-lzma-tools 4.0-2: ZLIB as default, LZMA support via '-lzma' option
 549 (enabled by grml-live by default), file format version 4 (openwrt style),
 550 package maintained and available from Grml, recommended for any grml-live builds
 551 with kernel versions 2.6.31-grml[64] and 2.6.33-grml[64]
 552
 553 * squashfs-tools 1:4.0-x: ZLIB as default, no LZMA support/options, file format
 554 version 4, package maintained and available from Debian, recommended only for
 555 ZLIB-only builds of any grml-live builds with kernel versions >=2.6.31-grml[64]
 556
 557 Outdated, JFTR:
 558
 559 * squashfs-tools 1:3.3-7: ZLIB as default, no LZMA support/options, file format
 560 version 3
 561
 562 * squashfs-tools 1:3.2r2-9exp1: LZMA as default, ZLIB support via '-nolzma'
 563 option, file format version 3
 564
 565 * squashfs-lzma-tools 3.3-1: LZMA as default, ZLIB support via '-nolzma' option,
 566 file format version 3
 567
 568 Now, depending on the kernel version you want to use you need different versions
 569 of squashfs-tools/squashfs-lzma-tools[4]. Yes, that's a mess (don't ask how much
 570 this sucks for us developers) - though we're putting lots of effort into our
 571 toolchain to automatically handle this for you through the grml-live build
 572 system and provide proper documentation. The situation is supposed to calm down
 573 with the recent integration of the squashfs file format 4 in the mainline
 574 kernel. Support for LZMA is pending and as soon as it's available mainline this
 575 should dramatically simplify the situation for developers as well as users.
 576
 577 [TIP]
 578 If you want to force usage of a specific mksquashfs binary just set the
 579 SQUASHFS_BINARY configuration/environment variable. Set SQUASHFS_OPTIONS for
 580 customizing the options that should be used by the mksquashfs binary during
 581 build process.
 582
 583 Using squashfs-lzma-tools4 4.0-1 on the build system
 584 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 585
 586 squashfs-lzma-tools4 4.0-1 is available via the Grml repositories. It provides
 587 the mksquashfs-lzma4 and unsquashfs-lzma4 binaries. The package does NOT
 588 conflict with neither Debian's squashfs-tools package nor Grml's
 589 squashfs-lzma-tools package, so you can install all of them at the same time and
 590 the build system will try to figure out the best matching binary automatically
 591 for you.
 592
 593 The packages can be downloaded from
 594 link:http://deb.grml.org/pool/main/s/squashfs-lzma-tools4/[http://deb.grml.org/pool/main/s/squashfs-lzma-tools4/]
 595
 596 It provides support for the new squashfs file format version 4 (as available in
 597 mainline, so *not* the one being used by squashfs-lzma-tools and kernel
 598 2.6.33-grml) and therefore requires kernel versions starting with
 599 2.6.35-grml[64]. It supports LZMA as well as ZLIB compression. Just use the
 600 defaults for enabling LZMA or use grml-live's '-z' option if you want to use
 601 ZLIB compression instead.
 602
 603 * Kernel 2.6.31-grml[64]: works with ZLIB compression, fails with LZMA
 604 * Kernel 2.6.33-grml[64]: works with ZLIB compression, fails with LZMA
 605 * Kernel 2.6.35-grml[64]: works with ZLIB *and* LZMA compression
 606 * Kernel 2.6.36-grml[64]: works with ZLIB *and* LZMA compression
 607
 608 [NOTE]
 609 squashfs-tools >=4.1-1 and/or squashfs-lzma-tools4 are the recommended package
 610 for building up2date ISOs with grml-live! Please use other squashfs-* packages
 611 only if you want to build live systems providing kernel versions older than
 612 2.6.35-grml*. Use squashfs-tools >=4.1-1 or squashfs-lzma-tools4 from Grml if
 613 you want to remaster any Grml releases MORE RECENT than 2010.04.
 614
 615 Using squashfs-lzma-tools 4.0-2 on the build system
 616 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 617
 618 squashfs-lzma-tools 4.0-2 is available via the Grml repositories. It provides
 619 the mksquashfs-lzma and unsquashfs-lzma binaries. The package does NOT conflict
 620 with Debian's squashfs-tools package (you can install both of them at the same
 621 time).
 622
 623 The packages can be downloaded from
 624 link:http://deb.grml.org/pool/main/s/squashfs-lzma-tools/[http://deb.grml.org/pool/main/s/squashfs-lzma-tools/]
 625
 626 It provides support for the new squashfs file format version 4 (based on openwrt
 627 patches, this is *not* the mainline file format that's being used by kernel
 628 2.6.35-grml and squashfs-lzma-tools4!) and therefore requires kernel versions
 629 newer than 2.6.28-grml[64]. It supports LZMA as well as ZLIB compression. Just
 630 use the defaults for enabling LZMA or use grml-live's '-z' option if you want to
 631 use ZLIB instead.
 632
 633 * Kernel \<=2.6.28-grml[64]: does not work
 634 * Kernel 2.6.31-grml[64]: works
 635 * Kernel 2.6.33-grml[64]: works
 636 * Kernel 2.6.35-grml[64]: works for ZLIB compression, fails for LZMA
 637
 638 [NOTE]
 639 Please use squashfs-lzma-tools >=4.0-2 from Grml only if you want to remaster
 640 Grml releases 2009.10 and 2010.04 or live systems with their according kernel
 641 versions.
 642
 643 Using squashfs-tools 1:4.0-X on the build system
 644 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 645
 646 squashfs-tools >=1:4.0-1 is available in Debian/unstable and Debian/testing. It
 647 provides the mksquashfs and unsquashfs binaries. The package does NOT conflict
 648 neither with the squashfs-lzma-tools 4.0-2 package nor with the
 649 squashfs-lzma-tools4 package (so you can install all of them at the same time).
 650
 651 The packages can be downloaded from
 652 link:ftp://ftp.de.debian.org/debian/pool/main/s/squashfs-tools/[ftp://ftp.de.debian.org/debian/pool/main/s/squashfs-tools/]
 653
 654 It provides support for the new squashfs file format version 4 and therefore
 655 requires kernel versions newer than 2.6.28-grml[64].
 656
 657 It does NOT support LZMA compression (dropped with
 658 link:http://packages.debian.org/changelogs/pool/main/s/squashfs-tools/current/changelog[version
 659 1:3.3-4] and not yet re-integrated yet, see
 660 link:http://bugs.debian.org/594595[#594595]). If you need LZMA support please
 661 use Grml's squashfs-lzma-tools[4] (see sections above) instead.
 662
 663 * Kernels \<=2.6.28-grml[64]: does not work
 664 * Kernel 2.6.31-grml[64]: works (ZLIB only)
 665 * Kernel 2.6.33-grml[64]: works (ZLIB only)
 666 * Kernel 2.6.35-grml[64]: works (ZLIB only)
 667 * Kernel 2.6.36-grml[64]: works (ZLIB only)
 668
 669 [NOTE]
 670 Please use squashfs-tools between 4.0-1 and 4.1-1 only if you want to remaster
 671 Grml releases starting with 2009.10 using the ZLIB compression, please use other
 672 squashfs packages otherwise instead.
 673
 674 Outdated, JFTR:
 675
 676 Using squashfs-lzma-tools 3.3-1 on the build system
 677 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 678
 679 squashfs-lzma-tools 3.3-1 from the Grml repository supports kernel
 680 2.6.26-grml[64] and 2.6.28-grml[64] using both LZMA and ZLIB (-nolzma)
 681 compression.
 682
 683 The packages can be downloaded from
 684 link:http://deb.grml.org/pool/main/s/squashfs-lzma/[http://deb.grml.org/pool/main/s/squashfs-lzma/].
 685
 686 [NOTE]
 687 Please use squashfs-lzma-tools 3.3-1 only if you want to remaster Grml releases
 688 2008.11 or 2009.05.
 689
 690 Using squashfs-tools 1:3.3-7 on the build system
 691 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 692
 693 squashfs-tools 1:3.3-7 is available through
 694 http://grml.org/squashfs/squashfs-tools_3.3-7_i386.deb (for x86) or
 695 http://grml.org/squashfs/squashfs-tools_3.3-7_amd64.deb (for amd64) [both build
 696 on and for Debian/etch but working with testing and unstable as well].
 697
 698 Please notice that squashfs-tools 1:3.3-7 does NOT support LZMA compression at
 699 all (so you won't be able to remaster release 2008.11 and 2009.05 using LZMA for
 700 example). The -nolzma option of mksquashfs is not available therefore (even
 701 though grml-live will deactivate it for you automatically anyway). Please use
 702 squashfs-lzma-tools instead.
 703
 704 * Kernel 2.6.23-grml: does NOT work, please use squashfs-tools 1:3.2r2-9exp1
 705                       instead if you still want to use kernel 2.6.23 (not
 706                       recommended)
 707 * Kernel 2.6.26-grml: works (without LZMA compression only of course!)
 708 * Kernel 2.6.28-grml: works (without LZMA compression only of course!)
 709
 710 Using squashfs-tools 1:3.2r2-9exp1 on the build system
 711 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 712
 713 squashfs-tools 1:3.2r2-9exp1 is available via the grml-testing repository,
 714 running:
 715
 716   # aptitude install squashfs-tools=1:3.2r2-9exp1
 717
 718 or directly via downloading the files
 719 http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_i386.deb (for x86) or
 720 http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_amd64.deb (for amd64).
 721
 722 Using with ZLIB compression (SQUASHFS_OPTIONS='-nolzma' or -z
 723 option in grml-live cmdline):
 724
 725 * Kernel 2.6.23-grml: works
 726 * Kernel 2.6.26-grml: works
 727 * Kernel 2.6.28-grml: supposed to work (not verified though)
 728
 729 Using with LZMA compression:
 730
 731 * Kernel 2.6.23-grml: works
 732 * Kernel 2.6.26-grml: does NOT work, please use ZLIB mode instead or switch
 733   to Debian package squashfs-lzma-tools 3.3-1 (see section above).
 734 * Kernel 2.6.28-grml: does NOT work, please use ZLIB mode instead or switch
 735   to Debian package squashfs-lzma-tools 3.3-1 (see section above).
 736 //////////////////////////////////////////////////////////////////////////////////
 737
 738 [[faq]]
 739 FAQ
 740 ---
 741
 742 [[deploy-on-debian]]
 743 How do I deploy grml-live on a plain Debian installation?
 744 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 745
 746 The easiest way to get a running grml-live setup is to install Grml or
 747 grml-medium using grml2hd (for example inside KVM, Virtualbox, VMware,... if you
 748 don't want to run it on a physical system). Of course using grml-live on a
 749 plain, original Debian installation is supported as well. So there we go.
 750
 751 What we have: plain, original Debian Lenny (5.0).
 752
 753 What we want: build a grml-medium ISO based on Debian/squeeze for the amd64
 754 architecture using grml-live.
 755
 756 [IMPORTANT]
 757
 758 If you encounter any problems while booting the resulting ISO please be aware of
 759 <<current_state,the 'current state of grml-live with squashfs-tools and kernel'
 760 section>>.
 761
 762 Instructions
 763 ^^^^^^^^^^^^
 764
 765   # adjust sources.list:
 766   cat >> /etc/apt/sources.list << EOF
 767
 768   # grml stable repository:
 769     deb     http://deb.grml.org/ grml-stable  main
 770   # deb-src http://deb.grml.org/ grml-stable  main
 771
 772   # grml testing/development repository:
 773     deb     http://deb.grml.org/ grml-testing main
 774   # deb-src http://deb.grml.org/ grml-testing main
 775   EOF
 776
 777   # adjust apt-pinning (only prefer squashfs stuff from grml):
 778   cat >> /etc/apt/preferences << EOF
 779   Package: *
 780   Pin: origin deb.grml.org
 781   Pin-Priority: 1
 782
 783   Package: squashfs-tools
 784   Pin: origin deb.grml.org
 785   Pin-Priority: 996
 786   EOF
 787
 788   # get keyring for apt:
 789   apt-get update
 790   apt-get --allow-unauthenticated install grml-debian-keyring
 791
 792   # optionally(!) install basefile so we don't have to build basic
 793   # chroot from scratch, grab from http://daily.grml.org/
 794   # mkdir -p /etc/grml/fai/config/basefiles/
 795   # mv base.tgz /etc/grml/fai/config/basefiles/I386.tar.gz
 796   # mv base64.tgz /etc/grml/fai/config/basefiles/AMD64.tar.gz
 797
 798   # install relevant tools
 799   # please check out http://grml.org/grml-live/#current_state when encountering problems!
 800   apt-get -o APT::Install-Recommends=false install grml-live squashfs-tools
 801
 802   # adjust grml-live configuration for our needs:
 803   cat > /etc/grml/grml-live.local << EOF
 804   ## want a faster build process and don't need smaller ISOs?
 805   ## if so use zlib compression
 806   # SQUASHFS_OPTIONS="-comp gzip -b 256k"
 807   ## want to use a specific squashfs binary?
 808   # SQUASHFS_BINARY='/usr/bin/mksquashfs'
 809   # install local files into the chroot
 810   CHROOT_INSTALL="/etc/grml/fai/chroot_install"
 811   ## adjust if necessary (defaults to /grml/grml-live):
 812   ## OUTPUT="/srv/grml-live"
 813   FAI_DEBOOTSTRAP="squeeze http://cdn.debian.net/debian/"
 814   ARCH="i386"
 815   CLASSES="GRMLBASE,GRML_FULL,AMD64"
 816   # PRESERVE_LOGFILE='1'
 817   # ZERO_FAI_LOGFILE='1'
 818   GRML_LIVE_SOURCES="
 819   deb http://deb.grml.org/            grml-stable  main
 820   deb http://deb.grml.org/            grml-testing main
 821   deb http://cdn.debian.net/debian squeeze main contrib non-free
 822   "
 823   EOF
 824
 825   # just optional(!) - upgrade FAI to latest available version:
 826   cat >> /etc/apt/sources.list << EOF
 827   # fai:
 828     deb http://fai-project.org/download lenny koeln
 829   EOF
 830
 831   # get gpg key of FAI repos and install current FAI version:
 832   gpg -a --recv-keys AB9B66FD; gpg -a --export AB9B66FD | apt-key add -
 833   apt-get update
 834   apt-get install fai-client fai-server fai-doc
 835
 836 That's it. Now invoking 'grml-live -V' should build the ISO.  If everything
 837 worked as expected the last line of the shell output should look like:
 838
 839   [*] Successfully finished execution of grml-live [running 687 seconds]
 840
 841 and the ISO can be found inside /grml-live/grml-live/grml_isos/ then.
 842
 843 [[grml_fai_config_variable]]
 844 What is $GRML_FAI_CONFIG?
 845 ~~~~~~~~~~~~~~~~~~~~~~~~~
 846
 847 The variable '$GRML_FAI_CONFIG' is pointing to the directory /etc/grml/fai by
 848 default.  To provide you a maximum of flexibility you can set up your own
 849 configuration directory (e.g. based on /etc/grml/fai) and use this directory
 850 running grml-live with the '-D <config_dir>' option. Now '$GRML_FAI_CONFIG'
 851 points to the specified directory instead of using /etc/grml/fai and all the
 852 configuration files, scripts and hooks will be taken from your
 853 '$GRML_FAI_CONFIG' directory.
 854
 855 [[how-to-debug]]
 856 I've problems with the build process. How to start debugging?
 857 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 858
 859 Check out the logs inside /var/log/fai/... If you think it's a bug in grml-live
 860 send a copy of your config, logs and the commandline with a short problem
 861 description to <mika@grml.org>:
 862
 863   # history | grep grml-live > /etc/grml/grml_live.cmdline
 864   # tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \
 865             /etc/grml/grml_live.cmdline /etc/grml/grml-buildd.conf \
 866             /var/log/fai /etc/grml/fai
 867   -> finally mail grml_live_problem.tar.gz to <mika@grml.org>
 868
 869 If you need help with grml-live or would like to see new features as part of
 870 grml-live you can get commercial support via
 871 link:http://grml-solutions.com/[Grml Solutions].
 872
 873 [[lzma-vs-zlib]]
 874 How much is the difference between LZMA and ZLIB compression?
 875 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 876
 877 ISO size (bs = blocksize):
 878
 879 [width="45%",cols="3,^2,^2"]
 880 |============================================================
 881 |ISO                   |LZMA (256kB bs) |ZLIB
 882 |grml_sid              |666M | 771M
 883 |grml_squeeze          |659M | 761M
 884 |grml_lenny            |624M | 723M
 885 |grml64_sid            |677M | 791M
 886 |grml64_squeeze        |671M | 785M
 887 |grml64_lenny          |639M | 745M
 888 |grml-medium_sid       |208M | 236M
 889 |grml-medium_squeeze   |206M | 234M
 890 |grml-medium_lenny     |193M | 220M
 891 |grml64-medium_sid     |213M | 245M
 892 |grml64-medium_squeeze |213M | 244M
 893 |grml64-medium_lenny   |201M | 231M
 894 |grml-small_sid        |102M | 118M
 895 |grml-small_squeeze    |101M | 117M
 896 |grml-small_lenny      |97M  | 112M
 897 |grml64-small_sid      |103M | 120M
 898 |grml64-small_squeeze  |103M | 120M
 899 |grml64-small_lenny    |99M  | 116M
 900 |============================================================
 901
 902 Build time of grml-medium's squashfs file (depends on your system, though just
 903 to get the ratio between the different options):
 904
 905 * 10 minutes and 4 seconds with LZMA default blocksize (128k)
 906 * 7 minutes 27 seconds with LZMA and blocksize 256k
 907 * 6 minutes and 8 seconds with LZMA blocksize 512k
 908 * 1 minute and 40 seconds with ZLIB
 909
 910 [[install-local-files]]
 911 How do I install further files into the chroot/ISO?
 912 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 913
 914 Just point the configuration variable CHROOT_INSTALL to the directory which
 915 provides the files you would like to install. Note that the files are installed
 916 under '/' in the chroot - so you have to create the rootfs structure on your
 917 own. Usage example:
 918
 919   echo "CHROOT_INSTALL=\$GRML_FAI_CONFIG/chroot_install" >> /etc/grml/grml-live.local
 920   mkdir -p /etc/grml/fai/chroot_install/usr/src/
 921   wget example.org/foo.tar.gz
 922   mv foo.tar.gz /etc/grml/fai/chroot_install/usr/src/
 923   grml-live ...
 924
 925 [[local-debian-mirror]]
 926 Can I use my own (local) Debian mirror?
 927 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 928
 929 Yes. Set up an according sources.list configuration as class file in
 930 ${GRML_FAI_CONFIG}/config/files/etc/apt/sources.list.d/ and adjust the variable
 931 FAI_DEBOOTSTRAP (if not already using NFSROOT's base.tgz) inside
 932 /etc/grml/grml-live.conf[.local]. If you're setting up your own class file don't
 933 forget to include the class name in the class list (grml-live -c ...).
 934
 935 If you want to use a local (for example NFS mount) mirror additionally then
 936 adjust MIRROR_DIRECTORY in /etc/grml/grml-live.conf[.local] as well.
 937
 938 If you want to use a HTTP Proxy (like apt-cacher-ng), set APT_PROXY. Example:
 939
 940   APT_PROXY="http://localhost:3142/"
 941
 942 [[add-additional-debian-packages]]
 943 How do I add additional Debian package(s) to my CD/ISO?
 944 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 945
 946 Just create a new class (using the package_config directory):
 947
 948   # cat > /etc/grml/fai/config/package_config/MIKA << EOF
 949   PACKAGES aptitude
 950
 951   vim
 952   another_name_of_a_debian_package
 953   and_another_one
 954   EOF
 955
 956 and specify it when invoking grml-live then:
 957
 958   # grml-live -c GRMLBASE,GRML_SMALL,AMD64,MIKA
 959
 960 [[reset-grml-live-configuration]]
 961 I fscked up my grml-live configuration. How do I reset it to the defaults?
 962 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 963
 964 Notice: this deletes all your grml-live configuration files. If that's really
 965 what you are searching for just run:
 966
 967   rm -rf /etc/grml/fai /etc/grml/grml-live.conf
 968   dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb
 969
 970 [NOTE]
 971
 972 If you don't control your /etc using a version control system (VCS) yet it's a
 973 good chance to start using it now. Check out
 974 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/]
 975 for more details how to maintain /etc using the mercurial VCS.
 976
 977 [[create-a-base-tgz]]
 978 How do I create a base.tgz for use as NFSROOT?
 979 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 980
 981 First of all build the chroot system:
 982
 983   mkdir /tmp/nfsroot && cd /tmp/nfsroot
 984   debootstrap squeeze /tmp/nfsroot/ http://cdn.debian.net/debian
 985   tar zcf base.tgz ./
 986
 987 Then check out where your NFSROOT is located:
 988
 989   # grep '^NFSROOT' /etc/grml/fai/make-fai-nfsroot.conf
 990   NFSROOT=/grml/fai/nfsroot
 991
 992 So as /grml/fai/nfsroot is your NFSROOT place the file under
 993 /grml/fai/nfsroot/live/filesystem.dir/var/tmp/:
 994
 995   mv base.tgz /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
 996
 997 or even better use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz instead.
 998 Use I386 as $CLASSNAME for i386 builds and AMD64 for amd64 builds.
 999
1000 Now running "grml-live ..." will use this file as main system instead of
1001 executing debootstrap. Check out the output for the following lines if using
1002 NFSROOT:
1003
1004   [...]
1005   Calling task_extrbase
1006   Unpacking Debian base archive
1007   Extracting /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
1008   Calling task_mirror
1009   [...]
1010
1011 or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:
1012
1013   [...]
1014   ftar: extracting /etc/grml/fai/config/basefiles///AMD64.tar.gz to
1015   /grml-live/grml-live_20071029.22138/grml_chroot//
1016   [...]
1017
1018 [TIP]
1019 Existing base.tgz can be found at http://daily.grml.org/
1020
1021 [[apt-cacher]]
1022 Set up apt-cacher-ng for use with grml-live
1023 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1024
1025 Make sure /etc/grml/grml-live.local provides according APT_PROXY and
1026 FAI_DEBOOTSTRAP:
1027
1028   # cat /etc/grml/grml-live.local
1029   [...]
1030   APT_PROXY="http://localhost:3142/"
1031   [...]
1032   FAI_DEBOOTSTRAP="squeeze http://localhost:3142/cdn.debian.net/debian squeeze main contrib non-free"
1033
1034 Make sure apt-cacher-ng is running ('/etc/init.d/apt-cacher-ng restart').
1035 That's it.  All downloaded files will be cached in /var/cache/apt-cacher-ng then.
1036
1037 [[approx]]
1038 Set up approx for use with grml-live
1039 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1040
1041 Make sure /etc/grml/grml-live.conf provides according GRML_LIVE_SOURCES and
1042 FAI_DEBOOTSTRAP:
1043
1044   # cat /etc/grml/grml-live.conf
1045   [...]
1046   GRML_LIVE_SOURCES="
1047   deb http://localhost:9999/grml            grml-stable  main
1048   deb http://localhost:9999/grml            grml-testing main
1049   deb http://localhost:9999/debian squeeze  main contrib non-free
1050   "
1051   FAI_DEBOOTSTRAP="squeeze http://localhost:9999/debian"
1052
1053 Configure approx:
1054
1055   # cat /etc/approx/approx.conf
1056   [...]
1057   debian http://ftp.at.debian.org/debian
1058   grml   http://deb.grml.org/
1059
1060 Don't forget to restart approx (/etc/init.d/approx restart). That's it.
1061 All downloaded files will be cached in /var/cache/approx now.
1062
1063 [[revert_manifold]]
1064 How do I revert the manifold feature from an ISO?
1065 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1066
1067 The so called manifold feature Grml ISOs use by default allows one to use the same
1068 ISO for CD boot and USB boot. If you notice any problems when booting just
1069 revert the manifold feature running:
1070
1071   % dd if=/dev/zero of=grml.iso bs=512 count=1 conv=notrunc
1072
1073 To switch from manifold to isohybrid mode (an alternative approach provided by
1074 syslinux) then just execute:
1075
1076   % isohybrid grml.iso
1077
1078 [[basetgz]]
1079 How do I create a base tar.gz (I386.tar.gz or AMD64.tar.gz)
1080 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1081
1082 Execute the following commands (requires root):
1083
1084   ARCH='amd64' # replace with i386 if necessary
1085   SUITE='squeeze' # using the current stable release should always work
1086   debootstrap --arch "$ARCH" --exclude=info,tasksel,tasksel-data "$SUITE" "$ARCH" http://debian.netcologne.de/debian
1087   cd "$ARCH"
1088   rm var/cache/apt/archives/*.deb
1089   tar zcf ../"${ARCH}".tar.gz *
1090
1091 And finally place the generated tarball in /etc/grml/fai/config/basefiles/ (note
1092 that it needs to be uppercase letters matching the class names, so: AMD64.tar.gz
1093 for amd64 and I386.tar.gz for i386).
1094
1095 [[autobuild]]
1096 How do I set up an autobuild environment?
1097 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1098
1099 If you want to set up a system like link:http://daily.grml.org/[daily.grml.org]
1100 the Debian package grml-live-buildd provides all you need to start. Start with
1101 figuring out the cron job script /usr/share/grml-live/buildd/cronjob.sh.
1102
1103 If you want to automatically update the grml-live Debian package on your build
1104 system based on the git tree of grml-live (so you get bleeding edge of
1105 development which might is interesting for services like daily.grml.org) the
1106 provided release_helper.sh script provides everything you need. Execute as root:
1107
1108   echo "deb file:/home/grml-live-git/grml-live.build-area/ ./" >> /etc/apt/sources.list.d/grml-live.list
1109   adduser --disabled-login --disabled-password grml-live-git
1110
1111 Execute 'visudo' to update sudo configuration and add the following line:
1112
1113   grml-live-git ALL=NOPASSWD: /usr/bin/apt-get
1114
1115 Switch to user grml-live-git and configure the rest:
1116
1117   su - grml-live-git
1118   mkdir grml-live.build-area
1119   git clone git://git.grml.org/grml-live.git
1120   git config --global user.name "Grml-Live Git Autobuild"
1121   git config --global user.email "grml-live-git@$(hostname)"
1122
1123 Finally install a cron job (as user grml-live-git) like:
1124
1125   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
1126
1127 Tip: To find out the build date of the installed grml-live package just execute:
1128
1129   % apt-cache policy grml-live | grep 'Installed.*autobuild'
1130    Installed: 0.13.1~autobuild1300450381
1131
1132 and run "date -ud @$STRING" where $STRING is the number behind the "autobuild",
1133 like:
1134
1135   % date -ud @1300450081
1136   Fri Mar 18 12:08:01 UTC 2011
1137
1138 [[question]]
1139 I've a question which isn't answered by this document
1140 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1141
1142 Don't hesitate to contact the author: <mika@grml.org>
1143
1144 [[download]]
1145 Download / install grml-live as a Debian package
1146 ------------------------------------------------
1147
1148 Debian packages are available through the grml-repository at
1149 link:http://deb.grml.org/pool/main/g/grml-live/[deb.grml.org].  If you want to
1150 build a Debian package on your own (using for example a specific version or the
1151 current development tree), just execute:
1152
1153   git clone git://git.grml.org/grml-live
1154   cd grml-live
1155   debuild -us -uc
1156
1157 [[source]]
1158 Source
1159 ------
1160
1161 The source of grml-live is available at
1162 link:http://git.grml.org/?p=grml-live.git[http://git.grml.org/?p=grml-live.git]
1163
1164 [[todo-list]]
1165 TODO list
1166 ---------
1167
1168 Check out the link:http://git.grml.org/?p=grml-live.git;a=blob;f=TODO;hb=HEAD[TODO file].
1169
1170 [[bugs]]
1171 Bugs
1172 ----
1173
1174 Please report feedback, link:http://grml.org/bugs/[bugreports] and wishes
1175 link:http://grml.org/contact/[to the grml-team]!
1176
1177 [[documentation]]
1178 Documentation
1179 -------------
1180
1181 The most recent grml-live documentation is available online at
1182 http://grml.org/grml-live/ and for offline reading also available
1183 in different formats:
1184
1185 * http://grml.org/grml-live/grml-live.epub
1186 * http://grml.org/grml-live/grml-live.pdf
1187
1188 [[authors]]
1189 Authors
1190 -------
1191 Michael Prokop <mika@grml.org>
1192
1193 /////////////////////////////////////
1194 // vim:ai tw=80 ft=asciidoc expandtab
1195 /////////////////////////////////////