Release new version 0.13.3
[grml-autoconfig.git] / doc / grml-autoconfig.200905.txt
1 Behavior up to grml 2009.05
2 ---------------------------
3
4 This section applies to all Grml versions older than and including release 2009.05.
5
6 Autoconfiguration
7 ~~~~~~~~~~~~~~~~~
8
9 By default the booting process tries to mount a device labeled 'GRMLCFG'. This
10 provides the possibility to restore a configuration (named config.tbz) and
11 execute a script (named grml.sh) without the need to specify any bootparams. If
12 you want to disable this feature please take a look at the 'noautoconfig'
13 bootparam.
14
15 Boot parameters
16 ~~~~~~~~~~~~~~~
17
18 As you probably know you can adjust boot parameters on the bootprompt.  You want
19 to set some boot parameters permanently? That's possible via adding a directory
20 named 'bootparams' to the Grml-ISO which has to be located at the root-directory
21 /bootparams/ (note: the directory is known as /live/image/bootparams/ on a
22 _running_ grml system then). Place a textfile inside the directory containing
23 the boot parameters which should be appended to default ones (this corresponds
24 to booting without any special parameters). If you want to be able to boot from
25 your Grml-CD you have to create a multisession CD. See the <<X7,usage
26 scenarios>> for more details how to use it or consider booting from a USB device
27 (checkout grml2usb).
28
29 The following boot parameters are supported. Use them at the (isolinux)
30 bootprompt as documented here.
31
32 myconfig::
33
34    This parameter is for restoring configuration using the file config.tbz
35     on the specified device. Usage examples:
36
37   myconfig=/dev/sda1                        => use file config.tbz from usb-device
38   myconfig=/dev/fd0                         => use file config.tbz from floppy-disk
39   myconfig=/dev/sda1 file=config_foobar.tbz => use file config_foobar.tbz from usb-device
40
41 home::
42
43     This parameter is for setting a specific partition as home directory.
44     Usage examples:
45
46   home=/dev/sda3    =>  use /dev/sda3 as the homepartition
47   home=scan         =>  scan through the available partitions and search
48                         for file grml.img
49
50 partconf::
51
52     This parameter mounts the specified device in read-only mode and tries to
53     copy all files specified in /etc/grml/partconf to the Grml system. This
54     provides the possibility to use the configuration of a harddisk
55     installation. For example using the network configuration (which is
56     specified in /etc/network) is possible using this boot parameter. Usage
57     example:
58
59   partconf=/dev/sda2 => try to mount /dev/sda2 and copy files specified
60                         in /etc/grml/partconf to the booted Grml system
61
62 netconfig::
63
64     Use this parameter to restore configuration using wget to download a
65     configuration file from specified destination. Usage example:
66
67   netconfig=server.tld/path/to/config.tbz  =>   restore configuration using wget to download file config.tbz
68
69 extract::
70
71     Extract specific directories from configuration archive. Notice: This
72     bootparam is useful only with bootparams which are able to extract
73     configuration archives.
74
75   extract=/home/grml         => extract only /home/grml from archive
76   extract=/etc               => extract only /etc from archive
77   extract=/home/grml/config  => extract only $HOME/config from archive
78
79 scripts::
80
81     This parameter executes a script located in the root-directory /scripts/ on
82     the Grml media/ISO (note: the directory is known as /live/image/scripts/ on
83     a _running_ Grml system then). Usage examples:
84
85   scripts               =>   run script [/live/image]/scripts/grml.sh
86   scripts=foobar.sh     =>   run script foobar.sh in [/live/image]/scripts/
87
88 config::
89
90     This parameter restores a configuration using root-directory /config/ on the
91     Grml media/ISO (note: the directory is known as /live/image/config on a
92     _running_ Grml system then). Usage examples:
93
94   config                    =>   restore configuration using file config.tbz from directory [/live/image]/config/
95   config=config_foobar.tbz  =>   restore configuration using file config_foobar.tbz from directory [/live/image]/config/
96
97 debs::
98
99     This parameter allows automatic installation of deb packages while booting.
100     The debian packages have to be located in the root-directory /debs/ on the
101     Grml media/ISO (note: the directory is known as /live/image/debs/ on a
102     _running_ Grml system then). Usage examples:
103
104   debs              =>   install all debian packages (suffix .deb) from directory [/live/image]/debs/
105   debs=01           =>   install all debian packages (suffix .deb) starting with 01 in the filename from directory [/live/image]/debs/
106
107
108 noautoconfig::
109
110     Deactivate automounting. By default the command 'mount' tries to mount a
111     device with label 'GRMLCFG'. If you specify the noautoconfig bootparam the
112     automounting will be deactivated.
113
114   noautoconfig            => disables auto mounting of label 'GRMLCFG'
115
116