For example to change the network configuration the following script could be defined:

after_copy()
{


  cat <<EOF >$COPYDEST/etc/network/interfaces
auto lo
iface lo inet loopback
auto eth0
iface eth0 inet static


  address 192.168.1.2


  netmaks 255.255.255.0


  gateway 192.168.1.1
EOF
}

Default:

# the function is not defined
unset -f after_copy

bootcd_mount()
{


  local mountpoint


  bootcd_global DISK0P1 DISK0P3


  mountpoint="$1"


  mount $DISK0P3 $mountpoint


  mkdir $mountpoint/boot


  mount $DISK0P1 $mountpoint/boot
}

Default:

# the function is not defined
unset -f bootcd_mount

 bootcd_umount()


 {


   local mountpoint


   mountpoint="$1"


   umount $mountpoint/boot


   umount $mountpoint"
}

Default:

# the function is not defined
unset -f bootcd_umount

Default:

BOOTCDMP="/mnt/bootcd.disc"

DISK0="/dev/hda"

To not partition any disk:

DISK0=""

To let bootcd2disk find a disk (bootcd2disk tries to use the first disk):

DISK0="auto"

It is possible to define more disks. The disk number must be increased by 1:

DISK1="auto"
DISK2="auto"

Default:

DISK0="auto"

DISKIDTYP="UUID"

Or bootcd can name the disk by the devicename:

DISKIDTYP="DEVNAME"

Default:

DISKIDTYP="UUID"

do_first()
{


  info "function do_first is now running"
}

Default:

# make sure the function is not defined
unset -f do_first

do_last()
{


  info "function do_last is now running"
}

Default:

# make sure the function is not defined
unset -f do_last

EFIBOOT="bios"

Create a disk that can boot with EFI. Will work with secureboot enabled, if kernel and grub are signed or original from debian.:

EFIBOOT="efi"

To check current system. If EFI is enabled use "efi" if not use "bios". The needed bootloader software for this option is probably aready installed:

EFIBOOT="auto"

Create a disk that can boot from BIOS and EFI. If you have installed grub-pc-bin and grub-efi-amd64-bin this may be the best option. The disk may be removed, and used on another host, with either bios or efi:

EFIBOOT="bios+efi"

Default:

EFIBOOT="auto"

Default:

EXCLUDE_SYSTEM="/dev/ /mnt/ /proc/ /run/ /sys/ /tmp/ /var/tmp/"

Some files are already exluded with EXCLUDE_SYSTEM. With EXCLUDE additional Files can be excluded. Directories or files that should not be copied can be defined in this variable as a space separated list. Each entry should start with /.

Each list item will be given to rsync as --exclude <item>.

Example: To exlcude everything in directory /etc/dir1 use:

EXCLUDE="/etc/dir1/"

To exclude directory itself use:

EXCLUDE="/etc/dir1"

Default:

EXCLUDE=""

EXT2FS=""

Create partitions defined in EXT2FS with mke2fs:

EXT2FS="/dev/hda1
/dev/hda3"

Default:

EXT2FS=""

if also EXT3FS="auto" then ext3 will be used if possible

EXT3FS=""

Create partitions defined in EXT3FS with mke2fs -j:

EXT3FS="/dev/hda1
/dev/hda3"

Default:

EXT3FS=""

if also EXT4FS="auto" then ext4 will be used if possible

EXT4FS=""

Create partitions defined in EXT4FS as ext4 filesystems:

EXT4FS="/dev/hda1
/dev/hda3"

Default:

EXT4FS=""

FSTAB=""

Example to define FSTAB yourself:

FSTAB="/dev/sda1 /boot ext2 defaults 0 1
/dev/sda2 none  swap sw 0 0
/dev/sda3 /     ext2 defaults,errors=remount-ro 0 1
proc      /proc proc defaults 0 0"

The string DISK0P1 will be automatically changed to <device of the first partition of the first disk>. The string UUID!DISK1P3 will be automacally changed to the UUID of the third partition of the second disk>.

Depends on:

EFIBOOT

Default:

FSTAB=""

GRUB=""

If GRUB2 is not installed or defined and GRUB is defined and grub is installed it will be used and LILO will be ignored.

If you want to define it yourself:

GRUB="default 0
timeout 5
color   cyan/blue white/blue
title   Debian GNU/Linux
root    (hd0,0)
kernel  /vmlinuz-2.4.27-2-386 root=/dev/hda3 ro
initrd  /initrd.img-2.4.27-2-386
savedefault
boot"

Default:

GRUB=""

If you don't want to use GRUB2:

GRUB2=""

GRUB2 can also define the content of /boot/grub/grub.cfg. Grub2 starts counting partitions at 1 and grub1 starts at 0. Example:

GRUB2="
set lang=en
insmod gettext
set timeout=5
set menu_color_normal=cyan/blue
set menu_color_highlight=white/blue
menuentry 'Debian GNU/Linux' --class debian --class gnu-linux --class gnu --class os {


     insmod ext2


     set root='(hd0,1)'


     linux   /$(basename $KERNEL) root=DISK0P3 ro


     initrd  /$(basename $INITRD)
}"

If GRUB2 is auto, update-grub will be used to create /boot/grub/grub.cfg automatically. Default:

GRUB2="auto"

GRUBBOOTDIR="0"

Default:

GRUBBOOTDIR=""

GRUBBOOTDISK="hd0"

Default:

GRUBBOOTDISK=""

GRUBDEVICEMAP=auto|no|<value>

Let bootcd2disk delete the original device.map, so that it will be auto-created by grub again.:

GRUBDEVICEMAP="auto"

bootcd2disk shoult not change device.map. This should work if a bootcd is installed on the original hardware:

GRUBDEVICEMAP="no"

Everything else will be used as new value for device.map. Default:

GRUBDEVICEMAP="auto"

Default:

GRUB_INSTALL_OPTS_BIOS="--target=i386-pc --recheck --no-floppy --force"

If the newly created disk will not be moved away --no-nvram may be omitted.

Default:

GRUB_INSTALL_OPTS_EFI="--target=x86_64-efi --recheck --no-floppy --force --no-nvram"

IMAGEURL="http://192.168.100.10/cdimage.iso"

Default:

IMAGEURL=""

Default:

ISOLOOPBACK=""

LILO=""

If you want to define it yourself:

LILO="boot=DISK0
delay=20
vga=0
image=/vmlinuz
root=DISK0P3
initrd=/initrd.img
label=Linux
read-only"

Default:

LILO=""

Default:

LINUXFS="auto"

Only the options luks and swap are supported. If bootcd2disk is running without controlling tty for password input, the default password bootcd will be set, that has to be changed manually later.

Example with target root filesystem luksroot and target swap partition luksswap:

LUKS="luksroot DISK0P1 none luks
luksswap DISK0P2 /dev/urandom swap"

Default:

LUKS=""

LVMGRP="<group> <diskdev> [<diskdev> ...][<vgcreate-cmd>][...]"

Example1

LVMGRP="vg00 DISK0P1
vg01 DISK0P2
vg02 DISK0P3 DISK0P4"

Example2 which is the same as Example1 because it uses the default schema

LVMGRP="vg00 DISK0P1 vgcreate vg00 DISK0P1
vg01 DISK0P2 vgcreate vg01 DISK0P2
vg02 DISK0P3 vgcreate vg02 DISK0P3 DISK0P4"

Default:

LVMGRP=""

LVMVOL="<volname> <size> <group> [<lvcreate-cmd>][...]"

Example1

LVMVOL="lv00 2000 vg00"

Example2 which is the same as Example1 because it used the default schema

LVMVOL="lv00 2000 vg00 lvcreate -n lv00 -L 2000 vg00"

Example3 uses striping for the second volume

LVMVOL="lv00 2000 vg00
lv01 100 vg00 lvcreate -n lv01 -i 3 -I 8 -L 100 vg00"

Default:

LVMVOL=""

MD="<mddev> <level> <diskdev> ... [<mdadm cmd>]"

Example:

MD="md0 1

Default:

MD=""

The task parti can be defined with the variable SFDISK#. The task luks can be defined with the variable LUKS. The task md can be defined with the variable MD. The task lvm can be defined with the variables LVMGRP and LVMVOL. Only if a task is defined, the task will be executed.

It is possible to schedule a task multiple times in ORDER. If task parti is defined multiple times, the task will only be executed, if DISK# that corresponds to SFDISK# is available at task's turn. If task md is defined multipe times, the task will only be executed, if <diskdev> defined in MD is available at task's turn. If * task* lvm is defined multipe times, the task will only be executed, if <diskdev> defined in LVMGRP is available. at task's turn.

Default:

ORDER="parti luks md lvm"

PARTITIONLABEL="/dev/sda1:/
/dev/sda2:SWAP-sda2"

Default:

PARTITIONLABEL=""

RESUME="/dev/hda2"

To define the RESUME device with a Filesystem UUID:

RESUME="UUID=86c6e572-eec4-4a29-8cbd-2864f4e44621"

To not change the RESUME configuration, the variable has to be empty:

RESUME=""

To disable the RESUME Feature, RESUME has to be none:: Default:

RESUME="none"

If a disk should not be repartitioned, no definition is needed.

To partition DISK2 the following config could be used, see man sfdisk(8):

SFDISK2="
unit: sectors
,50
,100,S
;
"

See SFDISK# in default bootcd2disk.conf for an example that calculates SFDISK0 depending on on EFIBOOT.

The Default is to not repartition any disks.

SSHHOSTKEY=yes|no

If you are using ssh it is helpful to have a unique ssh hostkey for each PC installed with bootcd2disk. This will be generated with:

SSHHOSTKEY="yes"

Default:

SSHHOSTKEY="yes"

SWAP=""

If you want to specify partitions for mkswap:

SWAP="/dev/hda2"

Default:

SWAP=""

To try only disks /dev/sda and /dev/hda in this order use:

ALLOWEDDISKS="/dev/sda /dev/hda"

This can also be used to only try individual disks, if they are connected:

ALLOWEDDISKS="/dev/disk/by-id/<id1>
/dev/disk/by-id/<id2>
/dev/disk/by-id/<id3>"

Default:

ALLOWEDDISKS=""

UDEV_FIXNET=yes|no

If you are using udev filesystem and install the image on other machines you need to set this to "yes" because the network interfaces are hardwired in /etc/udev/rules.d/z25_persistent-net.rules (etch) or in /etc/udev/rules.d/70-persistent-net.rules (lenny) and we must remove them.:

UDEV_FIXNET="yes"

Default:

UDEV_FIXNET="yes"

VFAT=""

To ceate partitions with mkdosfs:

VFAT="/dev/sdb4"

Default:

VFAT=""

XFS="/dev/hda1
/dev/hda3"

Do not not create xfs filesystems:: Default:

XFS=""

It is not recommended to use special characters anyway, but the variable EXCLUDE may contain blank ( ), dollar ($), backslash (\), qoute (") and backquote (`). This variables are called EVALVARS in this manpage, because in shell script, the eval command can be used to easily read them.

For example to define EXCLUDE with the files or directories "/etc/noblank", "/etc/blank name1" and "/etc/blank name2" the following config line would be possible:

EXCLUDE="/etc/noblank \"/etc/blank name1\" /etc/blank\ name2"

Because all variables have to be readable by shell with the eval command, the syntax can be checked. if the config line above is entered in a shell with the test commands:

eval "set -- $EXCLUDE"
echo "#=<$#> 1=<$1> 2=<$2> 3=<$3> 4=<$4>"

should print out the result:

#=<3> 1=</etc/noblank> 2=</etc/blank name1> 3=</etc/blank name2> 4=<>

Example: direct definition of function OPTION do_first():

do_first() { info "function do_first is now running"; }

Example: direct definition of a number OPTION DISK#:

DISK0="/dev/hda"; DISK2="auto"

Example: direct definition of a normal OPTION DISKIDTYP:

DISKIDTYP="UUID"

If an OPTION can not be defined immediatelly, because it needs the definition of another OPTION, a function define_OPTION can be created, that calls the function needs with a string containing a space separated list of OPTIONS needed:

Example: function do_first needs DISKIDTYP:

define_do_first() {


  needs "DISKIDTYP"


  if [ "$DISKIDTYP" = "UUID" ]; then


    do_first() { info "DISKIDTYP = UUID"; }


  else


    do_first() { info "DISKIDTYP != UUID"; }


  fi
}

Example: number OPTION SFDISK# needs DISKIDTYP:

define_SFDISK() {


  needs "DISKIDTYP"


  if [ "$DISKIDTYP" = "UUID" ]; then


    SFDISK0="..."


    SFDISK3="..."


  else


    SFDISK0="..."


    SFDISK3="..."


  fi
}

Example: normal OPTION FSTAB needs DISKIDTYP:

define_FSTAB() {


  needs "DISKIDTYP"


  if [ "$DISKIDTYP" = "UUID" ]; then


    FSTAB="..."


  else


    FSTAB="..."


  fi
}

Example partition-token:

DISK3P7

This means 7th partition of 4th disk. Example usage of partition-token in OPTION FSTAB:

FSTAB="DISK3P7 /boot ext3 defaults 0 1
..."

To use partition-tokens in a function OPTION" variables have to be declared with bootcd_global . Example:

bootcd_mount()
{


  bootcd_global DISK0P3


  mountpoint="$1"


  mount $DISK0P3 $mountpoint


  ...
}

The function bootcd_global makes sure that all partition-tokens are available in the same named variable.