Introduce support for squashfs-lzma-tools 4.0-1 and support SQUASHFS_BINARY
[grml-live.git] / etc / grml / grml-live.conf
index a6b18b4..c8bb66e 100644 (file)
@@ -4,35 +4,43 @@
 # Bug-Reports:   see http://grml.org/bugs/
 # License:       This file is licensed under the GPL v2 or any later version.
 ################################################################################
+# !!!!!! IMPORTANT NOTE !!!!!
+# This file is meant as a reference. Please adjust your local configuration
+# via /etc/grml/grml-live.local instead as this file is marked as configuration
+# file in your package management.
+# !!!!!! IMPORTANT NOTE !!!!!
+################################################################################
 
 # Main output directory
 # Please notice that you need suid,dev,rw permissions there
-OUTPUT="/grml/grml-live"
+OUTPUT="/grml/grml-live"
 # You have enough RAM? Use shared memory for fast testing-purposes:
 # OUTPUT="/dev/shm" # mount -o remount,suid,dev,rw /dev/shm
 
 # Where do want to find the chroot of the buildprocess files?
-CHROOT_OUTPUT="$OUTPUT/grml_chroot"
+CHROOT_OUTPUT="$OUTPUT/grml_chroot"
 # Where do you want to find the compressed chroot, bootstuff,...?
-BUILD_OUTPUT="$OUTPUT/grml_cd"
+BUILD_OUTPUT="$OUTPUT/grml_cd"
 # Where do you want to find the final ISO?
-ISO_OUTPUT="$OUTPUT/grml_isos"
+ISO_OUTPUT="$OUTPUT/grml_isos"
 
 # Do you want to zero / clean up the logfile on each grml-live execution?
 # Especially useful if you are using an autobuild setup where you want
 # store /var/log/grml-live.log after each invocation of grml-live.
 # Default: unset (so do not zero the logfile)
-#ZERO_LOGFILE='1'
+# ZERO_LOGFILE='1'
 
 # Do you want to zero / clean up / remove the previous logfiles of FAI
 # before executing grml-live? Otherwise keep all the logfiles inside
 # /var/log/fai/$HOSTNAME/...
 # Default: unset (so do not remove the logfile(s))
-#ZERO_FAI_LOGFILE='1'
+# ZERO_FAI_LOGFILE='1'
 
 # Which Debian suite to you want to use? Unless it is set it defaults to "lenny"
-# Supported values are: etch, lenny, squeeze, sid
-# SUITE="sid"
+# Supported values are: etch, lenny, sid
+#                       squeeze -> requires /etc/grml/fai/config/basefiles/....tar.gz
+#                                  or a recent version of debootstrap
+# SUITE="lenny"
 
 # Which FAI classes do you want to use by default?#
 
@@ -40,22 +48,23 @@ ISO_OUTPUT="$OUTPUT/grml_isos"
 # are doing; make sure to also use a GRML_* class (for example GRML_SMALL,
 # GRML_MEDIUM or GRML_FULL) to get an according kernel and also select the
 # architecture (I386 for x86; AMD64 for x86_64)
-CLASSES="GRMLBASE,GRML_MEDIUM,I386"
+CLASSES="GRMLBASE,GRML_MEDIUM,I386"
 
 ## Which mirrors do you want to use? Please set GRML_LIVE_SOURCES *and*
 ## *FAI_DEBOOTSTRAP* accordingly. To use a local directory (like an NFS mount)
 ## check out MIRROR_DIRECTORY and MIRROR_SOURCES as well.
 
-# Do you want to generate /etc/grml/fai/apt/sources.list on-the-fly via grml-live?
-# If so then activate the according mirrors using GRML_LIVE_SOURCES=...
+# Which Debian mirror do you want to use for main packages (after debootstrapping
+# has been finished)?
 # If you do *not* set GRML_LIVE_SOURCES here then grml-live will just take what
-# /etc/grml/fai/apt/sources.list provides by default.
-# Use the variable like your /etc/apt/sources.list looks like.
-#GRML_LIVE_SOURCES="
+# /etc/grml/fai/apt/sources.list provides by default. But please do *not*
+# manually edit /etc/grml/fai/apt/sources.list but instead use $GRML_LIVE_SOURCES.
+# Use the variable as your /etc/apt/sources.list looks like.
+# GRML_LIVE_SOURCES="
 #deb http://192.168.1.112/debian     lenny        main contrib non-free
 #deb http://deb.grml.org/            grml-stable  main
 #deb http://deb.grml.org/            grml-testing main
-#deb http://ftp.de.debian.org/debian etch         main contrib non-free
+#deb http://cdn.debian.net/debian etch         main contrib non-free
 #"
 
 # Which Debian suite and which mirror do you want to use for debootstrapping?
@@ -63,7 +72,7 @@ CLASSES="GRMLBASE,GRML_MEDIUM,I386"
 # taken. If you specify a value then the file /etc/grml/fai/make-fai-nfsroot.conf
 # will be updated by grml-live on-the-fly.
 # Usage: "<suite> <mirror>"
-# FAI_DEBOOTSTRAP="lenny http://ftp.de.debian.org/debian"
+# FAI_DEBOOTSTRAP="lenny http://cdn.debian.net/debian"
 
 # Do you want to use a local mirror (like NFS) as well?
 # If so specify the directory where debian/ is available:
@@ -72,20 +81,20 @@ CLASSES="GRMLBASE,GRML_MEDIUM,I386"
 # MIRROR_SOURCES="deb file:///mnt/mirror/debian sid main contrib non-free"
 
 # Version number of ISO:
-VERSION="0.0-1"
+VERSION="0.0-1"
 
 # Name of the release:
-RELEASENAME="grml-live just rocks!"
+# RELEASENAME="grml-live rocks"
 
 # Which "grml flavour name" do you want to use?
 # Common usage examples: grml, grml-small, grml64,...
-GRML_NAME="grml"
+GRML_NAME="grml"
 
 # Specify hostname of the live-system:
-HOSTNAME=grml
+HOSTNAME=grml
 
 # Specify user with UID 1000 on live-system:
-USERNAME=grml
+USERNAME=grml
 
 # Specify options for Squashfs build stage (running mksquashfs):
 # SQUASHFS_OPTIONS="-nolzma"
@@ -95,7 +104,13 @@ USERNAME=grml
 # BOOT_METHOD='isolinux'
 
 # Directory of configuration files for grml-live's FAI:
-GRML_FAI_CONFIG=/etc/grml/fai
+# GRML_FAI_CONFIG=/etc/grml/fai
+
+# Do you want to put any local files into the chroot?
+# If so then point CHROOT_INSTALL to a directory providing the files.
+# Note: the files are installed under '/' in the chroot -
+# so you have to create the rootfs structure on your own.
+# CHROOT_INSTALL="$GRML_FAI_CONFIG/chroot_install"
 
 # Do you want to pass any additional arguments to FAI?
 # FAI_ARGS=""
@@ -107,18 +122,53 @@ GRML_FAI_CONFIG=/etc/grml/fai
 # It defaults to output of 'dpkg --print-architecture'
 # ARCH="i386"
 
+# Name of distribution that should be build. By default
+# it's "grml", if you want to adjust please make sure
+# your distri name is just one single word so it
+# works on the boot prompt.
+# DISTRI_NAME="grml"
+
+# Short information about the distribution. Default:
+# DISTRI_INFO="Grml - Live Linux for system administrators   "
+
+# Bootsplash background image use in isolinux configuration
+# Note: not relevant if using non-default ISOLINUX_METHOD="console".
+# DISTRI_SPLASH='grml.png'
+
 # Do you want to use your own templates? If so set the
 # template directory but please make sure it looks
 # likes the default directory [/usr/share/grml-live/templates]
 # TEMPLATE_DIRECTORY='/usr/share/grml-live/templates'
 
+# Do you want to use console based isolinux boot splash
+# instead of the default graphical menu?
+# ISOLINUX_METHOD="console"
+
+# Do you want to skip adding /boot/addons/ (from the template directory)?
+# NO_ADDONS='1'
+
+# Do you want to skip adding /boot/addons/bsd4grml/ (from the template directory)?
+# NO_ADDONS_BSD4GRML='1'
+
+# By default the ISO is created for hybrid boot, so you can either
+# boot the CD using normal el torito mode or copy it to USB device
+# *without* having to run grml2usb (like: 'dd if=grml.iso of=/dev/sdX')
+# - working both with the same ISO
+# HYBRID_METHOD='disable'   # do not create a hybrid ISO
+# HYBRID_METHOD='isohybrid' # use isohybrid instead of the default (being manifold)
+
+# Binary that should be used for creating the squashfs file.
+# Defaults to mksquashfs-lzma if available or falls back to mksquashfs.
+# SQUASHFS_BINARY='mksquashfs'
+
 # exclude files from compressed squashfs file using the
 # the mksquashfs option -ef:
 # SQUASHFS_EXCLUDES_FILE="/etc/grml/fai/squashfs-excludes"
 
-# Do you want to download pageant, plink, pscp, psftp, putty and puttygen
+# Skip download of pageant, plink, pscp, psftp, putty and puttygen
 # using wget to store it inside $BUILD_OUTPUT/windows/?
-# Just unset it do skip download via wget or modify the download URL.
-WINDOWS_BINARIES="http://the.earth.li/~sgtatham/putty/latest/x86/"
+# NO_WINDOWS_BINARIES="1"
+# URL for downloading the windows files:
+# WINDOWS_BINARIES="http://the.earth.li/~sgtatham/putty/latest/x86/"
 
 ## END OF FILE #################################################################