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: Wed Oct 24 10:11:02 CEST 2007 [mika]
8 ################################################################################
10 # read configuration files, set some misc variables {{{
18 GRML_LIVE_VERSION='0.0.7'
20 # we need root permissions for the build-process:
21 if [ "$(id -u 2>/dev/null)" != 0 ] ; then
22 echo "Error: please run this script with uid 0 (root)." >&2
26 if [ -r /var/run/fai/FAI_INSTALLATION_IN_PROGRESS ] ; then
27 echo "/usr/sbin/fai already running or was aborted before.">&2
28 echo "You may remove /var/run/fai/FAI_INSTALLATION_IN_PROGRESS and try again.">&2
32 # make sure they are not set by default
36 if [ -r /etc/grml/lsb-functions ] ; then
37 . /etc/grml/lsb-functions
39 einfo() { echo " [*] $*" ;}
40 eerror() { echo " [!] $*">&2 ;}
41 ewarn() { echo " [x] $*" ;}
45 # source main configuration file:
46 LIVE_CONF=/etc/grml/grml-live.conf
54 [ -n "$MIRROR_DIRECTORY" ] && umount "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
55 [ -n "$1" ] && EXIT="$1" || EXIT="1"
56 [ -n "$2" ] && eerror "$2">&2
62 # check for important variables {{{
63 [ -n "$GRML_FAI_CONFIG" ] || GRML_FAI_CONFIG=/etc/grml/fai
64 [ -n "$HOSTNAME" ] || HOSTNAME=grml
65 [ -n "$USERNAME" ] || USERNAME=grml
66 [ -n "$CLASSES" ] || CLASSES="GRML,I386"
67 [ -n "$BOOT_METHOD" ] || BOOT_METHOD='isolinux'
68 [ -n "$OUTPUT" ] || bailout 1 "${PN}: \$OUTPUT not specified. Please adjust $LIVE_CONF. Exiting."
70 [ -n "$VERSION" ] || VERSION="0.0.1"
71 [ -n "$RELEASENAME" ] || RELEASENAME="grml-live rocks"
72 [ -n "$GRML_NAME" ] || GRML_NAME='grml'
74 [ -d /var/log/grml-live ] || mkdir /var/log/grml-live
75 LOGFILE=/var/log/grml-live/"$(date +%Y-%m-%d)_$$.log"
77 NFSROOT_CONF=/etc/grml/fai/make-fai-nfsroot.conf
81 # some important functions {{{
84 # usage: log "string to log"
85 log() { echo "$*" >> $LOGFILE ; }
87 # cut string at character number int = $1
88 # usage: cut_string 5 "1234567890" will output "12345"
90 [ -n "$2" ] || return 1
91 echo "$2" | head -c "$1"; echo -ne "\n"
94 # prepend int = $1 spaces before string = $2
95 # usage: extend_string_begin 5 "123" will output " 123"
96 extend_string_begin() {
97 [ -n "$2" ] || return 1
98 local COUNT="$(echo $2 | wc -c)"
99 local FILL="$(expr $COUNT - $1)"
100 while [ "$FILL" -gt 1 ] ; do
102 local FILL=$(expr $FILL - 1)
104 while [ "$FILL" -lt 1 ] ; do
106 local FILL=$(expr $FILL + 1)
108 echo "$2" | head -c "$1"; echo -ne "\n"
111 # append int = $1 spaces to string = $2
112 # usage: extend_string_begin 5 "123" will output "123 "
113 extend_string_end() {
114 [ -n "$2" ] || return 1
115 echo -n "$2" | head -c "$1"
116 local COUNT="$(echo $2 | wc -c)"
117 local FILL="$(expr $COUNT - $1)"
118 while [ "$FILL" -gt 1 ] ; do
120 local FILL=$(expr $FILL - 1)
122 while [ "$FILL" -lt 1 ] ; do
124 local FILL=$(expr $FILL + 1)
130 # usage information {{{
134 $PN - build process script for generating a (grml based) Linux Live-ISO
136 Usage: $PN [-a <architecture>] [-c <classe[s]>] [-g <grml_name>] \\
137 [-i <iso_name> ] [-o <output_directory>] [-s <suite>] \\
138 [-t <template_directory>] [-s <suite>] \\
139 [-v <version_number>] [-FVh]
144 $PN -c GRMLBASE,GRML_SMALL,I386 -o /grml/
145 $PN -c GRMLBASE,GRML_MEDIUM,I386 -o /dev/shm/grml
146 $PN -c GRMLBASE,GRML_SMALL,I386 -g grml-small -v 1.0
147 $PN -c GRMLBASE,GRML_FULL,I386 -i grml_0.0-1.iso -v 0.0-1
148 $PN -c GRMLBASE,GRML_FULL,I386 -s sid -V -r 'grml-live rocks'
150 More details: man grml-live
151 /usr/share/doc/grml-live/grml-live.html
153 Please send your bug reports, feedback,.. to the grml-team.
154 http://grml.org/bugs/
159 # command line parsing {{{
161 while getopts "a:c:g:i:o:r:s:t:v:FhV" opt; do
164 c) CLASSES="$OPTARG" ;;
165 g) GRML_NAME="$OPTARG" ;;
166 i) ISO_NAME="$OPTARG" ;;
168 CHROOT_OUTPUT="$OUTPUT/grml_chroot"
169 BUILD_OUTPUT="$OUTPUT/grml_cd"
170 ISO_OUTPUT="$OUTPUT/grml_isos"
172 r) RELEASENAME="$OPTARG" ;;
173 s) SUITE="$OPTARG" ;;
174 t) TEMPLATE_DIRECTORY="$OPTARG";;
175 v) VERSION="$OPTARG" ;;
177 h) usage ; bailout 0 ;;
179 ?) echo "invalid option -$OPTARG" >&2; bailout 1 ;;
182 shift $(($OPTIND - 1)) # set ARGV to the first not parsed commandline parameter
185 # some misc checks before executing FAI {{{
186 [ -n "$CLASSES" ] || bailout 1 "Error: \$CLASSES unset, please set it in $LIVE_CONF or
187 specify it on the command line using the -c option."
188 [ -n "$OUTPUT" ] || bailout 1 "Error: \$OUTPUT unset, please set it in $LIVE_CONF or
189 specify it on the command line using the -o option."
192 # ask user whether the setup is ok {{{
193 if [ -z "$FORCE" ] ; then
195 echo "${PN} [${GRML_LIVE_VERSION}]: check your configuration (or use -F to force execution):"
197 echo " FAI classes: $CLASSES"
198 echo " main directory: $OUTPUT"
199 [ -n "$CHROOT_OUTPUT" ] && echo " chroot target: $CHROOT_OUTPUT"
200 [ -n "$BUILD_OUTPUT" ] && echo " build target: $BUILD_OUTPUT"
201 [ -n "$ISO_OUTPUT" ] && echo " ISO target: $ISO_OUTPUT"
202 [ -n "$GRML_NAME" ] && echo " grml name: $GRML_NAME"
203 [ -n "$RELEASENAME" ] && echo " release name: $RELEASENAME"
204 [ -n "$VERSION" ] && echo " grml version: $VERSION"
205 [ -n "$SUITE" ] && echo " Debian suite: $SUITE"
206 [ -n "$ARCH" ] && echo " Architecture: $ARCH"
207 [ -n "$BOOT_METHOD" ] && echo " Boot method: $BOOT_METHOD"
208 [ -n "$TEMPLATE_DIRECTORY" ] && echo " Template files: $TEMPLATE_DIRECTORY"
209 [ -n "$FAI_ARGS" ] && echo " additional arguments for FAI: $FAI_ARGS"
210 [ -n "$VERBOSE" ] && echo " Using VERBOSE mode."
211 [ -n "$LOGFILE" ] && echo " Logging to file: $LOGFILE"
213 echo -n "Is this ok for you? [y/N] "
215 if ! [ "$a" = 'y' -o "$a" = 'Y' ] ; then
216 bailout 1 "Exiting as requested."
221 start_seconds=$(cut -d . -f 1 /proc/uptime)
222 log "------------------------------------------------------------------------------"
223 log "Starting grml-live [${GRML_LIVE_VERSION}] run [$(date)]"
224 log "Executed command line: $0 $@"
226 einfo "Logging actions to logfile $LOGFILE"
229 # on-the-fly configuration {{{
230 if [ -n "$MIRROR_DIRECTORY" ] ; then
231 if ! [ -d "$MIRROR_DIRECTORY/debian" ] ; then
232 log "Sorry, $MIRROR_DIRECTORY/debian does not seem to exist. Exiting. [$(date)]"
233 eerror "Sorry, $MIRROR_DIRECTORY/debian does not seem to exist. Exiting."
236 echo "$MIRROR_SOURCES" > /etc/grml/fai/apt/sources.list
237 if [ -n "$GRML_LIVE_SOURCES" ] ; then
238 echo "$GRML_LIVE_SOURCES" >> /etc/grml/fai/apt/sources.list
240 elif [ -n "$GRML_LIVE_SOURCES" ] ; then
241 echo "$GRML_LIVE_SOURCES" > /etc/grml/fai/apt/sources.list
244 if [ -n "$FAI_DEBOOTSTRAP" ] ; then
245 sed -i "s#^FAI_DEBOOTSTRAP=.*#FAI_DEBOOTSTRAP=\"$FAI_DEBOOTSTRAP\"#" $NFSROOT_CONF
248 # does this suck? YES!
249 if [ -n "$SUITE" ] ; then
250 sed -i "s/SUITE=.*/SUITE=\"$SUITE\"/" $LIVE_CONF
252 DIST="\|\ etch\ \|\ stable\ \|\ lenny\ \|\ testing\ \|\ sid\ \|\ unstable\ "
253 sed -i "s/\(deb .\+\)\([ \t]+\)$DIST\([ \t]+\)\(main \)/\1\2 $SUITE \3\4/" $LIVE_CONF
254 sed -i "s/\(deb .\+\)\([ \t]+\)$DIST\([ \t]+\)\(main \)/\1\2 $SUITE \3\4/" /etc/grml/fai/apt/sources.list
256 sed -i "s|FAI_DEBOOTSTRAP=\"[a-z]* |FAI_DEBOOTSTRAP=\"$SUITE |" $LIVE_CONF
257 sed -i "s|FAI_DEBOOTSTRAP=\"[a-z]* |FAI_DEBOOTSTRAP=\"$SUITE |" $NFSROOT_CONF
261 [ -n "$ARCH" ] || ARCH="$(dpkg --print-architecture)"
262 if grep -q -- 'FAI_DEBOOTSTRAP_OPTS.*--arch' $NFSROOT_CONF ; then
263 sed -i "s/--arch [a-z0-9]* /--arch $ARCH /" $NFSROOT_CONF
265 sed -i "s|FAI_DEBOOTSTRAP_OPTS=\"\(.*\)|FAI_DEBOOTSTRAP_OPTS=\"--arch $ARCH \1|" $NFSROOT_CONF
269 # CHROOT_OUTPUT - execute FAI {{{
270 [ -n "$CHROOT_OUTPUT" ] || CHROOT_OUTPUT="$OUTPUT/grml_chroot"
272 if [ -d "$CHROOT_OUTPUT/bin" ] ; then
273 log "$CHROOT_OUTPUT exists already, skipping stage 'fai dirinstall'"
274 ewarn "$CHROOT_OUTPUT exists already, skipping stage 'fai dirinstall'" ; eend 0
276 mkdir -p "$CHROOT_OUTPUT" || bailout 5 "Problem with creating $CHROOT_OUTPUT for FAI"
277 if [ -n "${MIRROR_DIRECTORY}" ] ; then
278 mkdir -p "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
279 mount --bind "${MIRROR_DIRECTORY}" "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
281 fai $VERBOSE -C "$GRML_FAI_CONFIG" -c"$CLASSES" -u "$HOSTNAME" dirinstall "$CHROOT_OUTPUT" $FAI_ARGS | tee -a $LOGFILE
282 umount $CHROOT_OUTPUT/proc 2>/dev/null || /bin/true
283 umount $CHROOT_OUTPUT/sys 2>/dev/null || /bin/true
284 [ -n "$MIRROR_DIRECTORY" ] && umount "${CHROOT_OUTPUT}/${MIRROR_DIRECTORY}"
286 # notice: 'fai dirinstall' does not seem to exit appropriate, so:
288 if [ -r "/var/log/fai/dirinstall/$HOSTNAME/software.log" ] ; then
289 # 1 errors during executing of commands
290 # Unable to write mmap - msync (28 No space left on device)
291 grep 'dpkg: error processing' /var/log/fai/dirinstall/$HOSTNAME/software.log >> $LOGFILE && ERROR=1
292 grep 'E: Method http has died unexpectedly!' /var/log/fai/dirinstall/$HOSTNAME/software.log >> $LOGFILE && ERROR=2
293 grep 'ERROR: chroot' /var/log/fai/dirinstall/$HOSTNAME/software.log >> $LOGFILE && ERROR=3
296 if [ -r "/var/log/fai/dirinstall/$HOSTNAME/shell.log" ] ; then
297 grep 'FAILED with exit code' /var/log/fai/dirinstall/$HOSTNAME/shell.log >> $LOGFILE && ERROR=2
300 if [ -n "$ERROR" ] ; then
301 log "There was an error [${ERROR}] during execution of stage 'fai dirinstall' [$(date)]"
302 eerror "There was an error during execution of stage 'fai dirinstall'"
303 echo " Check out /var/log/fai/dirinstall/$HOSTNAME/ for details. [exit ${ERROR}]"
307 log "Finished execution of stage 'fai dirinstall' [$(date)]"
308 einfo "Finished execution of stage 'fai dirinstall'"
313 # BUILD_OUTPUT - execute arch specific stuff and squashfs {{{
314 [ -n "$BUILD_OUTPUT" ] || BUILD_OUTPUT="$OUTPUT/grml_cd"
315 mkdir -p "$BUILD_OUTPUT" || bailout 6 "Problem with creating $BUILD_OUTPUT for stage ARCH"
318 if [ "$ARCH" = i386 ] || [ "$ARCH" = amd64 ] ; then
319 if [ -d "$BUILD_OUTPUT"/boot ] ; then
320 log "$BUILD_OUTPUT/boot exists already, skipping stage 'boot'"
321 ewarn "$BUILD_OUTPUT/boot exists already, skipping stage 'boot'" ; eend 0
324 mkdir -p "$BUILD_OUTPUT"/boot/isolinux
325 cp /boot/memtest86+.bin "$BUILD_OUTPUT"/boot/isolinux/memtest
327 # if we don't have an initrd we a) can't boot and b) there was an error
328 # during build, so check for the file:
329 if [ -f "$CHROOT_OUTPUT"/boot/initrd* ] ; then
330 cp "$CHROOT_OUTPUT"/boot/initrd* "$BUILD_OUTPUT"/boot/isolinux/initrd.gz
332 log "No initrd found inside $CHROOT_OUTPUT/boot/ - Exiting"
333 eerror "No initrd found inside $CHROOT_OUTPUT/boot/ - Exiting" ; eend 1
337 cp "$CHROOT_OUTPUT"/boot/vmlinuz* "$BUILD_OUTPUT"/boot/isolinux/linux26
338 cp /usr/lib/syslinux/chain.c32 "$BUILD_OUTPUT"/boot/isolinux/
339 cp /usr/lib/syslinux/isolinux.bin "$BUILD_OUTPUT"/boot/isolinux/
340 cp /usr/lib/syslinux/memdisk "$BUILD_OUTPUT"/boot/isolinux/
341 cp /usr/lib/syslinux/menu.c32 "$BUILD_OUTPUT"/boot/isolinux/
343 [ -n "$TEMPLATE_DIRECTORY" ] || TEMPLATE_DIRECTORY='/usr/share/grml-live/templates'
344 if ! [ -d "${TEMPLATE_DIRECTORY}"/boot ] ; then
345 log "${TEMPLATE_DIRECTORY}/boot does not exist. Exiting."
346 eerror "${TEMPLATE_DIRECTORY}/boot does not exist. Exiting." ; eend 1
349 cp ${TEMPLATE_DIRECTORY}/boot/isolinux/* "$BUILD_OUTPUT"/boot/isolinux/
350 cp ${TEMPLATE_DIRECTORY}/boot/isolinux/* "$BUILD_OUTPUT"/boot/isolinux/
351 cp -a ${TEMPLATE_DIRECTORY}/boot/grub "$BUILD_OUTPUT"/boot/
353 if ! [ -d "${TEMPLATE_DIRECTORY}"/GRML ] ; then
354 log "${TEMPLATE_DIRECTORY}/GRML does not exist. Exiting."
355 eerror "${TEMPLATE_DIRECTORY}/GRML does not exist. Exiting." ; eend 1
358 [ -d "$BUILD_OUTPUT"/GRML ] || mkdir "$BUILD_OUTPUT"/GRML
359 cp -a ${TEMPLATE_DIRECTORY}/GRML/* "$BUILD_OUTPUT"/GRML/
361 # adjust boot splash information:
362 ISO_DATE="$(date +%Y-%m-%d)"
363 RELEASE_INFO="$GRML_NAME $VERSION - Release Codename $RELEASENAME"
364 RELEASE_INFO="$(cut_string 68 "$RELEASE_INFO")"
365 RELEASE_INFO="$(extend_string_end 68 "$RELEASE_INFO")"
367 sed -i "s/%RELEASE_INFO%/$GRML_NAME $VERSION - $RELEASENAME/" "$BUILD_OUTPUT"/GRML/grml-version
368 sed -i "s/%DATE%/$ISO_DATE/" "$BUILD_OUTPUT"/GRML/grml-version
370 sed -i "s/%RELEASE_INFO%/$RELEASE_INFO/" "$BUILD_OUTPUT"/boot/isolinux/boot.msg
371 sed -i "s/%DATE%/$ISO_DATE/" "$BUILD_OUTPUT"/boot/isolinux/boot.msg
373 sed -i "s/%RELEASE_INFO%/$RELEASE_INFO/" "$BUILD_OUTPUT"/boot/isolinux/boot-beep.msg
374 sed -i "s/%DATE%/$ISO_DATE/" "$BUILD_OUTPUT"/boot/isolinux/boot-beep.msg
376 sed -i "s/%VERSION%/$VERSION/" "$BUILD_OUTPUT"/boot/grub/menu.lst
377 sed -i "s/%GRML_NAME%/$GRML_NAME/" "$BUILD_OUTPUT"/boot/grub/menu.lst
379 # autostart for Windows:
380 if [ -d "${TEMPLATE_DIRECTORY}/windows/autostart/" ] ; then
381 cp ${TEMPLATE_DIRECTORY}/windows/autostart/* "$BUILD_OUTPUT"/
384 if [ -n "$WINDOWS_BINARIES" ] ; then
385 if [ -f "$BUILD_OUTPUT"/windows/putty.exe ] ; then
386 log "$BUILD_OUTPUT/windows exists already, skipping stage 'WINDOWS_BINARIES'"
387 ewarn "$BUILD_OUTPUT/windows exists already, skipping stage 'WINDOWS_BINARIES'" ; eend 0
389 mkdir "$BUILD_OUTPUT"/windows
390 ( cd "$BUILD_OUTPUT"/windows
391 for file in pageant plink pscp psftp putty puttygen ; do
392 wget -O ${file}.exe ${WINDOWS_BINARIES}/${file}.exe
395 log "Finished execution of stage 'WINDOWS_BINARIES' [$(date)]"
396 einfo "Finished execution of stage 'WINDOWS_BINARIES'" ; eend 0
398 einfo "Finished execution of stage 'boot'" ; eend 0
401 elif [ "$ARCH" = powerpc ] ; then
402 ewarn 'Warning: formorer, it is your turn. :)'>&2
405 eerror 'Error: Unsupported ARCH, sorry. Want to support it? Contribute!' ; eend 1
408 if [ -f "$BUILD_OUTPUT"/live/grml.squashfs ] ; then
409 log "$BUILD_OUTPUT/live exists already, skipping stage 'squashfs'"
410 ewarn "$BUILD_OUTPUT/live exists already, skipping stage 'squashfs'" ; eend 0
412 mkdir "$BUILD_OUTPUT"/live
413 mksquashfs $CHROOT_OUTPUT/* $BUILD_OUTPUT/live/grml.squashfs -noappend
414 log "Finished execution of stage 'squashfs' [$(date)]"
415 einfo "Finished execution of stage 'squashfs'" ; eend 0
418 # create md5sum file:
419 ( cd $BUILD_OUTPUT/GRML &&
420 find .. -type f -not -name md5sums -not -name isolinux.bin -exec md5sum {} \; > md5sums )
423 # ISO_OUTPUT - mkisofs {{{
424 [ -n "$ISO_OUTPUT" ] || ISO_OUTPUT="$OUTPUT/grml_isos"
425 [ -n "$ISO_NAME" ] || ISO_NAME="${GRML_NAME}_${VERSION}.iso"
427 if [ "$BOOT_METHOD" = "isolinux" ] ; then
428 BOOT_FILE="boot/isolinux/isolinux.bin -c boot/isolinux/boot.cat"
429 elif [ "$BOOT_METHOD" = "grub" ] ; then
430 BOOT_FILE="boot/grub/stage2_eltorito"
433 if [ -f "${ISO_OUTPUT}/${ISO_NAME}" ] ; then
434 log "$ISO_OUTPUT exists already, skipping stage 'iso build'"
435 ewarn "$ISO_OUTPUT exists already, skipping stage 'iso build'" ; eend 0
437 mkdir -p "$ISO_OUTPUT" || bailout 6 "Problem with creating $ISO_OUTPUT for stage 'iso build'"
439 cd "$BUILD_OUTPUT" &&
440 mkisofs -V "grml $VERSION" -publisher 'grml-live | grml.org' \
441 -l -r -J -no-emul-boot -boot-load-size 4 -boot-info-table \
443 -o "${ISO_OUTPUT}/${ISO_NAME}" . ; RC=$?
445 if [ "$RC" = 0 ] ; then
446 log "Finished execution of stage 'iso build' [$(date)]"
447 einfo "Finished execution of stage 'iso build'" ; eend 0
449 log "There was an error ($RC) executing stage 'iso build' [$(date)]"
450 eerror "There was an error executing stage 'iso build'" ; eend 1
457 [ -n "$start_seconds" ] && SECONDS="$[$(cut -d . -f 1 /proc/uptime)-$start_seconds]" || SECONDS="unknown"
458 einfo "Sucessfully finished execution of $PN [running ${SECONDS} seconds]" ; eend 0
459 log "Sucessfully finished execution of $PN [running ${SECONDS} seconds]"
460 log "------------------------------------------------------------------------------"
464 ## END OF FILE #################################################################
465 # vim:foldmethod=marker ts=2 ft=sh ai expandtab tw=80 sw=3