3 # Purpose: build process script for generating a (grml based) Linux Live-ISO
4 # Authors: grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
5 # Bug-Reports: see http://grml.org/bugs/
6 # License: This file is licensed under the GPL v2 or any later version.
7 # Latest change: Sun Oct 28 15:26:10 CET 2007 [mika]
8 ################################################################################
10 # read configuration files, set some misc variables {{{
18 GRML_LIVE_VERSION='0.0.7'
20 ISO_DATE="$(date +%Y-%m-%d)"
22 # we need root permissions for the build-process:
23 if [ "$(id -u 2>/dev/null)" != 0 ] ; then
24 echo "Error: please run this script with uid 0 (root)." >&2
28 if [ -r /var/run/fai/FAI_INSTALLATION_IN_PROGRESS ] ; then
29 echo "/usr/sbin/fai already running or was aborted before.">&2
30 echo "You may remove /var/run/fai/FAI_INSTALLATION_IN_PROGRESS and try again.">&2
34 # make sure they are not set by default
38 if [ -r /etc/grml/lsb-functions ] ; then
39 . /etc/grml/lsb-functions
41 einfo() { echo " [*] $*" ;}
42 eerror() { echo " [!] $*">&2 ;}
43 ewarn() { echo " [x] $*" ;}
47 # source main configuration file:
48 LIVE_CONF=/etc/grml/grml-live.conf
56 [ -n "$MIRROR_DIRECTORY" ] && umount "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
57 [ -n "$1" ] && EXIT="$1" || EXIT="1"
58 [ -n "$2" ] && eerror "$2">&2
59 log "------------------------------------------------------------------------------"
65 # check for important variables {{{
66 [ -n "$GRML_FAI_CONFIG" ] || GRML_FAI_CONFIG=/etc/grml/fai
67 [ -n "$HOSTNAME" ] || HOSTNAME=grml
68 [ -n "$USERNAME" ] || USERNAME=grml
69 [ -n "$CLASSES" ] || CLASSES="GRML,I386"
70 [ -n "$BOOT_METHOD" ] || BOOT_METHOD='isolinux'
71 [ -n "$OUTPUT" ] || bailout 1 "${PN}: \$OUTPUT not specified. Please adjust $LIVE_CONF. Exiting."
73 [ -n "$VERSION" ] || VERSION="0.0.1"
74 [ -n "$RELEASENAME" ] || RELEASENAME="grml-live rocks"
75 [ -n "$GRML_NAME" ] || GRML_NAME='grml'
78 if [ -z "$LOGFILE" ] ; then
79 LOGFILE=/var/log/grml-live.log
82 chown root:adm $LOGFILE
85 if [ -n "$ZERO_LOGFILE" ] ; then
89 NFSROOT_CONF=/etc/grml/fai/make-fai-nfsroot.conf
93 # some important functions {{{
96 # usage: log "string to log"
97 log() { echo "$*" >> $LOGFILE ; }
99 # cut string at character number int = $1
100 # usage: cut_string 5 "1234567890" will output "12345"
102 [ -n "$2" ] || return 1
103 echo "$2" | head -c "$1"; echo -ne "\n"
106 # prepend int = $1 spaces before string = $2
107 # usage: extend_string_begin 5 "123" will output " 123"
108 extend_string_begin() {
109 [ -n "$2" ] || return 1
110 local COUNT="$(echo $2 | wc -c)"
111 local FILL="$(expr $COUNT - $1)"
112 while [ "$FILL" -gt 1 ] ; do
114 local FILL=$(expr $FILL - 1)
116 while [ "$FILL" -lt 1 ] ; do
118 local FILL=$(expr $FILL + 1)
120 echo "$2" | head -c "$1"; echo -ne "\n"
123 # append int = $1 spaces to string = $2
124 # usage: extend_string_begin 5 "123" will output "123 "
125 extend_string_end() {
126 [ -n "$2" ] || return 1
127 echo -n "$2" | head -c "$1"
128 local COUNT="$(echo $2 | wc -c)"
129 local FILL="$(expr $COUNT - $1)"
130 while [ "$FILL" -gt 1 ] ; do
132 local FILL=$(expr $FILL - 1)
134 while [ "$FILL" -lt 1 ] ; do
136 local FILL=$(expr $FILL + 1)
142 # usage information {{{
146 $PN - build process script for generating a (grml based) Linux Live-ISO
148 Usage: $PN [-a <architecture>] [-c <classe[s]>] [-g <grml_name>] \\
149 [-i <iso_name> ] [-o <output_directory>] [-s <suite>] \\
150 [-t <template_directory>] [-s <suite>] \\
151 [-v <version_number>] [-FVh]
156 $PN -c GRMLBASE,GRML_SMALL,I386 -o /grml/
157 $PN -c GRMLBASE,GRML_MEDIUM,I386 -o /dev/shm/grml
158 $PN -c GRMLBASE,GRML_SMALL,I386 -g grml-small -v 1.0
159 $PN -c GRMLBASE,GRML_FULL,I386 -i grml_0.0-1.iso -v 0.0-1
160 $PN -c GRMLBASE,GRML_FULL,I386 -s sid -V -r 'grml-live rocks'
162 More details: man grml-live
163 /usr/share/doc/grml-live/grml-live.html
165 Please send your bug reports, feedback,.. to the grml-team.
166 http://grml.org/bugs/
171 # command line parsing {{{
173 while getopts "a:c:g:i:o:r:s:t:v:FhV" opt; do
176 c) CLASSES="$OPTARG" ;;
177 g) GRML_NAME="$OPTARG" ;;
178 i) ISO_NAME="$OPTARG" ;;
180 CHROOT_OUTPUT="$OUTPUT/grml_chroot"
181 BUILD_OUTPUT="$OUTPUT/grml_cd"
182 ISO_OUTPUT="$OUTPUT/grml_isos"
184 r) RELEASENAME="$OPTARG" ;;
185 s) SUITE="$OPTARG" ;;
186 t) TEMPLATE_DIRECTORY="$OPTARG";;
187 v) VERSION="$OPTARG" ;;
189 h) usage ; bailout 0 ;;
191 ?) echo "invalid option -$OPTARG" >&2; bailout 1 ;;
194 shift $(($OPTIND - 1)) # set ARGV to the first not parsed commandline parameter
197 # some misc checks before executing FAI {{{
198 [ -n "$CLASSES" ] || bailout 1 "Error: \$CLASSES unset, please set it in $LIVE_CONF or
199 specify it on the command line using the -c option."
200 [ -n "$OUTPUT" ] || bailout 1 "Error: \$OUTPUT unset, please set it in $LIVE_CONF or
201 specify it on the command line using the -o option."
204 # ask user whether the setup is ok {{{
205 if [ -z "$FORCE" ] ; then
207 echo "${PN} [${GRML_LIVE_VERSION}]: check your configuration (or use -F to force execution):"
209 echo " FAI classes: $CLASSES"
210 echo " main directory: $OUTPUT"
211 [ -n "$CHROOT_OUTPUT" ] && echo " chroot target: $CHROOT_OUTPUT"
212 [ -n "$BUILD_OUTPUT" ] && echo " build target: $BUILD_OUTPUT"
213 [ -n "$ISO_OUTPUT" ] && echo " ISO target: $ISO_OUTPUT"
214 [ -n "$GRML_NAME" ] && echo " grml name: $GRML_NAME"
215 [ -n "$RELEASENAME" ] && echo " release name: $RELEASENAME"
216 [ -n "$VERSION" ] && echo " grml version: $VERSION"
217 [ -n "$SUITE" ] && echo " Debian suite: $SUITE"
218 [ -n "$ARCH" ] && echo " Architecture: $ARCH"
219 [ -n "$BOOT_METHOD" ] && echo " Boot method: $BOOT_METHOD"
220 [ -n "$TEMPLATE_DIRECTORY" ] && echo " Template files: $TEMPLATE_DIRECTORY"
221 [ -n "$FAI_ARGS" ] && echo " additional arguments for FAI: $FAI_ARGS"
222 [ -n "$LOGFILE" ] && echo " Logging to file: $LOGFILE"
223 [ -n "$VERBOSE" ] && echo " Using VERBOSE mode."
225 echo -n "Is this ok for you? [y/N] "
227 if ! [ "$a" = 'y' -o "$a" = 'Y' ] ; then
228 bailout 1 "Exiting as requested."
233 start_seconds=$(cut -d . -f 1 /proc/uptime)
234 log "------------------------------------------------------------------------------"
235 log "Starting grml-live [${GRML_LIVE_VERSION}] run on $(date)"
236 log "Executed command line: $CMDLINE"
238 einfo "Logging actions to logfile $LOGFILE"
241 # on-the-fly configuration {{{
242 if [ -n "$MIRROR_DIRECTORY" ] ; then
243 if ! [ -d "$MIRROR_DIRECTORY/debian" ] ; then
244 log "Sorry, $MIRROR_DIRECTORY/debian does not seem to exist. Exiting. [$(date)]"
245 eerror "Sorry, $MIRROR_DIRECTORY/debian does not seem to exist. Exiting."
248 echo "$MIRROR_SOURCES" > /etc/grml/fai/apt/sources.list
249 if [ -n "$GRML_LIVE_SOURCES" ] ; then
250 echo "$GRML_LIVE_SOURCES" >> /etc/grml/fai/apt/sources.list
252 elif [ -n "$GRML_LIVE_SOURCES" ] ; then
253 echo "$GRML_LIVE_SOURCES" > /etc/grml/fai/apt/sources.list
256 if [ -n "$FAI_DEBOOTSTRAP" ] ; then
257 sed -i "s#^FAI_DEBOOTSTRAP=.*#FAI_DEBOOTSTRAP=\"$FAI_DEBOOTSTRAP\"#" $NFSROOT_CONF
260 # does this suck? YES!
261 if [ -n "$SUITE" ] ; then
262 sed -i "s/SUITE=.*/SUITE=\"$SUITE\"/" $LIVE_CONF
264 DIST="\|\ etch\ \|\ stable\ \|\ lenny\ \|\ testing\ \|\ sid\ \|\ unstable\ "
265 sed -i "s/\(deb .\+\)\([ \t]+\)$DIST\([ \t]+\)\(main \)/\1\2 $SUITE \3\4/" $LIVE_CONF
266 sed -i "s/\(deb .\+\)\([ \t]+\)$DIST\([ \t]+\)\(main \)/\1\2 $SUITE \3\4/" /etc/grml/fai/apt/sources.list
267 # notice: activate grml-live pool only if we are building against unstable:
268 if grep -qe unstable -qe sid /etc/grml/fai/apt/sources.list ; then
269 grep -q 'grml-live.*main' /etc/grml/fai/apt/sources.list || \
270 grep grml-stable /etc/grml/fai/apt/sources.list | \
271 sed 's/grml-stable/grml-live/' >> /etc/grml/fai/apt/sources.list
273 grep -q 'grml-live.*main' /etc/grml/fai/apt/sources.list && \
274 sed -i 's/.*grml-live.*/# removed grml-live repository/' /etc/grml/fai/apt/sources.list
277 sed -i "s|FAI_DEBOOTSTRAP=\"[a-z]* |FAI_DEBOOTSTRAP=\"$SUITE |" $LIVE_CONF
278 sed -i "s|FAI_DEBOOTSTRAP=\"[a-z]* |FAI_DEBOOTSTRAP=\"$SUITE |" $NFSROOT_CONF
282 [ -n "$ARCH" ] || ARCH="$(dpkg --print-architecture)"
283 if grep -q -- 'FAI_DEBOOTSTRAP_OPTS.*--arch' $NFSROOT_CONF ; then
284 sed -i "s/--arch [a-z0-9]* /--arch $ARCH /" $NFSROOT_CONF
286 sed -i "s|FAI_DEBOOTSTRAP_OPTS=\"\(.*\)|FAI_DEBOOTSTRAP_OPTS=\"--arch $ARCH \1|" $NFSROOT_CONF
290 # CHROOT_OUTPUT - execute FAI {{{
291 [ -n "$CHROOT_OUTPUT" ] || CHROOT_OUTPUT="$OUTPUT/grml_chroot"
293 if [ -d "$CHROOT_OUTPUT/bin" ] ; then
294 log "$CHROOT_OUTPUT exists already, skipping stage 'fai dirinstall'"
295 ewarn "$CHROOT_OUTPUT exists already, skipping stage 'fai dirinstall'" ; eend 0
297 mkdir -p "$CHROOT_OUTPUT" || bailout 5 "Problem with creating $CHROOT_OUTPUT for FAI"
298 if [ -n "${MIRROR_DIRECTORY}" ] ; then
299 mkdir -p "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
300 mount --bind "${MIRROR_DIRECTORY}" "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
302 fai $VERBOSE -C "$GRML_FAI_CONFIG" -c"$CLASSES" -u "$HOSTNAME" dirinstall "$CHROOT_OUTPUT" $FAI_ARGS | tee -a $LOGFILE
303 log "Setting /etc/grml_version to $GRML_NAME $VERSION Release Codename $RELEASENAME [$ISO_DATE]"
304 echo "$GRML_NAME $VERSION Release Codename $RELEASENAME [$ISO_DATE]" > $CHROOT_OUTPUT/etc/grml_version
305 chmod 644 $CHROOT_OUTPUT/etc/grml_version
306 umount $CHROOT_OUTPUT/proc 2>/dev/null || /bin/true
307 umount $CHROOT_OUTPUT/sys 2>/dev/null || /bin/true
308 [ -n "$MIRROR_DIRECTORY" ] && umount "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
310 # notice: 'fai dirinstall' does not seem to exit appropriate, so:
312 if [ -r "/var/log/fai/dirinstall/$HOSTNAME/software.log" ] ; then
313 # 1 errors during executing of commands
314 # Unable to write mmap - msync (28 No space left on device)
315 grep 'dpkg: error processing' /var/log/fai/dirinstall/$HOSTNAME/software.log >> $LOGFILE && ERROR=1
316 grep 'E: Method http has died unexpectedly!' /var/log/fai/dirinstall/$HOSTNAME/software.log >> $LOGFILE && ERROR=2
317 grep 'ERROR: chroot' /var/log/fai/dirinstall/$HOSTNAME/software.log >> $LOGFILE && ERROR=3
320 if [ -r "/var/log/fai/dirinstall/$HOSTNAME/shell.log" ] ; then
321 grep 'FAILED with exit code' /var/log/fai/dirinstall/$HOSTNAME/shell.log >> $LOGFILE && ERROR=2
324 if [ -n "$ERROR" ] ; then
325 log "There was an error [${ERROR}] during execution of stage 'fai dirinstall' [$(date)]"
326 eerror "There was an error during execution of stage 'fai dirinstall'"
327 echo " Check out /var/log/fai/dirinstall/$HOSTNAME/ for details. [exit ${ERROR}]"
331 log "Finished execution of stage 'fai dirinstall' [$(date)]"
332 einfo "Finished execution of stage 'fai dirinstall'"
337 # BUILD_OUTPUT - execute arch specific stuff and squashfs {{{
338 [ -n "$BUILD_OUTPUT" ] || BUILD_OUTPUT="$OUTPUT/grml_cd"
339 mkdir -p "$BUILD_OUTPUT" || bailout 6 "Problem with creating $BUILD_OUTPUT for stage ARCH"
342 if [ "$ARCH" = i386 ] || [ "$ARCH" = amd64 ] ; then
343 if [ -d "$BUILD_OUTPUT"/boot ] ; then
344 log "$BUILD_OUTPUT/boot exists already, skipping stage 'boot'"
345 ewarn "$BUILD_OUTPUT/boot exists already, skipping stage 'boot'" ; eend 0
348 mkdir -p "$BUILD_OUTPUT"/boot/isolinux
349 cp /boot/memtest86+.bin "$BUILD_OUTPUT"/boot/isolinux/memtest
351 # if we don't have an initrd we a) can't boot and b) there was an error
352 # during build, so check for the file:
353 if [ -f "$CHROOT_OUTPUT"/boot/initrd* ] ; then
354 cp "$CHROOT_OUTPUT"/boot/initrd* "$BUILD_OUTPUT"/boot/isolinux/initrd.gz
356 log "No initrd found inside $CHROOT_OUTPUT/boot/ - Exiting"
357 eerror "No initrd found inside $CHROOT_OUTPUT/boot/ - Exiting" ; eend 1
361 cp "$CHROOT_OUTPUT"/boot/vmlinuz* "$BUILD_OUTPUT"/boot/isolinux/linux26
362 cp /usr/lib/syslinux/chain.c32 "$BUILD_OUTPUT"/boot/isolinux/
363 cp /usr/lib/syslinux/isolinux.bin "$BUILD_OUTPUT"/boot/isolinux/
364 cp /usr/lib/syslinux/memdisk "$BUILD_OUTPUT"/boot/isolinux/
365 cp /usr/lib/syslinux/menu.c32 "$BUILD_OUTPUT"/boot/isolinux/
367 [ -n "$TEMPLATE_DIRECTORY" ] || TEMPLATE_DIRECTORY='/usr/share/grml-live/templates'
368 if ! [ -d "${TEMPLATE_DIRECTORY}"/boot ] ; then
369 log "${TEMPLATE_DIRECTORY}/boot does not exist. Exiting."
370 eerror "${TEMPLATE_DIRECTORY}/boot does not exist. Exiting." ; eend 1
373 cp ${TEMPLATE_DIRECTORY}/boot/isolinux/* "$BUILD_OUTPUT"/boot/isolinux/
374 cp ${TEMPLATE_DIRECTORY}/boot/isolinux/* "$BUILD_OUTPUT"/boot/isolinux/
375 cp -a ${TEMPLATE_DIRECTORY}/boot/grub "$BUILD_OUTPUT"/boot/
377 if ! [ -d "${TEMPLATE_DIRECTORY}"/GRML ] ; then
378 log "${TEMPLATE_DIRECTORY}/GRML does not exist. Exiting."
379 eerror "${TEMPLATE_DIRECTORY}/GRML does not exist. Exiting." ; eend 1
382 [ -d "$BUILD_OUTPUT"/GRML ] || mkdir "$BUILD_OUTPUT"/GRML
383 cp -a ${TEMPLATE_DIRECTORY}/GRML/* "$BUILD_OUTPUT"/GRML/
385 # adjust boot splash information:
386 RELEASE_INFO="$GRML_NAME $VERSION - Release Codename $RELEASENAME"
387 RELEASE_INFO="$(cut_string 68 "$RELEASE_INFO")"
388 RELEASE_INFO="$(extend_string_end 68 "$RELEASE_INFO")"
390 sed -i "s/%RELEASE_INFO%/$GRML_NAME $VERSION - $RELEASENAME/" "$BUILD_OUTPUT"/GRML/grml-version
391 sed -i "s/%DATE%/$ISO_DATE/" "$BUILD_OUTPUT"/GRML/grml-version
393 sed -i "s/%RELEASE_INFO%/$RELEASE_INFO/" "$BUILD_OUTPUT"/boot/isolinux/boot.msg
394 sed -i "s/%DATE%/$ISO_DATE/" "$BUILD_OUTPUT"/boot/isolinux/boot.msg
396 sed -i "s/%RELEASE_INFO%/$RELEASE_INFO/" "$BUILD_OUTPUT"/boot/isolinux/boot-beep.msg
397 sed -i "s/%DATE%/$ISO_DATE/" "$BUILD_OUTPUT"/boot/isolinux/boot-beep.msg
399 sed -i "s/%VERSION%/$VERSION/" "$BUILD_OUTPUT"/boot/grub/menu.lst
400 sed -i "s/%GRML_NAME%/$GRML_NAME/" "$BUILD_OUTPUT"/boot/grub/menu.lst
402 # autostart for Windows:
403 if [ -d "${TEMPLATE_DIRECTORY}/windows/autostart/" ] ; then
404 cp ${TEMPLATE_DIRECTORY}/windows/autostart/* "$BUILD_OUTPUT"/
407 if [ -n "$WINDOWS_BINARIES" ] ; then
408 if [ -f "$BUILD_OUTPUT"/windows/putty.exe ] ; then
409 log "$BUILD_OUTPUT/windows exists already, skipping stage 'WINDOWS_BINARIES'"
410 ewarn "$BUILD_OUTPUT/windows exists already, skipping stage 'WINDOWS_BINARIES'" ; eend 0
412 mkdir "$BUILD_OUTPUT"/windows
413 ( cd "$BUILD_OUTPUT"/windows
414 for file in pageant plink pscp psftp putty puttygen ; do
415 wget -O ${file}.exe ${WINDOWS_BINARIES}/${file}.exe
418 log "Finished execution of stage 'WINDOWS_BINARIES' [$(date)]"
419 einfo "Finished execution of stage 'WINDOWS_BINARIES'" ; eend 0
421 einfo "Finished execution of stage 'boot'" ; eend 0
424 elif [ "$ARCH" = powerpc ] ; then
425 ewarn 'Warning: formorer, it is your turn. :)'>&2
428 eerror 'Error: Unsupported ARCH, sorry. Want to support it? Contribute!' ; eend 1
431 if [ -f "$BUILD_OUTPUT"/live/grml.squashfs ] ; then
432 log "$BUILD_OUTPUT/live exists already, skipping stage 'squashfs'"
433 ewarn "$BUILD_OUTPUT/live exists already, skipping stage 'squashfs'" ; eend 0
435 mkdir "$BUILD_OUTPUT"/live
436 mksquashfs $CHROOT_OUTPUT/* $BUILD_OUTPUT/live/grml.squashfs -noappend
437 log "Finished execution of stage 'squashfs' [$(date)]"
438 einfo "Finished execution of stage 'squashfs'" ; eend 0
441 # create md5sum file:
442 ( cd $BUILD_OUTPUT/GRML &&
443 find .. -type f -not -name md5sums -not -name isolinux.bin -exec md5sum {} \; > md5sums )
446 # ISO_OUTPUT - mkisofs {{{
447 [ -n "$ISO_OUTPUT" ] || ISO_OUTPUT="$OUTPUT/grml_isos"
448 [ -n "$ISO_NAME" ] || ISO_NAME="${GRML_NAME}_${VERSION}.iso"
450 if [ "$BOOT_METHOD" = "isolinux" ] ; then
451 BOOT_FILE="boot/isolinux/isolinux.bin -c boot/isolinux/boot.cat"
452 elif [ "$BOOT_METHOD" = "grub" ] ; then
453 BOOT_FILE="boot/grub/stage2_eltorito"
456 if [ -f "${ISO_OUTPUT}/${ISO_NAME}" ] ; then
457 log "$ISO_OUTPUT exists already, skipping stage 'iso build'"
458 ewarn "$ISO_OUTPUT exists already, skipping stage 'iso build'" ; eend 0
460 mkdir -p "$ISO_OUTPUT" || bailout 6 "Problem with creating $ISO_OUTPUT for stage 'iso build'"
462 cd "$BUILD_OUTPUT" &&
463 mkisofs -V "grml $VERSION" -publisher 'grml-live | grml.org' \
464 -l -r -J -no-emul-boot -boot-load-size 4 -boot-info-table \
466 -o "${ISO_OUTPUT}/${ISO_NAME}" . ; RC=$?
468 if [ "$RC" = 0 ] ; then
469 log "Finished execution of stage 'iso build' [$(date)]"
470 einfo "Finished execution of stage 'iso build'" ; eend 0
472 log "There was an error ($RC) executing stage 'iso build' [$(date)]"
473 eerror "There was an error executing stage 'iso build'" ; eend 1
480 [ -n "$start_seconds" ] && SECONDS="$[$(cut -d . -f 1 /proc/uptime)-$start_seconds]" || SECONDS="unknown"
481 einfo "Sucessfully finished execution of $PN [running ${SECONDS} seconds]" ; eend 0
482 log "Sucessfully finished execution of $PN [running ${SECONDS} seconds]"
486 ## END OF FILE #################################################################
487 # vim:foldmethod=marker ts=2 ft=sh ai expandtab tw=80 sw=3