2 # Filename: terminalserver-config
3 # Purpose: configuration program for grml-terminalserver
4 # Authors: grml-team (grml.org), (c) Michael Gebetsroither <gebi@grml.org>
5 # Bug-Reports: see http://grml.org/bugs/
6 # License: This file is licensed under the GPL v2.
7 # Latest change: Don Nov 16 14:39:51 CET 2006 [mika]
8 ################################################################################
15 #. /etc/grml/sysexits-sh
25 # this file holds all variable definitions
26 SHARED_PROG_VARS_="/usr/share/grml-terminalserver/shared_prog_vars"
27 isExistent $SHARED_PROG_VARS_ die
30 # variables used in the config file for grml-terminalserver
51 Usage: "$PROG_NAME__" [OPTIONS] <command>
53 $PROG_NAME__ is the config program for the terminalserver coming with grml.
58 interactive Interactive Configuration of the grml-terminalserver
59 grubConf Configure grub and create boot-image (for non-PXE NICs)
60 grubConfWrite Configure grub and write image to floppy disk
61 grubWrite Write compiled grub-image to floppy disk
62 grubMultiWrite batchwrite grub-image to floppy disk
63 initrd Only create the initrd
64 clean Remove all configfiles created during user configuration
65 <default> interactive mode
68 -v verbose (show what is going on, v++)
79 if [ -f $CONF_FILE_ ]; then
80 mv -fb $CONF_FILE_ ${CONF_FILE_}-old
84 cat <<EOT > $CONF_FILE_
85 # GRML TERMINAL-SERVER CONFIG
87 INTERFACE_="$INTERFACE_"
92 NAMESERVERS_="$NAMESERVERS_"
93 IPRANGE_FROM_="$IPRANGE_FROM_"
94 IPRANGE_TO_="$IPRANGE_TO_"
96 BOOT_ARGS_="$BOOT_ARGS_"
97 NAT_INTERFACE_="$NAT_INTERFACE_"
100 notice "config successfully safed to \"$CONF_FILE_\""
104 # AUTOMATIC CONFIGURATION {{{
105 function checkParamArg
107 local param_name="$1"
110 #eval "echo $`echo $test`"
111 echo $arg |grep "^[-|+]" &>/dev/null || return
113 die "Argument from $param_name looks like another parameter \"$arg\"" 1
116 function actionAutoconf
118 checkParamArg "-i" "$interface_"
125 function actionMkInitrd
127 echo -n "Creating initrd $PATH_/minirt26.gz: "
128 isExistent "$PATH_/minirt26.gz" && echo && echo "$PATH_/minirt26.gz exists already, skipping initrd creation" && return 0
135 TMP_DIR_=`mktemp -td terminalserver_initrd.XXXXXX`
137 local tmp_loopname=''
139 # copying original initrd into $INITRD
140 execute "rm -r $INITRD_" 2>/dev/null
141 execute "cp $ORIGINAL_INITRD_ $TMP_DIR_/minirt26.gz" warn || return 1
142 execute "mkdir -p $INITRD_" warn || return 1
143 execute "mkdir -p $PATH_/mini-root.orig" warn || return 1
144 execute "gunzip $TMP_DIR_/minirt26.gz" warn || return 1
145 tmp_loopname=`findNextFreeLoop die`
146 execute "mount -o loop=$tmp_loopname $TMP_DIR_/minirt26 $PATH_/mini-root.orig " warn || return 1
147 execute "cp -a $PATH_/mini-root.orig/* $INITRD_" warn || return 1
148 execute "umount $PATH_/mini-root.orig" warn || return 1
149 losetup -d $tmp_loopname &>/dev/null
151 execute "rmdir $PATH_/mini-root.orig" warn || return 1
152 execute "rm $TMP_DIR_/minirt26" warn || return 1
154 # implanting my initrd changes into the original initrd
156 # copy programs, check if there are already links with this name to busybox
157 for i in $USR_SHARE_/timeout $USR_SHARE_/udhcpc $USR_SHARE_/udhcp-config.sh $USR_SHARE_/cdir $USR_SHARE_/rdir; do
159 isNotExistent "$INITRD_/static/$tmp_name_" eprint || execute "rm $INITRD_/static/$tmp_name_"
160 cp $i "$INITRD_/static/$tmp_name_"
162 cp $USR_SHARE_/linuxrc $INITRD_/
163 mkdir -p $INITRD_/mylib
166 # which modules should i put into the ramdisk
169 # find *all* network drivers, but do not include wlan/pcmcia/... related ones
170 # blacklist: proteon and depca as they seem to cause problems with udevsettle
171 find ${MODULES_PATH_}/${KERNEL_VERSION_}/kernel/drivers/net/ -name \*.ko | \
172 grep -v 'wireless\|wan\|hamradio\|wlan\|ppp\|irda\|pcmcia\|depca\|proteon' | \
173 sed 's#.*./## ; s#\.ko##' | sort | uniq > $CARDS_DETECTED_BY_DISCOVER
175 local modules="`cat $CARDS_DETECTED_BY_DISCOVER |xargs` af_packet"
178 # get paths of modules + paths of all dependent modules
180 for i in $modules; do
181 tmp_=`awk -F: '{if($1~/'"$i".ko'/) {print $0}}' $MODULES_PATH_/$KERNEL_VERSION_/modules.dep`
183 # FIXME ugly sed hack :(
184 echo "${tmp_#*:}" | xargs -n1 echo | sed 's/://'
186 | sort | uniq | while read module relax; do
187 if [ -n "$module" ]; then
188 echo "$module" >> $TMP_
192 # copy modules + dependend modules into ramdisk
193 local mod_path_="$INITRD_/mylib/modules/$KERNEL_VERSION_"
194 local tmp_dst_path_="$mod_path_/kernel"
195 mkdir -p $tmp_dst_path_
196 cat $TMP_ |sort |uniq |while read module; do
197 local tmp_path=${module#*/kernel/}
198 tmp_path=$tmp_dst_path_/${tmp_path%/*.ko}
199 local module_path=$tmp_path/${module##/*/}
201 isNotExistent "$tmp_path" dprint && mkdir -p "$tmp_path"
202 isNotExistent "$module_path" dprint && cp "$MODULES_PATH_ROOT_DIFF_/$module" "$module_path"
205 # copying additional modules
206 for i in fs/nfs/nfs.ko net/sunrpc/sunrpc.ko fs/lockd/lockd.ko net/packet/af_packet.ko; do
207 local tmp_path="$tmp_dst_path_/${i%/*}"
209 cp $MODULES_PATH_/$KERNEL_VERSION_/kernel/$i "$tmp_path"
213 cp $MODULES_PATH_/$KERNEL_VERSION_/modules.dep $mod_path_
214 cp $MODULES_PATH_/$KERNEL_VERSION_/modules.alias $mod_path_
215 #grep "^\/lib\/modules\/$KERNEL_VERSION_\/kernel\/" $MODULES_PATH_/$KERNEL_VERSION_/modules.dep |\
216 # sed "s/\/lib\/modules\/$KERNEL_VERSION_\/kernel\//\/modules\//g" > $mod_path_/modules.dep
218 # put everything into the new initrd
219 local tmp_size=`du -s $INITRD_ |awk '{print $1}'` # in kB
220 let tmp_size=$tmp_size+1000
222 if (( $tmp_size >= $max_size )); then
223 warn "Your initrd is $tmp_size kByte large => TOO BIG (should be <= ${max_size}kB)"
224 warn "Please remove a few modules from $CARDS_DETECTED_BY_DISCOVER or edit $INITRD_ manually"
228 execute "dd if=/dev/zero of=$TMP_DIR_/minirt26 bs=${tmp_size}k count=1 &>/dev/null" warn || \
229 warn "could not create filesystem image"
231 tmp_loopname=`findNextFreeLoop die`
232 execute "losetup $tmp_loopname $TMP_DIR_/minirt26" die
233 execute "mke2fs -L \"GRML NETINIT\" -b 1024 -N 8192 -O none -F -q -m 0 $tmp_loopname" warn
235 execute "mkdir $PATH_/minirt26_mountp" warn
236 execute "mount $tmp_loopname $PATH_/minirt26_mountp" warn
237 execute "cp -a $INITRD_/* $PATH_/minirt26_mountp" warn
238 execute "umount $PATH_/minirt26_mountp" warn
239 execute "losetup -d $tmp_loopname &>/dev/null" warn
240 execute "rmdir $PATH_/minirt26_mountp" warn
241 execute "gzip -9 $TMP_DIR_/minirt26" warn
242 execute "rm -r $INITRD_" warn
243 execute "mv $TMP_DIR_/minirt26.gz $PATH_"
244 execute "rm -fr $TMP_DIR_"
249 # INTERACTIVE CONFIGURATION {{{
251 function actionInteractive
255 dprint "running in interactive mode"
257 local card_title_="Choose network device connected to client network"
258 local card_message_="Available network devices:"
259 local iprange_title_="IP Address range for clients"
260 local iprange_message_="
261 Please enter the desired IP-Range of addresses that should be allocated by clients, separated by a single space.
264 192.168.0.101 192.168.0.200
266 for addresses from 192.168.0.101 to (and including) 192.168.0.200.
269 local runconfig_title_="Networkcard config"
270 local runconfig_message_="Would you like to configure your interfaces now?"
271 local grub_title_="Grub configuration"
272 local grub_message_="Do you have any NON-PXE network cards you would like to boot from?"
274 # on witch interfaces should we listen
275 local netdevices_="$(cat /proc/net/dev | awk -F: '/eth.:|tr.:/{print $1}')"
276 local device_list_=""
277 for INTERFACE_ in $netdevices_; do device_list_="$device_list_ ${INTERFACE_} Networkcard_${INTERFACE_##eth}"; done
279 $DIALOG_ --backtitle "$BACK_TITLE_" --title "$card_title_" --menu "$card_message_" \
280 0 0 18 $device_list_ 2>"$TMP_" || warn "could not get network-interface"
281 INTERFACE_="$(<$TMP_)" ; echo -n "" >"$TMP_"
284 IP_=`netGetIp "$INTERFACE_" warn`
285 NETMASK_=`netGetNetmask "$INTERFACE_" warn`
286 netValidIp "$IP_" warn && break
287 $DIALOG_ --backtitle "$BACK_TITLE_" --title "$runconfig_title_" --yesno "$runconfig_message_" 18 45 && \
288 netcardconfig || die "Could not get interface" $?
291 IPRANGE_FROM_=`execute "ipcalc -nb $IP_/$NETMASK_" warn |awk '/HostMin/{print $2}'`
292 IPRANGE_TO_=`execute "ipcalc -nb $IP_/$NETMASK_" warn |awk '/HostMax/{print $2}'`
293 NETWORK_=`execute "ipcalc -nb $IP_/$NETMASK_" warn |awk '/Network:/{print $2}'`
294 NETWORK_=${NETWORK_%/*}
296 while [ -z "$IPRANGE_FROM_" -o -z "$IPRANGE_TO_" -o -z "$iprange_" ]; do
297 iprange_="$IPRANGE_FROM_ $IPRANGE_TO_"
299 $DIALOG_ --clear --backtitle "$BACK_TITLE_" --title "$iprange_title_ ($INTERFACE_=$IP_/$NETMASK_)" \
300 --inputbox "$iprange_message_" 18 75 "$iprange_" 2>"$TMP_" || die "problems getting network range" $?
303 IPRANGE_FROM_="${iprange_%% *}"
304 IPRANGE_TO_="${iprange_##* }"
306 for i in "$IPRANGE_FROM_" "$IPRANGE_TO_"; do
307 netValidIp "$i" warn || iprange_=""
311 NAMESERVERS_=`netGetNameservers warn`
312 GW_=`netGetDefaultGateway warn`
313 GW_DEV_=`/sbin/ip route get "$GW_" | awk '{ print $3; exit; }'`
314 if [ "$GW_DEV_" != "$INTERFACE_" ] && [ "$GW_DEV_" != "" ]; then
315 # GW_DEV_ of server is not the same device as the one serviced by dhcpd
316 # so it doesn't make sense to provide the GW_ address to the clients
318 local do_nat_title_="Network Address Translation"
319 local do_nat_message_="
320 Do you want to set up NAT so that clients booting from this
321 grml-terminalserver can use this machine also as gateway to
324 $DIALOG_ --clear --backtitle "$BACK_TITLE_" --title "$do_nat_title_" --yesno "$do_nat_message_" 15 75 || \
326 if [ "$do_nat_" = "YES" ]; then
327 # user wants NAT, we give the clients the server address as
330 NAT_INTERFACE_="$GW_DEV_"
332 # no NAT, no sensible gateway
334 NAT_INTERFACE_="none"
341 local grub_write_="YES"
342 $DIALOG_ --clear --backtitle "$BACK_TITLE_" --title "$grub_title_" --yesno "$grub_message_" 5 75 && \
343 grubConfig || grub_write_="NO"
347 #local OPT_IPTABLES_="yes"
348 #local OPT_SSH_="yes"
349 #local OPT_DISTCC_="yes"
352 local OPTIONS_TITLE_="Options"
353 local OPTIONS_MESSAGE_="Please give the appropriate options you want the clients to use:
355 grml2hd - Make a non-interactive remote installation
360 # local OPTIONS_MESSAGE_="Please give the appropriate options you want the clients to use:
362 #iptables - Only the server should be able to access the clients
363 #ssh - A ssh-key will be created on the server and distributed to the clients
364 #distcc - You want to use the clients as compile-farm (ssh options recommned)
368 local OPT_IPTABLES_DESC_="Start iptables on the clients"
369 local OPT_SSH_DESC_="Start ssh on the clients"
370 local OPT_DISTCC_DESC_="Start distcc on the clients"
371 local OPT_GRML2HD_DESC_="Remote install grml on the network clients"
372 # dialog options (enable if implemented)
373 #iptables "$OPT_IPTABLES_DESC_" off \
374 #ssh "$OPT_SSH_DESC_" off \
375 #distcc "$OPT_DISTCC_DESC_" off \
377 $DIALOG_ --clear --separate-output --backtitle "$BACK_TITLE_" --title "$OPTIONS_TITLE_" --checklist "$OPTIONS_MESSAGE_" 25 80 10 \
378 grml2hd "$OPT_GRML2HD_DESC_" off \
379 2>$TMP_ || die "could not get terminalserver options" $?
380 while read tmp_option_; do
381 OPTIONS_="$OPTIONS_ $tmp_option_"
385 for i in $OPTIONS_; do
387 grml2hd) optGrml2Hd || return 1 ;;
392 local OPTIONS_BOOTARG_MESSAGE_="Here you can add additional boot arguments for the clients seperated by spaces:
394 Quite usefull examples:
396 ssh=<pw> - Start ssh server and set password of user grml to pw
397 services=<1,2,3> - Execute /etc/init.d/{1,2,3} start
398 console=ttyS0,9600n8 - Initialise seriell console
399 secure - Boot only restricted clients (without root permissions)
400 startx - Boot into X (should be used with secure)
404 $DIALOG_ --clear --no-collapse --backtitle "$BACK_TITLE_" --title "$OPTIONS_TITLE_" --inputbox "$OPTIONS_BOOTARG_MESSAGE_" 0 0\
405 2>$TMP_ || die "problems getting additional boot arguments"
406 BOOT_ARGS_="$BOOT_ARGS_ $(<$TMP_)"
409 if [ $grub_write_ == "YES" ]; then
413 notice "GRML terminalserver successfully configured"
417 # OPTIONS GETTING DIALOG {{{
420 local GRML2HD_TITLE_='Grml2hd options dialog'
422 local options_='BOOT_IMAGE=grml2hd'
424 # get partition to install grml2hd on
425 OPTIONS_PARTITION_MSG_='Please give me the target partition where to install grml'
426 PARTITION_TITLE_='Partition selection'
428 $DIALOG_ --clear --backtitle "$BACK_TITLE_" --title "$PARTITION_TITLE_" --inputbox \
429 "$OPTIONS_PARTITION_MSG_" 0 75 '/dev/hda1' 2>$TMP_ || die "problems getting partition"
430 tmp_="partition=$(<$TMP_)"
431 options_="$options_ $tmp_"
433 # get filesystem type
434 OPTION_FS_TYPE_='Please give me the filesystem type'
435 FS_TITLE_='Filesystem selection'
437 $DIALOG_ --clear --backtitle "$BACK_TITLE_" --title "$FS_TITLE_" --inputbox \
438 "$OPTION_FS_TYPE_" 0 75 'ext3' 2>$TMP_ || die "problems getting filesystem type"
439 tmp_="filesystem=$(<$TMP_)"
440 options_="$options_ $tmp_"
442 # get where to save mbr
443 OPTION_MBR_='Please give me the location where to save the mbr'
444 MBR_TITLE_='Select location of mbr'
446 $DIALOG_ --clear --backtitle "$BACK_TITLE_" --title "$MBR_TITLE_" --inputbox \
447 "$OPTION_MBR_" 0 75 '/dev/hda' 2>$TMP_ || die "problems getting location where to write mbr"
449 options_="$options_ $tmp_"
452 OPTION_USER_='Who should be the first user on the system'
453 USER_TITLE_='User selection'
455 $DIALOG_ --clear --backtitle "$BACK_TITLE_" --title "$USER_TITLE_" --inputbox \
456 "$OPTION_USER_" 0 75 'grml' 2>$TMP_ || die "problems getting first user of system"
457 tmp_="user=$(<$TMP_)"
458 options_="$options_ $tmp_"
460 BOOT_ARGS_="$options_"
467 local tmp_=`mktemp -td terminalserver_grub.XXXXXX` || warn "could not create tmp file for grubConfig"
468 if [ -z "$tmp_" ]; then return 1; fi
472 execute "rm -rf $tmp_" warn
477 function grubConfigWork
481 local grub_title_="Grub configuration"
482 local grub_nic_message_="
483 Give me the types of network cards you would want to boot from.
484 If you networkcard is already listed press <OK>!
486 WARNING: DON't add all NIC's, grub could possibly stop working!!"
489 while read module_ desc_ mode_; do
490 nics_="$nics_ $module_ $desc_ $mode_"
491 done < $GRUB_NIC_CONF_
495 $DIALOG_ --clear --separate-output --backtitle "$BACK_TITLE_" --title "$grub_title_" --checklist \
496 "$grub_nic_message_" 10 70 0 $nics_ 2>$TMP_
498 if [[ $ret_ -ne 0 || `wc -l <$TMP_` -eq 0 ]]; then
500 warn "you should give me your specified NICs but didn't => DEFAULT will be used"
501 awk '/ on$/{print $1}' $GRUB_NIC_CONF_ >$TMP_
503 while read module_; do
504 cmd_line_="$cmd_line_ --enable-$module_"
507 echo "\"$cmd_line_\""
509 execute "tar xzf $GRUB_SOURCE_ -C $tmp_" warn || return 1
510 execute "cd $tmp_/grub*" warn || return 1
511 cat >preset-menu <<EOT
512 # Set up the serial terminal, first of all.
513 #serial --unit=0 --speed=19200
514 #terminal --timeout=0 serial
516 # Initialize the network.
517 #dhcp --with-configfile
518 #bootp --with-configfile
522 title Load config from Tftp server
523 configfile (nd)/menu.lst
525 #execute "./configure --enable-diskless --enable-preset-menu=./preset-menu $cmd_line_" warn || read
526 execute "CC=gcc-3.3 ./configure --enable-preset-menu=./preset-menu $cmd_line_" warn || read
527 execute "make -j2 CC=gcc-3.3" warn || read #return 1
529 local st1_="stage1/stage1"
530 local st2_="stage2/stage2"
531 isExistent $st1_ warn || return 1
532 isExistent $st2_ warn || return 1
534 execute "mv -fb $PATH_/grub.img $PATH_/grub.img.old"
535 execute "cat $st1_ $st2_ > $PATH_/grub.img" warn || return 1
541 local grub_title_="Grub configuration"
542 $DIALOG_ --clear --backtitle "$BACK_TITLE_" --title "$grub_title_" --yesno \
543 "Do you want to write your grub image to /dev/fd0" 5 75 || return 1
545 execute "dd if=$PATH_/grub.img of=/dev/fd0" warn || return 0
549 function grubMultiWrite
551 local target_=${1:-'/dev/fd0'}
553 isExistent "$PATH_/grub.img" die "you must give me an image or run \"$PROG_NAME__ grubconf\""
554 isExistent "$target_" die "$target_ is not a valied"
556 echo -n "Please insert disk into $target_ and press <ENTER> (STRG-C for end)"
558 dd if=$PATH_/grub.img of="$target_"
564 function removeTmpFiles
566 execute "rm -f $TMP_" warn
571 for i in dhcpd.conf grub.img minirt26.gz; do
572 execute "rm -f $PATH_/$i*"
575 for i in $CARDS_DETECTED_BY_DISCOVER $CONF_FILE_; do
586 while getopts "i:hv" opt; do
588 i) interface_=$OPTARG ;;
589 h) printUsage; exit ;;
590 v) let verbose_=$verbose_+1 ;;
591 ?) printUsage; exit 64 ;;
594 shift $(($OPTIND - 1)) # set ARGV to the first not parsed commandline parameter
598 help) printUsage; exit 0 ;;
601 checkRoot die 'You have to be root to use this program'
604 execute "mkdir -p $PATH_" die
606 TMP_=`mktemp -t grml-terminalserver-config.XXXXXX` || die "Could not create tmpfile" $?
607 setExitFunction 'removeTmpFiles'
614 # MODULES_PATH_ROOT_DIFF_
617 if [[ $MODULES_PATH_ == "" || $KERNEL_VERSION_ == "" || $ORIGINAL_INITRD_ == "" ]]; then
618 warn "MODULES_PATH_=\"$MODULES_PATH_\" \
619 KERNEL_VERSION_=\"$KERNEL_VERSION_\" \
620 ORIGINAL_INITRD_=\"$ORIGINAL_INITRD_\""
621 die "False configuration, please update $CONFIG_"
626 interactive) actionInteractive ;;
627 grubConf) grubConfig ;;
628 grubConfWrite) grubConfig && grubWrite ;;
629 grubWrite) grubWrite ;;
630 grubMultiWrite) grubMultiWrite "$2" ;;
631 initrd) actionMkInitrd ;;
632 clean) actionClean ;;
633 *) actionInteractive ;;
638 ################################################################################
639 # vim:foldmethod=marker tabstop=2 expandtab shiftwidth=2