# Authors: grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
# Bug-Reports: see http://grml.org/bugs/
# License: This file is licensed under the GPL v2 or any later version.
-# Latest change: Tue Sep 18 09:31:39 CEST 2007 [mika]
################################################################################
+# !!!!!! 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"
+# 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"
+# Where do you want to find the compressed chroot, bootstuff,...?
+# BUILD_OUTPUT="$OUTPUT/grml_cd"
+# Where do you want to find the final ISO?
+# ISO_OUTPUT="$OUTPUT/grml_isos"
-# main output directory
-# please notice that you need suid,dev,rw permissions there
-TARGET="/grml/grml-live"
-# TARGET="/dev/shm" # mount -o remount,suid,dev,rw /dev/shm
+# 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'
-# chroot of the buildprocess files:
-CHROOT_TARGET="$TARGET/grml_chroot"
-# where do you want to find the compressed chroot, bootstuff,...?
-BUILD_TARGET="$TARGET/grml_cd"
-# where do you want to find the final ISO?
-ISO_TARGET="$TARGET/grml_isos"
+# 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'
-# which Debian suite to you want to use? unless set it defaults to "etch"
-# supported values: stable, testing, unstable, etch, lenny, sid
-# SUITE="sid"
+# Which Debian suite to you want to use? Unless it is set it defaults to "lenny"
+# 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?
-# notice: GRMLBASE is recommended in any case unless you *really*
-# know what you are doing; class I386 provides the kernel
-CLASSES="GRMLBASE,I386"
+# Which FAI classes do you want to use by default?#
+
+# Notice: GRMLBASE is recommended in any case unless you *really* know what you
+# 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"
## Which mirrors do you want to use? Please set GRML_LIVE_SOURCES *and*
-## *FAI_DEBOOTSTRAP* according!
-
-# 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=...
-# If you do *not* set GRML_LIVE_SOURCES then grml-live will just take what
-# /etc/grml/fai/apt/sources.list provides by default
-# Usage: like your /etc/apt/sources.list looks like
-#GRML_LIVE_SOURCES="
-#deb http://192.168.1.112/debian etch main contrib non-free
+## *FAI_DEBOOTSTRAP* accordingly. To use a local directory (like an NFS mount)
+## check out MIRROR_DIRECTORY and MIRROR_SOURCES as well.
+
+# 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. 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
#"
-# Which Debian flavour and which mirror do you want to use for basic debootstrapping?
+# Which Debian suite and which mirror do you want to use for debootstrapping?
# Unless specified the default from /etc/grml/fai/make-fai-nfsroot.conf will be
# 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: <flavour> <mirror>
-# FAI_DEBOOTSTRAP="etch http://ftp.de.debian.org/debian"
+# Usage: "<suite> <mirror>"
+# FAI_DEBOOTSTRAP="lenny http://ftp.de.debian.org/debian"
+
+# Do you want to use a local mirror (like NFS) as well?
+# If so specify the directory where debian/ is available:
+# MIRROR_DIRECTORY="/mnt/mirror"
+# ... and the sources.list entry for the directory:
+# MIRROR_SOURCES="deb file:///mnt/mirror/debian sid main contrib non-free"
+
+# Version number of ISO:
+# VERSION="0.0-1"
+
+# Name of the release:
+# RELEASENAME="grml-live rocks"
+
+# Which "grml flavour name" do you want to use?
+# Common usage examples: grml, grml-small, grml64,...
+# GRML_NAME="grml"
+
+# Specify hostname of the live-system:
+# HOSTNAME=grml
+
+# Specify user with UID 1000 on live-system:
+# USERNAME=grml
-# directory of configuration files for grml-live's FAI:
-GRML_FAI_CONFIG=/etc/grml/fai
+# Specify options for Squashfs build stage (running mksquashfs):
+# SQUASHFS_OPTIONS="-nolzma"
-# specify hostname of the live-system:
-HOSTNAME=grml
+# Which bootloader do you want to use? Default: isolinux
+# Supported values: isolinux, grub
+# BOOT_METHOD='isolinux'
-# specify user with UID 1000 on live-system:
-USERNAME=grml
+# Directory of configuration files for grml-live's FAI:
+# GRML_FAI_CONFIG=/etc/grml/fai
-# do you want to pass any additional arguments to 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=""
-# which architecture do you want to build?
-# defaults to output of 'dpkg --print-architecture'
+# Where do you want to store grml-live.log?
+# LOGDIR="/var/log/fai/$HOSTNAME/last"
+
+# Which architecture do you want to build?
+# It defaults to output of 'dpkg --print-architecture'
# ARCH="i386"
-# do you want to download pageant, plink, pscp, psftp, putty and puttygen
-# to store it inside $BUILD_TARGET/windows/?
-# just unset it do skip download via wget or modify URL
-WINDOWS_BINARIES="http://the.earth.li/~sgtatham/putty/latest/x86/"
+# 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)
+
+# exclude files from compressed squashfs file using the
+# the mksquashfs option -ef:
+# SQUASHFS_EXCLUDES_FILE="/etc/grml/fai/squashfs-excludes"
+
+# Skip download of pageant, plink, pscp, psftp, putty and puttygen
+# using wget to store it inside $BUILD_OUTPUT/windows/?
+# NO_WINDOWS_BINARIES="1"
+# URL for downloading the windows files:
+# WINDOWS_BINARIES="http://the.earth.li/~sgtatham/putty/latest/x86/"
## END OF FILE #################################################################
projects / grml-live.git / blobdiff