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: Sat Sep 29 10:44:26 CEST 2007 [mika]
8 ################################################################################
10 # read configuration files, set some misc variables {{{
18 # we need root permissions for the build-process:
19 if [ "$(id -u 2>/dev/null)" != 0 ] ; then
20 echo "Error: please run this script with uid 0 (root)." >&2
24 # make sure they are not set by default
28 if [ -r /etc/grml/lsb-functions ] ; then
29 . /etc/grml/lsb-functions
31 einfo() { echo " [*] $*" ;}
32 eerror() { echo " [!] $*">&2 ;}
33 ewarn() { echo " [x] $*" ;}
37 # source main configuration file:
38 LIVE_CONF=/etc/grml/grml-live.conf
46 [ -n "$MIRROR_DIRECTORY" ] && umount "${CHROOT_TARGET}/${MIRROR_DIRECTORY}"
47 [ -n "$1" ] && EXIT="$1" || EXIT="1"
48 [ -n "$2" ] && eerror "$2">&2
54 # check for important variables {{{
55 [ -n "$GRML_FAI_CONFIG" ] || GRML_FAI_CONFIG=/etc/grml/fai
56 [ -n "$HOSTNAME" ] || HOSTNAME=grml
57 [ -n "$USERNAME" ] || USERNAME=grml
58 [ -n "$CLASSES" ] || CLASSES="GRML,I386"
59 [ -n "$BOOT_METHOD" ] || BOOT_METHOD='isolinux'
60 [ -n "$TARGET" ] || bailout 1 "${PN}: \$TARGET not specified. Please adjust $LIVE_CONF. Exiting."
62 [ -n "$VERSION" ] || VERSION="0.0.1"
63 [ -n "$RELEASENAME" ] || RELEASENAME="grml-live rocks"
64 [ -n "$GRML_NAME" ] || GRML_NAME='grml'
66 [ -n "$LOGDIR" ] || LOGDIR="/var/log/fai/dirinstall/$HOSTNAME"
67 [ -d "$LOGDIR" ] || mkdir -p $LOGDIR
68 LOGFILE="$LOGDIR/grml-live.conf"
71 # some important functions {{{
74 # usage: log "string to log"
75 log() { echo "$*" >> $LOGFILE ; }
77 # cut string at character number int = $1
78 # usage: cut_string 5 "1234567890" will output "12345"
80 [ -n "$2" ] || return 1
81 echo "$2" | head -c "$1"; echo -ne "\n"
84 # prepend int = $1 spaces before string = $2
85 # usage: extend_string_begin 5 "123" will output " 123"
86 extend_string_begin() {
87 [ -n "$2" ] || return 1
88 local COUNT="$(echo $2 | wc -c)"
89 local FILL="$(expr $COUNT - $1)"
90 while [ "$FILL" -gt 1 ] ; do
92 local FILL=$(expr $FILL - 1)
94 while [ "$FILL" -lt 1 ] ; do
96 local FILL=$(expr $FILL + 1)
98 echo "$2" | head -c "$1"; echo -ne "\n"
101 # append int = $1 spaces to string = $2
102 # usage: extend_string_begin 5 "123" will output "123 "
103 extend_string_end() {
104 [ -n "$2" ] || return 1
105 echo -n "$2" | head -c "$1"
106 local COUNT="$(echo $2 | wc -c)"
107 local FILL="$(expr $COUNT - $1)"
108 while [ "$FILL" -gt 1 ] ; do
110 local FILL=$(expr $FILL - 1)
112 while [ "$FILL" -lt 1 ] ; do
114 local FILL=$(expr $FILL + 1)
120 # usage information {{{
124 $PN - build process script for generating a (grml based) Linux Live-ISO
126 Usage: $PN [-c <classe[s]>] [-g <grml_name>] [-i <iso_name> ] \\
127 [-r <release_name>] [-s <suite>] [-t <target_directory>] \\
128 [-v <version_number>] [-FVh]
133 $PN -c GRMLBASE,GRML_X,I386 -t /grml/
134 $PN -c GRMLBASE,I386 -t /dev/shm/grml
135 $PN -c GRMLBASE,GRML_SMALL,I386 -g grml-small -v 1.0
136 $PN -c GRMLBASE,I386 -i grml_0.0-1.iso
137 $PN -c GRMLBASE,I386 -s sid -V
139 More details: man grml-live
140 /usr/share/doc/grml-live/grml-live.html
142 Please send your bug reports, feedback,.. to the grml-team.
143 http://grml.org/bugs/
148 # command line parsing {{{
150 while getopts "c:g:i:r:s:t:v:FhV" opt; do
152 c) CLASSES="$OPTARG" ;;
153 g) GRML_NAME="$OPTARG" ;;
154 i) ISO_NAME="$OPTARG" ;;
155 r) RELEASENAME="$OPTARG" ;;
156 s) SUITE="$OPTARG" ;;
158 CHROOT_TARGET="$TARGET/grml_chroot"
159 BUILD_TARGET="$TARGET/grml_cd"
160 ISO_TARGET="$TARGET/grml_isos"
162 v) VERSION="$OPTARG" ;;
164 h) usage ; bailout 0 ;;
166 ?) echo "invalid option -$OPTARG" >&2; bailout 1 ;;
169 shift $(($OPTIND - 1)) # set ARGV to the first not parsed commandline parameter
173 # some misc checks before executing FAI {{{
174 [ -n "$CLASSES" ] || bailout 1 "Error: \$CLASSES unset, please set it in $LIVE_CONF or
175 specify it on the command line using the -c|--classes option."
176 [ -n "$TARGET" ] || bailout 1 "Error: \$TARGET unset, please set it in $LIVE_CONF or
177 specify it on the command line using the -t|--target option."
180 # ask user whether the setup is ok {{{
181 if [ -z "$FORCE" ] ; then
183 echo "${PN}: check your configuration (or use -F to force execution without prompting):"
185 echo " FAI classes: $CLASSES"
186 echo " main directory: $TARGET"
187 [ -n "$CHROOT_TARGET" ] && echo " chroot target: $CHROOT_TARGET"
188 [ -n "$BUILD_TARGET" ] && echo " build target: $BUILD_TARGET"
189 [ -n "$ISO_TARGET" ] && echo " ISO target: $ISO_TARGET"
190 [ -n "$GRML_NAME" ] && echo " grml name: $GRML_NAME"
191 [ -n "$RELEASENAME" ] && echo " release name: $RELEASENAME"
192 [ -n "$VERSION" ] && echo " grml version: $VERSION"
193 [ -n "$SUITE" ] && echo " Debian suite: $SUITE"
194 [ -n "$BOOT_METHOD" ] && echo " Boot method: $BOOT_METHOD"
195 [ -n "$FAI_ARGS" ] && echo " additional arguments for FAI: $FAI_ARGS"
196 [ -n "$VERBOSE" ] && echo " Using VERBOSE mode."
198 echo -n "Is this ok for you? [y/N] "
200 if ! [ "$a" = 'y' -o "$a" = 'Y' ] ; then
201 bailout 1 "Exiting as requested."
205 start_seconds=$(cut -d . -f 1 /proc/uptime)
206 log "------------------------------------------------------------------------------"
207 log "Starting grml-live run [$(date)]"
211 # on-the-fly configuration {{{
212 if [ -n "$MIRROR_DIRECTORY" ] ; then
213 if ! [ -d "$MIRROR_DIRECTORY/debian" ] ; then
214 log "Sorry, $MIRROR_DIRECTORY/debian does not seem to exist. Exiting. [$(date)]"
215 eerror "Sorry, $MIRROR_DIRECTORY/debian does not seem to exist. Exiting."
218 echo "$MIRROR_SOURCES" > /etc/grml/fai/apt/sources.list
219 if [ -n "$GRML_LIVE_SOURCES" ] ; then
220 echo "$GRML_LIVE_SOURCES" >> /etc/grml/fai/apt/sources.list
222 elif [ -n "$GRML_LIVE_SOURCES" ] ; then
223 echo "$GRML_LIVE_SOURCES" > /etc/grml/fai/apt/sources.list
226 if [ -n "$FAI_DEBOOTSTRAP" ] ; then
227 sed -i "s#^FAI_DEBOOTSTRAP=.*#FAI_DEBOOTSTRAP=\"$FAI_DEBOOTSTRAP\"#" /etc/grml/fai/make-fai-nfsroot.conf
230 # does this suck? YES!
231 if [ -n "$SUITE" ] ; then
232 sed -i "s/SUITE=.*/SUITE=\"$SUITE\"/" $LIVE_CONF
234 DIST="\|\ etch\ \|\ stable\ \|\ lenny\ \|\ testing\ \|\ sid\ \|\ unstable\ "
235 sed -i "s/\(deb .\+\)\([ \t]+\)$DIST\([ \t]+\)\(main \)/\1\2 $SUITE \3\4/" $LIVE_CONF
236 sed -i "s/\(deb .\+\)\([ \t]+\)$DIST\([ \t]+\)\(main \)/\1\2 $SUITE \3\4/" /etc/grml/fai/apt/sources.list
238 DIST='\"etch\|=\"stable=\"lenny=\"testing=\"sid=\"unstable'
239 sed -i "s#FAI_DEBOOTSTRAP=$DIST#FAI_DEBOOTSTRAP=\"$SUITE#" $LIVE_CONF
240 sed -i "s#FAI_DEBOOTSTRAP=$DIST#FAI_DEBOOTSTRAP=\"$SUITE#" /etc/grml/fai/make-fai-nfsroot.conf
244 # CHROOT_TARGET - execute FAI {{{
245 [ -n "$CHROOT_TARGET" ] || CHROOT_TARGET="$TARGET/grml_chroot"
247 if [ -d "$CHROOT_TARGET/bin" ] ; then
248 log "$CHROOT_TARGET exists already, skipping stage 'fai dirinstall'"
249 ewarn "$CHROOT_TARGET exists already, skipping stage 'fai dirinstall'" ; eend 0
251 mkdir -p "$CHROOT_TARGET" || bailout 5 "Problem with creating $CHROOT_TARGET for FAI"
252 if [ -n "${MIRROR_DIRECTORY}" ] ; then
253 mkdir -p "${CHROOT_TARGET}/${MIRROR_DIRECTORY}"
254 mount --bind "${MIRROR_DIRECTORY}" "${CHROOT_TARGET}/${MIRROR_DIRECTORY}"
256 fai $VERBOSE -C "$GRML_FAI_CONFIG" -c"$CLASSES" -u "$HOSTNAME" dirinstall "$CHROOT_TARGET" $FAI_ARGS | tee -a $LOGFILE
257 umount $CHROOT_TARGET/proc 2>/dev/null || /bin/true
258 umount $CHROOT_TARGET/sys 2>/dev/null || /bin/true
259 [ -n "$MIRROR_DIRECTORY" ] && umount "${CHROOT_TARGET}/${MIRROR_DIRECTORY}"
261 # notice: 'fai dirinstall' does not seem to exit appropriate, so:
263 if [ -r "/var/log/fai/dirinstall/$HOSTNAME/software.log" ] ; then
264 grep 'dpkg: error processing' /var/log/fai/dirinstall/$HOSTNAME/software.log >> $LOGFILE && ERROR=1
267 if [ -r "/var/log/fai/dirinstall/$HOSTNAME/shell.log" ] ; then
268 grep 'FAILED with exit code' /var/log/fai/dirinstall/$HOSTNAME/shell.log >> $LOGFILE && ERROR=2
271 if [ -n "$ERROR" ] ; then
272 log "There was an error during execution of stage 'fai dirinstall' [$(date)]"
273 eerror "There was an error during execution of stage 'fai dirinstall'"
274 echo " Check out /var/log/fai/dirinstall/$HOSTNAME/ for details. [exit ${ERROR}]"
277 log "Finished execution of stage 'fai dirinstall' [$(date)]"
278 einfo "Finished execution of stage 'fai dirinstall'"
283 # BUILD_TARGET - execute arch specific stuff and squashfs {{{
284 [ -n "$BUILD_TARGET" ] || BUILD_TARGET="$TARGET/grml_cd"
285 mkdir -p "$BUILD_TARGET" || bailout 6 "Problem with creating $BUILD_TARGET for stage ARCH"
287 [ -n "$ARCH" ] || ARCH="$(dpkg --print-architecture)"
290 if [ "$ARCH" = i386 ] || [ "$ARCH" = amd64 ] ; then
291 if [ -d "$BUILD_TARGET"/boot ] ; then
292 log "$BUILD_TARGET/boot exists already, skipping stage 'boot'"
293 ewarn "$BUILD_TARGET/boot exists already, skipping stage 'boot'" ; eend 0
296 mkdir -p "$BUILD_TARGET"/boot/isolinux
297 cp /boot/memtest86+.bin "$BUILD_TARGET"/boot/isolinux/memtest
298 cp "$CHROOT_TARGET"/boot/initrd* "$BUILD_TARGET"/boot/isolinux/initrd.gz
299 cp "$CHROOT_TARGET"/boot/vmlinuz* "$BUILD_TARGET"/boot/isolinux/linux26
300 cp /usr/lib/syslinux/chain.c32 "$BUILD_TARGET"/boot/isolinux/
301 cp /usr/lib/syslinux/isolinux.bin "$BUILD_TARGET"/boot/isolinux/
302 cp /usr/lib/syslinux/memdisk "$BUILD_TARGET"/boot/isolinux/
303 cp /usr/lib/syslinux/menu.c32 "$BUILD_TARGET"/boot/isolinux/
304 cp /usr/share/grml-live/templates/boot/isolinux/* "$BUILD_TARGET"/boot/isolinux/
305 cp /usr/share/grml-live/templates/boot/isolinux/* "$BUILD_TARGET"/boot/isolinux/
306 cp -a /usr/share/grml-live/templates/boot/grub "$BUILD_TARGET"/boot/
308 [ -d "$BUILD_TARGET"/GRML ] || mkdir "$BUILD_TARGET"/GRML
309 cp -a /usr/share/grml-live/templates/GRML/* "$BUILD_TARGET"/GRML/
311 # adjust boot splash information:
312 ISO_DATE="$(date +%Y-%m-%d)"
313 RELEASE_INFO="$GRML_NAME $VERSION - Release Codename $RELEASENAME"
314 RELEASE_INFO="$(cut_string 68 "$RELEASE_INFO")"
315 RELEASE_INFO="$(extend_string_end 68 "$RELEASE_INFO")"
317 sed -i "s/%RELEASE_INFO%/$GRML_NAME $VERSION - $RELEASENAME/" "$BUILD_TARGET"/GRML/grml-version
318 sed -i "s/%DATE%/$ISO_DATE/" "$BUILD_TARGET"/GRML/grml-version
320 sed -i "s/%RELEASE_INFO%/$RELEASE_INFO/" "$BUILD_TARGET"/boot/isolinux/boot.msg
321 sed -i "s/%DATE%/$ISO_DATE/" "$BUILD_TARGET"/boot/isolinux/boot.msg
323 sed -i "s/%RELEASE_INFO%/$RELEASE_INFO/" "$BUILD_TARGET"/boot/isolinux/boot-beep.msg
324 sed -i "s/%DATE%/$ISO_DATE/" "$BUILD_TARGET"/boot/isolinux/boot-beep.msg
326 sed -i "s/%VERSION%/$VERSION/" "$BUILD_TARGET"/boot/grub/menu.lst
327 sed -i "s/%GRML_NAME%/$GRML_NAME/" "$BUILD_TARGET"/boot/grub/menu.lst
329 # autostart for Windows:
330 cp /usr/share/grml-live/templates/windows/autostart/* "$BUILD_TARGET"/
332 if [ -n "$WINDOWS_BINARIES" ] ; then
333 if [ -f "$BUILD_TARGET"/windows/putty.exe ] ; then
334 log "$BUILD_TARGET/windows exists already, skipping stage 'WINDOWS_BINARIES'"
335 ewarn "$BUILD_TARGET/windows exists already, skipping stage 'WINDOWS_BINARIES'" ; eend 0
337 mkdir "$BUILD_TARGET"/windows
338 ( cd "$BUILD_TARGET"/windows
339 for file in pageant plink pscp psftp putty puttygen ; do
340 wget -O ${file}.exe ${WINDOWS_BINARIES}/${file}.exe
343 log "Finished execution of stage 'WINDOWS_BINARIES' [$(date)]"
344 einfo "Finished execution of stage 'WINDOWS_BINARIES'" ; eend 0
346 einfo "Finished execution of stage 'boot'" ; eend 0
349 elif [ "$ARCH" = powerpc ] ; then
350 ewarn 'Warning: formorer, it is your turn. :)'>&2
353 eerror 'Error: Unsupported ARCH, sorry. Want to support it? Contribute!' ; eend 1
356 if [ -f "$BUILD_TARGET"/live/grml.squashfs ] ; then
357 log "$BUILD_TARGET/live exists already, skipping stage 'squashfs'"
358 ewarn "$BUILD_TARGET/live exists already, skipping stage 'squashfs'" ; eend 0
360 mkdir "$BUILD_TARGET"/live
361 mksquashfs $CHROOT_TARGET/* $BUILD_TARGET/live/grml.squashfs -noappend
362 log "Finished execution of stage 'squashfs' [$(date)]"
363 einfo "Finished execution of stage 'squashfs'" ; eend 0
366 # create md5sum file:
367 ( cd $BUILD_TARGET/GRML &&
368 find .. -type f -not -name md5sums -exec md5sum {} \; > md5sums )
371 # ISO_TARGET - mkisofs {{{
372 [ -n "$ISO_TARGET" ] || ISO_TARGET="$TARGET/grml_isos"
373 [ -n "$ISO_NAME" ] || ISO_NAME="${GRML_NAME}_${VERSION}.iso"
375 if [ "$BOOT_METHOD" = "isolinux" ] ; then
376 BOOT_FILE="boot/isolinux/isolinux.bin -c boot/isolinux/boot.cat"
377 elif [ "$BOOT_METHOD" = "grub" ] ; then
378 BOOT_FILE="boot/grub/stage2_eltorito"
381 if [ -f "${ISO_TARGET}/${ISO_NAME}" ] ; then
382 log "$ISO_TARGET exists already, skipping stage 'iso build'"
383 ewarn "$ISO_TARGET exists already, skipping stage 'iso build'" ; eend 0
385 mkdir -p "$ISO_TARGET" || bailout 6 "Problem with creating $ISO_TARGET for stage 'iso build'"
387 cd "$BUILD_TARGET" &&
388 mkisofs -V "grml $VERSION" -publisher 'grml-live | grml.org' \
389 -l -r -J -no-emul-boot -boot-load-size 4 -boot-info-table \
391 -o "${ISO_TARGET}/${ISO_NAME}" . ; RC=$?
393 if [ "$RC" = 0 ] ; then
394 log "Finished execution of stage 'iso build' [$(date)]"
395 einfo "Finished execution of stage 'iso build'" ; eend 0
397 log "There was an error ($RC) executing stage 'iso build' [$(date)]"
398 eerror "There was an error executing stage 'iso build'" ; eend 1
405 [ -n "$start_seconds" ] && SECONDS="$[$(cut -d . -f 1 /proc/uptime)-$start_seconds]"
406 einfo "Sucessfully finished execution of $PN [running ${SECONDS} seconds]" ; eend 0
407 log "Sucessfully finished execution of $PN [running ${SECONDS} seconds]"
408 log "------------------------------------------------------------------------------"
412 ## END OF FILE #################################################################
413 # vim:foldmethod=marker ts=2 ft=sh ai expandtab tw=80 sw=3