Differences between revisions 104 and 106 (spanning 2 versions)
Revision 104 as of 2016-08-08 12:54:14
Size: 6533
Editor: ?SebastianRaible
Comment: it's not the installer menu, it's the installer's boot menu
Revision 106 as of 2016-09-10 17:01:22
Size: 10700
Editor: Brian Potkin
Comment: Added a link in the Examples section.
Deletions are marked like this. Additions are marked like this.
Line 43: Line 43:
= Preseeding and the installer's debconf templates =

As part of its construction the Debian Installer uses [[https://d-i.alioth.debian.org/doc/internals/ch03.html|udeb]] files. These files are similar to normal .debs and have a control section which may contain a file
called ''templates'' which, amongst other things, contains questions which
can be asked during the installation. The answers to these questions can, in many cases, be preseeded. Not all udebs have a templates file.

If you have a ''.udeb'' its templates file can be extracted using apt-extracttemplates, which is in the apt-utils package. The command

{{{
apt-extracttemplates -t $PWD file.udeb
}}}

produces two files in the same directory as file.udeb. With ''ls -l'' you should see something like

{{{
file.config.S7Fsld
file.template.4tyDFV
}}}

The terminating string is a random one and the second file is the one of interest. This contains the information necessary to preseed answers to
questions asked by the installer.

== Processing templates files ==

Assuming you have all the available udeb files for your chosen suite (stable, testing or unstable) the templates files from them will be extracted by

{{{
#!/bin/bash

UDEBS=*.udeb

for i in $UDEBS
do
   apt-extracttemplates -t $PWD $i
   rm *.config* 2>/dev/null
done
}}}

This is a script to obtain all English language information from a selection of templates and put it in a single file:

{{{
#!/bin/bash

FILES=*.template*

for f in $FILES
do
# Have titled sections for data from each template file.
TITLE=$(echo $f |cut -d"." -f1)
echo -e "\n\n\n********** $TITLE **********" >> preseed.all

# Extract data from templates and do a bit of tidying up.
sed '/^Indices-.*\.UTF/d' $f \
| awk '/^Template:/,/-.*\.UTF-8:/' \
| awk '!/-.*\.UTF-8:/' \
| sed '/^Template:/{x;p;x;}' \
>> preseed.all
done
}}}

Most of the non-question data can be eliminated with

{{{
#!/bin/bash

FILES=*.template*

for f in $FILES
do
# Have titled sections for data from each template file.
TITLE=$(echo $f |cut -d"." -f1)
echo -e "\n\n\n********** $TITLE **********" >> preseed.all

# Extract data from templates and remove text, error, title
# and note data types.
sed '/^Indices-.*\.UTF/d' $f \
| awk '/^Template:/,/-.*\.UTF-8:/' \
| awk '!/-.*\.UTF-8:/' \
| sed '/^Template:/{x;p;x;}' \
| sed ':a $!N;s/\nType: text/ Type: text/;ta P;D' \
| sed '/Type: text/,/^$/d' \
| sed ':a $!N;s/\nType: error/ Type: error/;ta P;D' \
| sed '/Type: error/,/^$/d' \
| sed ':a $!N;s/\nType: title/ Type: title/;ta P;D' \
| sed '/Type: title/,/^$/d' \
| sed ':a $!N;s/\nType: note/ Type: note/;ta P;D' \
| sed '/Type: note/,/^$/d' \
>> preseed.all
done
}}}

== Obtaining udeb files ==

For a small handful of files it is probably convenient to download them from Debian website's [[https://www.debian.org/distrib/packages|Packages page]] (View package lists). However, it is worthwhile considering using ''apt-get'' and an archive in /etc/apt/sources.list. A suitable entry is:

{{{
deb http://httpredir.debian.org/debian stable main/debian-installer
}}}

Then

{{{
apt-get update
apt-get install <udeb_package_name>
}}}

With the previous entry as the only one in sources.list a list of available udebs can be written to a file using

{{{
apt-cache dumpavail | grep ^Package: | cut -d" " -f2 > udebpkgs
}}}

and the contents of udebpkgs downloaded with

{{{
for pkg in $(cat udebpkgs) ; do apt-get download $pkg ; done
}}}
Line 59: Line 177:
 * In debian-boot Charles Plessey [[https://lists.debian.org/debian-boot/2016/09/msg00075.html|posted]] about a [[https://people.debian.org/~plessy/debconfTemplateToHTML.hs|script]] he is using to collate debconf templates in a [[https://people.debian.org/~plessy/DebianInstallerDebconfTemplates.html|single HTML page]].

Translation(s): English - Français


Preseeding d-i

Preseeding provides a way to set answers to questions asked during the installation process, without having to manually enter the answers while the installation is running. This makes it possible to fully automate most types of installation and even offers some features not available during normal installations.

Most of the questions asked by DebianInstaller can be preseeded by setting the answers in the debconf database. The Installation Guide includes an extensive appendix dedicated to preseeding. For concrete preseed files look below. Feel free to add any information that is not covered in the manual to the notes below.

Preseeding methods

As mentioned in the official installation guide, there are several ways to feed the preseed file to the installer.

Adding the preseed file to the installer's initrd.gz

Installation can be fully automated by adding a preseed file to the installer ISO's initrd.gz. This method is described in detail in this wiki article. The downside of this method is that net installer has to be generated whenever a preseed file is modified.

Autoloading the preseeding file from a webserver via DHCP

If you have control over the DHCP server on your network, this method allows fully automated installations; as demonstrated and documented at Hands-off.

Loading the preseeding file from a webserver

Most install methods you can interrupt early on and add a URL to a preseed file, for an almost fully automated installations. Here exemplified with the graphical installer:

  • When the graphical installer boot menu appears, press ESC

  • (Type "help" if you want view generic help)
  • Type "auto url=http://webserver/path/preseed.cfg", replacing the URL with the address to your preseed configuration file

The "auto" command launches the installation in the automated mode, where the configuration of hostname, locale and keymap are postponed so that they can be answered from the preseed file loaded from the network. You could use "install url=..." but you'd have to answer these questions manually, regardless of what you have in the preseed config.

Default preseed files

When creating a preseed file, you should start from a known good, default preseed file:

If you use a preseed file for an older, newer or otherwise different OS, you will most likely be prompted for answers at some point, even if you thought you automated everything.

Preseeding and the installer's debconf templates

As part of its construction the Debian Installer uses udeb files. These files are similar to normal .debs and have a control section which may contain a file called templates which, amongst other things, contains questions which can be asked during the installation. The answers to these questions can, in many cases, be preseeded. Not all udebs have a templates file.

If you have a .udeb its templates file can be extracted using apt-extracttemplates, which is in the apt-utils package. The command

apt-extracttemplates -t $PWD file.udeb

produces two files in the same directory as file.udeb. With ls -l you should see something like

file.config.S7Fsld
file.template.4tyDFV

The terminating string is a random one and the second file is the one of interest. This contains the information necessary to preseed answers to questions asked by the installer.

Processing templates files

Assuming you have all the available udeb files for your chosen suite (stable, testing or unstable) the templates files from them will be extracted by

UDEBS=*.udeb

for i in $UDEBS
do
   apt-extracttemplates -t $PWD $i
   rm *.config* 2>/dev/null
done

This is a script to obtain all English language information from a selection of templates and put it in a single file:

FILES=*.template*

for f in $FILES
do
# Have titled sections for data from each template file.
TITLE=$(echo $f |cut -d"." -f1)
echo -e "\n\n\n********** $TITLE **********" >> preseed.all

# Extract data from templates and do a bit of tidying up.
sed '/^Indices-.*\.UTF/d' $f        \
| awk '/^Template:/,/-.*\.UTF-8:/'  \
| awk '!/-.*\.UTF-8:/'              \
| sed '/^Template:/{x;p;x;}'        \                            
>> preseed.all
done

Most of the non-question data can be eliminated with

FILES=*.template*

for f in $FILES
do
# Have titled sections for data from each template file.
TITLE=$(echo $f |cut -d"." -f1)
echo -e "\n\n\n********** $TITLE **********" >> preseed.all

# Extract data from templates and remove text, error, title 
# and note data types.
sed '/^Indices-.*\.UTF/d' $f                            \
| awk '/^Template:/,/-.*\.UTF-8:/'                      \
| awk '!/-.*\.UTF-8:/'                                  \
| sed '/^Template:/{x;p;x;}'                            \
| sed ':a $!N;s/\nType: text/ Type: text/;ta P;D'       \
| sed '/Type: text/,/^$/d'                              \
| sed ':a $!N;s/\nType: error/ Type: error/;ta P;D'     \
| sed '/Type: error/,/^$/d'                             \
| sed ':a $!N;s/\nType: title/ Type: title/;ta P;D'     \
| sed '/Type: title/,/^$/d'                             \
| sed ':a $!N;s/\nType: note/ Type: note/;ta P;D'       \
| sed '/Type: note/,/^$/d'                              \
>> preseed.all
done

Obtaining udeb files

For a small handful of files it is probably convenient to download them from Debian website's Packages page (View package lists). However, it is worthwhile considering using apt-get and an archive in /etc/apt/sources.list. A suitable entry is:

deb http://httpredir.debian.org/debian stable main/debian-installer

Then

apt-get update
apt-get install <udeb_package_name>

With the previous entry as the only one in sources.list a list of available udebs can be written to a file using

apt-cache dumpavail | grep ^Package: | cut -d" " -f2 > udebpkgs

and the contents of udebpkgs downloaded with

for pkg in $(cat udebpkgs) ; do apt-get download $pkg ; done

Examples

Post here any links you have to example preseed files. Note that using any of these files directly is not wise, as a malicious person could probably come up with values for a preseed file that makes d-i misbehave. Also, the files are downloaded over http, so are vulnerable to man-in-the-middle spoof attacks. The best way to use any preseed file is to copy it to your own local web server or media, and look it over before using it.

Notes

  • Do not work off a debconf-get-selections (--installer) generated preseed.cfg but get the values from it and modify the example preseed file with them.

  • Be aware there is only one space in preseed files between subkey and value on "owner key/subkey value" lines.

  • Do not reboot in the base-config/late_command command, the installation process will start again at the start of the 2nd stage.

  • Preseeding has changed significantly in etch, preseed files for sarge will need to be updated or re-done. The largest change is the removal of base-config, which means that base-config/late_command and base-config/early_command are no longer available.

  • To install additional packages in etch, you can preseed preseed/early_command to run "apt-install package".

  • Look in debconf-devel(7) in the debconf-doc package for more docs about d-i and debian-installer preseed questions.
  • If your preseed value is being ignored and whilst using DEBCONF_DEBUG=5 to watch the debconf output you see "FSET blah false" it just means that a piece of code really wants that question to be seen, and such questions are not normally preseedable - the only way to avoid them is to avoid the situation that gives rise to that question being asked.