summaryrefslogtreecommitdiff
path: root/fi/appendix/preseed.xml
diff options
context:
space:
mode:
Diffstat (limited to 'fi/appendix/preseed.xml')
-rw-r--r--fi/appendix/preseed.xml275
1 files changed, 167 insertions, 108 deletions
diff --git a/fi/appendix/preseed.xml b/fi/appendix/preseed.xml
index bd1435690..17be3b04b 100644
--- a/fi/appendix/preseed.xml
+++ b/fi/appendix/preseed.xml
@@ -1,9 +1,9 @@
<!-- retain these comments for translator revision tracking -->
-<!-- original version: 36167 untranslated -->
+<!-- original version: 36269 untranslated -->
<!--
Be carefull with the format of this file as it is parsed to generate
-the example preseed file.
+the example preconfiguration file.
In that file all text between <informalexample> tags that have the
attribute 'role="example"' set is included, except if a 'condition'
attribute is in force that does not match the specified release or if an
@@ -23,7 +23,7 @@ This appendix explains the intricacies of preseeding answers to questions in
</para><para>
The configuration fragments used in this appendix are also available as an
-example preseed file from &urlset-example-preseed;.
+example preconfiguration file from &urlset-example-preseed;.
</para>
@@ -49,7 +49,7 @@ There are three methods that can be used for preseeding:
installation method and supports preseeding of more things, but it requires
the most preparation. File and network preseeding each can be used with
different installation methods. With file and network preseeding the first
-few installer questions cannot be preseeded because the preseed configuration
+few installer questions cannot be preseeded because the preconfiguration
file is only loaded after they have been asked.
</para><para>
@@ -105,7 +105,7 @@ installation methods.
</para><para>
An important difference between the preseeding methods is the point at which
-the preseed configuration file is loaded and processed. For initrd preseeding
+the preconfiguration file is loaded and processed. For initrd preseeding
this is right at the start of the installation, before the first question is
even asked. For file preseeding this is after the CD or CD image has been
loaded. For network preseeding it is only after the network has been
@@ -123,7 +123,7 @@ also already have been processed.
</para><para>
Obviously, any questions that have been processed before the
-preseeding configuration file is loaded cannot be preseeded.
+preconfiguration file is loaded cannot be preseeded.
<xref linkend="preseed-bootparms"/> offers a way to avoid these
questions being asked.
@@ -207,16 +207,16 @@ are stored in a separate, non-readable file in the same directory.
<title>Running custom commands during the installation</title>
<para>
-A very powerful and flexible option offered by the preseeding tools is the
-ability to run commands or scripts at certain points in the installation.
-See <xref linkend="preseed-shell"/> for details.
+A very powerful and flexible option offered by the preconfiguration tools
+is the ability to run commands or scripts at certain points in the
+installation. See <xref linkend="preseed-shell"/> for details.
</para>
<itemizedlist>
<listitem><para>
- <userinput>preseed/early_command</userinput>: is run as soon as the the
- preseeding configuration file has been loaded
+ <userinput>preseed/early_command</userinput>: is run as soon as the
+ preconfiguration file has been loaded
</para></listitem>
<listitem><para>
<userinput>preseed/late_command</userinput>: is run just before the reboot
@@ -250,25 +250,25 @@ d-i foo/bar seen false
<title>Using preseeding</title>
<para>
-Of course you will first need to create a preseed file and place it in the
-location from where you want to use it. Creating the preseed file is covered
-later in this appendix. Putting it in the correct location is fairly
+Of course you will first need to create a preconfiguration file and place it in
+the location from where you want to use it. Creating the preconfiguration file
+is covered later in this appendix. Putting it in the correct location is fairly
straightforward for network preseeding or if you want to read the file off
a floppy or usb-stick. If you want to include the file on a CD or DVD, you
-will have to remaster the ISO image. How to get the preseed file included
-in the initrd is outside the scope of this document; please consult the
-developers documentation for &d-i;.
+will have to remaster the ISO image. How to get the preconfiguration file
+included in the initrd is outside the scope of this document; please consult
+the developers documentation for &d-i;.
</para><para>
-An example preseed file that you can use as basis for your preseed file is
-available from &urlset-example-preseed;. This file is based on the
-configuration fragments included in this appendix.
+An example preconfiguration file that you can use as basis for your own
+preconfiguration file is available from &urlset-example-preseed;. This file is
+based on the configuration fragments included in this appendix.
</para>
<sect2 id="preseed-loading">
- <title>Loading the preseed file</title>
+ <title>Loading the preconfiguration file</title>
<para>
If you are using initrd preseeding, you only have to make sure a file named
@@ -286,16 +286,17 @@ parameter to the end of the append line(s) for the kernel.
</para><para>
-If you do specify the preseed file in the bootloader configuration, you might
-change the configuration so you don't need to hit enter to boot the installer.
-For syslinux this means setting the timeout to 1 in
-<filename>syslinux.cfg</filename>.
+If you do specify the preconfiguration file in the bootloader configuration,
+you might change the configuration so you don't need to hit enter to boot the
+installer. For syslinux this means setting the timeout to <literal>1</literal>
+in <filename>syslinux.cfg</filename>.
</para><para>
-To make sure the installer gets the right preseed file, you can optionally
-specify a checksum for the file. Currently this needs to be a md5sum, and if
-specified it must match the preseed file or the installer will refuse to use it.
+To make sure the installer gets the right preconfiguration file, you can
+optionally specify a checksum for the file. Currently this needs to be a
+md5sum, and if specified it must match the preconfiguration file or the
+installer will refuse to use it.
</para>
@@ -309,7 +310,7 @@ Boot parameters to specify:
preseed/file=/cdrom/preseed.cfg
preseed/file/checksum=5da499872becccfeda2c4872f9171c3d
-- if you're installing from USB media (put the preseed file in the
+- if you're installing from USB media (put the preconfiguration file in the
toplevel directory of the USB stick):
preseed/file=/hd-media/preseed.cfg
preseed/file/checksum=5da499872becccfeda2c4872f9171c3d
@@ -325,21 +326,21 @@ questions even if the preseeding below misses some.
</sect2>
<sect2 id="preseed-dhcp">
- <title>Using a DHCP server to specify preseed files</title>
+ <title>Using a DHCP server to specify preconfiguration files</title>
<para>
-It's also possible to use DHCP to specify a preseed file to download from
-the network. DHCP allows specifying a filename. Normally this is a file to
-netboot, but if it appears to be an URL then installation media that
-support network preseeding will download the file from the URL and use it
-as a preseed file. Here is an example of how to set it up in the dhcpd.conf
+It's also possible to use DHCP to specify a preconfiguration file to download
+from the network. DHCP allows specifying a filename. Normally this is a file
+to netboot, but if it appears to be an URL then installation media that
+support network preseeding will download the file from the URL and use it as a
+preconfiguration file. Here is an example of how to set it up in the dhcpd.conf
for version 3 of the ISC DHCP server (the dhcp3-server Debian package).
</para>
<informalexample><screen>
if substring (option vendor-class-identifier, 0, 3) = "d-i" {
- filename "http://host/preseed.cfg";
+ filename "http://host/preseed.cfg";
}
</screen></informalexample>
@@ -366,16 +367,16 @@ automate Debian installs should only be done with care.
<para>
Some parts of the installation process cannot be automated using some forms
-of preseeding because the questions are asked before the preseed file is
-loaded. For example, if the preseed file is downloaded over the network,
-the network setup must be done first. One reason to use initrd preseeding
-is that it allows preseeding of even these early steps of the installation
-process.
+of preseeding because the questions are asked before the preconfiguration
+file is loaded. For example, if the preconfiguration file is downloaded over
+the network, the network setup must be done first. One reason to use initrd
+preseeding is that it allows preseeding of even these early steps of the
+installation process.
</para><para>
-If a preseed file cannot be used to preseed some steps, the install can
-still be fully automated, since you can pass preseed values to the kernel
+If a preconfiguration file cannot be used to preseed some steps, the install
+can still be fully automated, since you can pass preseed values to the kernel
on the command line. Just pass <userinput>path/to/var=value</userinput>
for any of the preseed variables listed in the examples.
@@ -392,8 +393,8 @@ you can use 32 command line options and 32 environment options.
<para>
For most installations some of the default options in your bootloader
-configuration file, like 'vga=normal', may be safely removed which may
-allow you to add more options for preseeding.
+configuration file, like <literal>vga=normal</literal>, may be safely
+removed which may allow you to add more options for preseeding.
</para>
<note><para>
@@ -405,62 +406,119 @@ parameters, even if you delimit them with quotes.
</sect2>
</sect1>
- <sect1 condition="FIXME" id="preseed-creating">
- <title>Creating a preseed file</title>
+ <sect1 id="preseed-creating">
+ <title>Creating a preconfiguration file</title>
<para>
The preconfiguration file is in the format used by the
-<command>debconf-set-selections</command> command.
+<command>debconf-set-selections</command> command. The general format of
+a line in a preconfiguration file is:
+
+<informalexample><screen>
+&lt;owner&gt; &lt;template name&gt; &lt;template type&gt; &lt;value&gt;
+</screen></informalexample>
+
+</para><para>
+
+There are a few rules to keep in mind when writing a preconfiguration file.
</para>
<itemizedlist>
<listitem><para>
- File format
-</para></listitem>
-<listitem><para>
- Only single space allowed between template type and value
-</para></listitem>
-<listitem><para>
- Relation with /var/lib/(c)debconf/templates
+ Put only a single space or tab between type and value: any additional
+ whitespace will be interpreted as belonging to the value.
</para></listitem>
<listitem><para>
- Types of templates and how to provide values for them
+ A line can be split into multiple lines by appending a backslash
+ (<quote><literal>\</literal></quote>) as the line continuation character.
+ A good place to split a line is after the template name; a bad place is
+ between type and value.
</para></listitem>
<listitem><para>
- Most values need to be in English or codes
+ Most templates need to be preseeded using the values valid in English and
+ not the translated values. However, there are some templates (for example
+ in <classname>partman</classname> where the translated values need to be
+ used.
</para></listitem>
<listitem><para>
- Using a manual installation as base
-</para></listitem>
-<listitem><para>
- Finding other possible values
+ Some templates take a code as value instead of the English text that is
+ shown during installation.
</para></listitem>
</itemizedlist>
<para>
-To check if the format of your preseed file is valid before performing an
-install, you can use the command <command>debconf-set-selections -c
+The easiest way to create a preconfiguration file is to use the example file
+linked in <xref linkend="preseed-contents"/> as basis and work from there.
+
+</para><para>
+
+An alternative method is to do a manual installation and then, after
+rebooting, use the <command>debconf-get-selections</command> from the
+<classname>debconf-utils</classname> package to dump both the debconf
+database and the installer's cdebconf database to a single file:
+
+<informalexample><screen>
+$ debconf-get-selections --installer &gt; <replaceable>file</replaceable>
+$ debconf-get-selections &gt;&gt; <replaceable>file</replaceable>
+</screen></informalexample>
+
+</para><para>
+
+However, a file generated in this manner will have some items that should
+not be preseeded, and the example file is a better starting place for most
+users.
+
+</para>
+
+<note><para>
+
+This method relies on the fact that, at the end of the installation, the
+installer's cdebconf database is saved to the installed system in
+<filename>/var/log/installer/cdebconf</filename>. However, because the
+database may contain sensitive information, by default the files are only
+readable by root.
+
+</para><para>
+
+The directory <filename>/var/log/installer</filename> and all files in it
+will be deleted from your system if you purge the package
+<classname>installation-report</classname>.
+
+</para></note>
+
+<para>
+
+To check possible values for templates, you can use <command>nano</command>
+to examine the files in <filename>/var/lib/cdebconf</filename> while an
+installation is in progress. View <filename>templates.dat</filename> for
+the raw templates and <filename>questions.dat</filename> for the current
+values and for the values assigned to variables.
+
+</para><para>
+
+To check if the format of your preconfiguration file is valid before performing
+an install, you can use the command <command>debconf-set-selections -c
<replaceable>preseed.cfg</replaceable></command>.
</para>
</sect1>
<sect1 id="preseed-contents">
- <title>Contents of the preseed file</title>
+ <title>Contents of the preconfiguration file</title>
<para>
The configuration fragments used in this appendix are also available as an
-example preseed file from &urlset-example-preseed;.
+example preconfiguration file from &urlset-example-preseed;.
</para><para>
Note that this example is based on an installation for the Intel x86
architecture. If you are installing a different architecture, some of the
examples (like keyboard selection and bootloader installation) may not be
-relevant and will need to be replaced by debconf settings appropriate for your
-architecture.
+relevant and will need to be replaced by debconf settings appropriate for
+your architecture.
</para>
@@ -469,8 +527,8 @@ architecture.
<para>
Setting localization values will only work if you are using initrd preseeding.
-With all other methods the preseed file will only be loaded after these
-questions have been asked.
+With all other methods the preconfiguration file will only be loaded after
+these questions have been asked.
</para><para>
@@ -500,7 +558,7 @@ d-i console-keymaps-at/keymap select us
</para><para>
-To skip keyboard configuration preseed
+To skip keyboard configuration, preseed
<classname>console-tools/archs</classname> with
<userinput>skip-config</userinput>.
This will result in the kernel keymap remaining active.
@@ -521,15 +579,15 @@ architecture virtually obsolete. For 2.6 kernels normally a <quote>PC</quote>
<para>
Of course, preseeding the network configuration won't work if you're
-loading your preseed file from the network. But it's great when you're
-booting from CD or USB stick. If you are loading preseed files from
-the network, you can pass network config parameters in using kernel
-boot parameters.
+loading your preconfiguration file from the network. But it's great when
+you're booting from CD or USB stick. If you are loading preconfiguration
+files from the network, you can pass network config parameters by using
+kernel boot parameters.
</para><para>
If you need to pick a particular interface when netbooting before loading
-a preseed file from the network, use a boot parameter such as
+a preconfiguration file from the network, use a boot parameter such as
<userinput>netcfg/choose_interface=<replaceable>eth1</replaceable></userinput>.
</para>
@@ -550,9 +608,9 @@ d-i netcfg/choose_interface select auto
# the static network configuration below.
#d-i netcfg/disable_dhcp boolean true
-# If you want the preseed file to work on systems both with and without
-# a dhcp server, uncomment these lines and the static network configuration
-# below.
+# If you want the preconfiguration file to work on systems both with and
+# without a dhcp server, uncomment these lines and the static network
+# configuration below.
#d-i netcfg/dhcp_failed note
#d-i netcfg/dhcp_options select Configure network manually
@@ -598,8 +656,8 @@ for additional components for the installer. It is only useful to set this
if components are actually downloaded over the network and should match the
suite that was used to build the initrd for the installation method used for
the installation.
-By default the value for <classname>mirror/udeb/suite</classname> is the same
-as <classname>mirror/suite</classname>.
+By default the value for <classname>mirror/udeb/suite</classname> is the
+same as <classname>mirror/suite</classname>.
</para>
@@ -625,8 +683,9 @@ Using preseeding to partition the harddisk is very much limited to what is
supported by <classname>partman-auto</classname>. You can choose to either
partition existing free space on a disk or a whole disk. The layout of the
disk can be determined by using a predefined recipe, a custom recipe from
-a recipe file or a recipe included in the preseed file. It is currently not
-possible to partition multiple disks using preseeding nor to set up RAID.
+a recipe file or a recipe included in the preconfiguration file. It is
+currently not possible to partition multiple disks using preseeding nor to
+set up RAID.
</para>
@@ -640,7 +699,7 @@ correct one will be selected before using preseeding.
<informalexample role="example"><screen>
# If the system has free space you can choose to only partition that space.
-# Note: the preseed value for this template needs to be localized (translated).
+# Note: this template must be preseeded with a localized (translated) value.
#d-i partman-auto/init_automatically_partition \
# select Use the largest continuous free space
@@ -650,7 +709,7 @@ correct one will be selected before using preseeding.
d-i partman-auto/disk string /dev/discs/disc0/disc
# You can choose from any of the predefined partitioning recipes.
-# Note: the preseed value for this template needs to be localized (translated).
+# Note: this template must be preseeded with a localized (translated) value.
d-i partman-auto/choose_recipe \
select All files in one partition (recommended for new users)
#d-i partman-auto/choose_recipe \
@@ -664,9 +723,9 @@ d-i partman-auto/choose_recipe \
# just point at it.
#d-i partman-auto/expert_recipe_file string /hd-media/recipe
-# If not, you can put an entire recipe the preseed file in one (logical)
-# line. This example creates a small /boot partition, suitable swap, and
-# uses the rest of the space for the root partition:
+# If not, you can put an entire recipe the preconfiguration file in one
+# (logical) line. This example creates a small /boot partition, suitable
+# swap, and uses the rest of the space for the root partition:
#d-i partman-auto/expert_recipe string \
# boot-root :: \
# 40 50 100 ext3 \
@@ -747,10 +806,10 @@ text values or MD5 <emphasis>hashes</emphasis>.
<warning><para>
Be aware that preseeding passwords is not completely secure as everyone
-with access to the preseed file will have the knowledge of these passwords.
-Using MD5 hashes is considered slightly better in terms of security but it
-might also give a false sense of security as access to a MD5 hash allows
-for brute force attacks.
+with access to the preconfiguration file will have the knowledge of these
+passwords. Using MD5 hashes is considered slightly better in terms of
+security but it might also give a false sense of security as access to a
+MD5 hash allows for brute force attacks.
</para></warning>
@@ -780,12 +839,12 @@ for brute force attacks.
<para>
The <classname>passwd/root-password-crypted</classname> and
-<classname>passwd/user-password-crypted</classname> variables can also be
-preseeded with <quote>!</quote> as their value. In that case, the corresponding
-account is disabled. This may be convenient for the root account, provided
-of course that an alternate method is setup to allow administrative
-activities or root login (for instance by using SSH key authentication or
-sudo).
+<classname>passwd/user-password-crypted</classname> variables can also
+be preseeded with <quote>!</quote> as their value. In that case, the
+corresponding account is disabled. This may be convenient for the root
+account, provided of course that an alternative method is setup to allow
+administrative activities or root login (for instance by using SSH key
+authentication or <command>sudo</command>).
</para><para>
@@ -992,9 +1051,9 @@ xserver-xorg xserver-xorg/config/monitor/mode-list \
<informalexample role="example"><screen>
# d-i preseeding is inherently not secure. Nothing in the installer checks
# for attempts at buffer overflows or other exploits of the values of a
-# preseed file like this one. Only use preseed files from trusted
-# locations! To drive that home, and because it's generally useful, here's
-# a way to run any shell command you'd like inside the installer,
+# preconfiguration file like this one. Only use preconfiguration files from
+# trusted locations! To drive that home, and because it's generally useful,
+# here's a way to run any shell command you'd like inside the installer,
# automatically.
# This first command is run as early as possible, just after
@@ -1011,12 +1070,12 @@ xserver-xorg xserver-xorg/config/monitor/mode-list \
</sect2>
<sect2 id="preseed-chainload">
- <title>Chainloading preseed files</title>
+ <title>Chainloading preconfiguration files</title>
<para>
-It is possible to include other preseed files from a preseed file. Any
-settings in those files will override pre-existing settings from files
-loaded earlier. This makes it possible to put, for example, general
+It is possible to include other preconfiguration files from a preconfiguration
+file. Any settings in those files will override pre-existing settings from
+files loaded earlier. This makes it possible to put, for example, general
networking settings for your location in one file and more specific
settings for certain configurations in other files.
@@ -1026,16 +1085,16 @@ settings for certain configurations in other files.
# More that one file can be listed, separated by spaces; all will be
# loaded. The included files can have preseed/include directives of their
# own as well. Note that if the filenames are relative, they are taken from
-# the same directory as the preseed file that includes them.
+# the same directory as the preconfiguration file that includes them.
#d-i preseed/include string x.cfg
-# The installer can optionally verify checksums of preseed files before
-# using them. Currently only md5sums are supported, list the md5sums
+# The installer can optionally verify checksums of preconfiguration files
+# before using them. Currently only md5sums are supported, list the md5sums
# in the same order as the list of files to include.
#d-i preseed/include/checksum string 5da499872becccfeda2c4872f9171c3d
# More flexibly, this runs a shell command and if it outputs the names of
-# preseed files, includes those files.
+# preconfiguration files, includes those files.
#d-i preseed/include_command \
# string echo if [ "`hostname`" = bob ]; then echo bob.cfg; fi
</screen></informalexample>