Do not fail in upgrade mode (-u) when configuration files have been modified
[grml-live.git] / etc / grml / grml-live.conf
index d3ead56..84fe564 100644 (file)
@@ -3,37 +3,55 @@
 # 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: Fri Jan 11 01:55:54 CET 2008 [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"
+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"
+# Where do you want to find the netboot package?
+# NETBOOT="${OUTPUT}/netboot/"
+
+# Do you want to preserve the logfile from being cleaned after each execution
+# of grml-live? By default the logfile is cleaned so the log doesn't fill up.
+# If you want to store your logs permanently it's recommended to use grml-live-db.
+# PRESERVE_LOGFILE='1'
+
+# If package grml-live-db is installed the package selection and grml-live.log
+# are being logged to to a sqlite database.Defaults to /var/log/grml-live.db
+# DPKG_DATABASE=/var/log/grml-live.db
 
-# 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'
+# Use your own database wrapper script for grml-live-db:
+# DPKG_DBSCRIPT=/usr/share/grml-live-db/scripts/dpkg-to-db
+
+# Use your own database script cmdline options for grml-live-db:
+# DPKG_DBOPTIONS="-d $DPKG_DATABASE --logfile $LOGFILE --flavour $GRML_NAME < $DPKG_LIST"
 
 # 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 "etch"
-# Supported values are: etch, lenny, sid
-# SUITE="sid"
+# Which Debian suite/release do you want to use?
+# Supported values are: stable, testing, unstable (or their corresponding release
+# names like "wheezy").
+# Unless it is set it defaults to "testing".
+# SUITE="unstable"
 
 # Which FAI classes do you want to use by default?#
 
@@ -41,66 +59,51 @@ 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"
-
-## 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=...
-# 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="
-#deb http://192.168.1.112/debian     etch         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
-#"
+# CLASSES="GRMLBASE,GRML_FULL,I386"
+
+# HTTP Proxy to use for APT
+# APT_PROXY="http://localhost:3142/"
 
 # 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: "<suite> <mirror>"
-# FAI_DEBOOTSTRAP="etch http://ftp.de.debian.org/debian"
+# FAI_DEBOOTSTRAP="wheezy http://http.debian.net/debian"
 
-# Do you want to use a local mirror (like NFS) as well?
+# Do you want to use a local mirror (like NFS)?
 # 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"
-
-# Use ZLIB instead of LZMA compression? Faster and available in older
-# squashfs versions as well but not such a good compression.
-# SQUASHFS_ZLIB=1
+# MIRROR_DIRECTORY="/media/mirror"
+# ... and then set up an according class file in
+# ${GRML_FAI_CONFIG}/config/files/etc/apt/sources.list.d/
+# containing something like:
+# deb file:///media/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
-
-# Specify options for Squashfs build stage (running mksquashfs):
-# SQUASHFS_OPTIONS="-nolzma"
+# USERNAME=grml
 
 # Which bootloader do you want to use? Default: isolinux
-# Supported values: isolinux, grub
+# Supported values: isolinux, grub, grub2
 # 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=""
@@ -112,14 +115,71 @@ 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 download 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/"
+# 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 from SYSLINUX
+# HYBRID_METHOD='grub2'     # use manifold with GRUB 2
+# HYBRID_METHOD='manifold'  # use manifold with ISOLINUX (default)
+
+# Binary that should be used for creating the squashfs file.
+# Defaults to the executable matching the kernel version, falls back to mksquashfs.
+# SQUASHFS_BINARY='mksquashfs'
+
+# Options that should be used by mksquashfs during build process.
+# Defaults to '-b 256k' and the according LZMA/XZ option.
+# SQUASHFS_OPTIONS='-b 256k'
+
+# exclude files from compressed squashfs file using the
+# the mksquashfs option -ef:
+# SQUASHFS_EXCLUDES_FILE="${GRML_FAI_CONFIG}/config/grml/squashfs-excludes"
+
+# Do you want to exit grml-live if some packages were requested for installation
+# on fresh installs but are missing on the generated ISO finally?
+# By default the package list is sent to stdout but grml-live doesn't interrupt.
+# EXIT_ON_MISSING_PACKAGES=1
+
+# Do you want to use a special string for identifying the ISO?
+# By default the grml-name and version string are used as a base for generating
+# /conf/bootid.txt on the ISO. If you want to use a different value feel free to
+# adjust it accordingly.
+# Please notice that space characters inside this variable are not supported.
+# BOOTID="mybootid"
+
+# Do you want to skip the /conf/bootid.txt feature?
+# NO_BOOTID='1'
+
+# Do you want to add any additional bootoptions that should be used by default?
+# DEFAULT_BOOTOPTIONS="ssh=secret"
 
 ## END OF FILE #################################################################