- install Debian packages from deb files on startup
- unpack configuration on startup
-The combination of Debs, Configuration and Scripts is called DCS in Brml. DCS
+The combination of Debs, Configuration and Scripts is called DCS in Grml. DCS
can be read from the Live Image itself, from an arbitrary file system on the
local system which is marked with the volume label GRMLCFG, or from the file
system pointed to by the myconfig boot parameter.
configuration archives manually as well. save-config is just a frontend which
should make it easier to use.
-The grml-autoconfig code has been re-worked in August 2009. This document
-handles both the behavior of Grml releases up to 2009.05 (see
-<<up-to-200905,section 'Behavior up to grml 2009.05'>>) and the current behavior
-(see <<current-versions,section 'Behavior in current Grml versions'>>). Great
-care has been taken to provide maximum backwards compatibility during the
-rewrite.
-
[IMPORTANT]
-Starting with grml release 2009.05 its possible to use root persistency on grml.
+Starting with Grml release 2009.05 its possible to use root persistency on grml.
This means you can store your settings and reuse them on reboot, without having
to deal with this config framework. Visit
-link:http://wiki.grml.org/doku.php?id=persistency for further information.
-
-[[up-to-200905]]
-Behavior up to grml 2009.05
----------------------------
-
-This section applies to all Grml versions older than and including release 2009.05.
-
-Autoconfiguration
-~~~~~~~~~~~~~~~~~
-
-By default the booting process tries to mount a device labeled 'GRMLCFG'. This
-provides the possibility to restore a configuration (named config.tbz) and
-execute a script (named grml.sh) without the need to specify any bootparams. If
-you want to disable this feature please take a look at the 'noautoconfig'
-bootparam.
-
-Boot parameters
-~~~~~~~~~~~~~~~
-
-As you probably know you can adjust boot parameters on the bootprompt. You want
-to set some boot parameters permanently? That's possible via adding a directory
-named 'bootparams' to the Grml-ISO which has to be located at the root-directory
-/bootparams/ (note: the directory is known as /live/image/bootparams/ on a
-_running_ grml system then). Place a textfile inside the directory containing
-the boot parameters which should be appended to default ones (this corresponds
-to booting without any special parameters). If you want to be able to boot from
-your Grml-CD you have to create a multisession CD. See the <<X7,usage
-scenarios>> for more details how to use it or consider booting from a USB device
-(checkout grml2usb).
-
-The following boot parameters are supported. Use them at the (isolinux)
-bootprompt as documented here.
-
-myconfig::
-
- This parameter is for restoring configuration using the file config.tbz
- on the specified device. Usage examples:
-
- myconfig=/dev/sda1 => use file config.tbz from usb-device
- myconfig=/dev/fd0 => use file config.tbz from floppy-disk
- myconfig=/dev/sda1 file=config_foobar.tbz => use file config_foobar.tbz from usb-device
-
-home::
-
- This parameter is for setting a specific partition as home directory.
- Usage examples:
-
- home=/dev/sda3 => use /dev/sda3 as the homepartition
- home=scan => scan through the available partitions and search
- for file grml.img
-
-partconf::
-
- This parameter mounts the specified device in read-only mode and tries to
- copy all files specified in /etc/grml/partconf to the Grml system. This
- provides the possibility to use the configuration of a harddisk
- installation. For example using the network configuration (which is
- specified in /etc/network) is possible using this boot parameter. Usage
- example:
-
- partconf=/dev/sda2 => try to mount /dev/sda2 and copy files specified
- in /etc/grml/partconf to the booted Grml system
-
-netconfig::
-
- Use this parameter to restore configuration using wget to download a
- configuration file from specified destination. Usage example:
-
- netconfig=server.tld/path/to/config.tbz => restore configuration using wget to download file config.tbz
-
-extract::
-
- Extract specific directories from configuration archive. Notice: This
- bootparam is useful only with bootparams which are able to extract
- configuration archives.
-
- extract=/home/grml => extract only /home/grml from archive
- extract=/etc => extract only /etc from archive
- extract=/home/grml/config => extract only $HOME/config from archive
-
-scripts::
-
- This parameter executes a script located in the root-directory /scripts/ on
- the Grml media/ISO (note: the directory is known as /live/image/scripts/ on
- a _running_ Grml system then). Usage examples:
-
- scripts => run script [/live/image]/scripts/grml.sh
- scripts=foobar.sh => run script foobar.sh in [/live/image]/scripts/
-
-config::
-
- This parameter restores a configuration using root-directory /config/ on the
- Grml media/ISO (note: the directory is known as /live/image/config on a
- _running_ Grml system then). Usage examples:
-
- config => restore configuration using file config.tbz from directory [/live/image]/config/
- config=config_foobar.tbz => restore configuration using file config_foobar.tbz from directory [/live/image]/config/
-
-debs::
-
- This parameter allows automatic installation of deb packages while booting.
- The debian packages have to be located in the root-directory /debs/ on the
- Grml media/ISO (note: the directory is known as /live/image/debs/ on a
- _running_ Grml system then). Usage examples:
-
- debs => install all debian packages (suffix .deb) from directory [/live/image]/debs/
- debs=01 => install all debian packages (suffix .deb) starting with 01 in the filename from directory [/live/image]/debs/
-
-
-noautoconfig::
-
- Deactivate automounting. By default the command 'mount' tries to mount a
- device with label 'GRMLCFG'. If you specify the noautoconfig bootparam the
- automounting will be deactivated.
-
- noautoconfig => disables auto mounting of label 'GRMLCFG'
+link:http://wiki.grml.org/doku.php?id=persistency[] for further information.
[[current-versions]]
-Behavior in current Grml versions
----------------------------------
-
-This section applies to all Grml versions newer than release 2009.05.
-
-The central concept of grml-autoconfig is the DCS directory which holds debs,
-configuration and scripts which are used during system startup.
-
-Determination of DCS directory
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-The DCS directory defaults to the root directory of the GRML live image. If a
-file system labeled GRMLCFG is found, the DCS directory is the root directory of
-that file system. Alternatively, the myconfig boot parameter can be used to
-directly specify a device which is then taken as DCS directory
-(myconfig=/dev/sda1, for example).
-
-Without any additional boot parameters, the GCA at DCSDIR/config.tbz is
-automatically unpacked and DCSDIR/scrips/grml.sh is automaitcally executed on
-system startup. The 'noautoconfig' boot parameter disables this automatic
-behavior.
-
-Boot Parameters
-~~~~~~~~~~~~~~~
-
-The following boot parameters are supported. Use them at the (isolinux)
-bootprompt as documented here.
-
-myconfig::
-
- This parameter directly sets DCSDIR to the root directory of the specified
- device. Usage examples:
-
- myconfig=/dev/sda1 => read DCS from usb-device
- myconfig=/dev/fd0 => read DCS from floppy-disk
-
-home::
-
- This parameter is for setting a specific partition as home directory. Usage
- examples:
-
- home=/dev/sda3 => use /dev/sda3 as the homepartition
- home=scan => scan through the available partitions and search
- for file grml.img
-
-partconf::
-
- This parameter mounts the specified device in read-only mode and tries to
- copy all files specified in /etc/grml/partconf to the Grml system. This
- provides the possibility to use the configuration of a harddisk
- installation. For example using the network configuration (which is
- specified in /etc/network) is possible using this boot parameter. Usage
- example:
-
- partconf=/dev/sda2 => try to mount /dev/sda2 and copy files specified
- in /etc/grml/partconf to the booted Grml system
-
-netconfig::
-
- Use this parameter to restore configuration using wget to download a GCA
- from the specified destination. Usage example:
-
- netconfig=server.tld/path/to/config.tbz => restore configuration using wget to download file config.tbz
-
-extract::
-
- Extract specific directories from the GCA which needs to be specified by
- other means.
-
- extract=/home/grml => extract only /home/grml from archive
- extract=/etc => extract only /etc from archive
- extract=/home/grml/config => extract only $HOME/config from archive
-
-scripts::
-
- This parameter executes scripts. If an optional path is given, it is
- relative to DCSDIR. If it points to a directory, all scripts inside this
- directory are executed. If the path points to a file, this single file is
- executed. If no path is given, it defaults to scripts/grml.sh. Usage
- examples:
-
- scripts => run script DCSDIR/scripts/grml.sh
- scripts=foobar.sh => run script foobar.sh in DCSDIR
- scripts=foobar => run all scripts inside DCSDIR/foobar directory
-
-config::
-
- This parameter restores a configuration using a GCA. If an optional path is
- given, it is relative to DCSDIR. If no path is given, it defaults to
- DCSDIR/config.tbz. Usage examples:
-
- config => restore configuration using file DCSDIR/config.tbz
- config=config_foobar.tbz => restore configuration using file DCSDIR/config_foobar.tbz
-
-debs::
-
- This parameter allows automatic installation of deb packages while booting.
- The path is relative to DCSDIR, not optional and is a shell wildcard. All
- Files matching the wildcard are installed in a single dpkg --install call.
- For backwards compatibility, if no slash is contained in the path, it is
- taken relative to DCSDIR/debs.
-
- Usage examples:
-
- debs=*.deb => install all debian packages (suffix .deb) from directory DCSDIR/debs/
- debs=foo/01*.deb => install all debian packages (suffix .deb) starting with 01 in the filename from directory DCSDIR/foo
-
-
-noautoconfig::
-
- Deactivate automounting. By default the scripts try to mount a device with
- label 'GRMLCFG'. If you specify the noautoconfig bootparam this automounting
- will be deactivated.
-
- noautoconfig => disables auto mounting of label 'GRMLCFG'
-
+include::grml-autoconfig.current.txt[]
Permanently adjust boot parameters
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
stick, use grub to boot from there and place debs, configuration scripts or Grml
configuraton archives alongside the .iso.
-Use persistent home directory
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-You want to use a persistent home directory which includes all the files located
-in $HOME. Use the script mkpersistenthome to create such a persistent home
-directory. You have the options to either use a specific partition as your home
-directory or add a loopback file named grml.img on the specified partition (the
-default).
-
-TIP: /dev/external in the partition selection of mkpersistenthome is an usb
-device without partitions. /dev/external1 corresponds to the first partition on
-an usb device (usually an usb stick).
-
-After running the script mkpersistenthome you can use the boot parameter home to
-activate the home directory. If you are using the option with the loopback file
-(grml.img) you can boot via:
-
- grml home=scan
-
-which will scan through the partitions and if a file grml.img is found it will
-be mounted as your $HOME-directory. If you want to use a partition as your home
-directory specify the device as an option. If you want to use /dev/sda2 as your
-$HOME boot via:
-
- grml home=/dev/sda2
-
-Notice: the files located in /etc/skel will be copied to the partition (but will
-not overwrite any files).
-
Bugs
----
-If you find a bug please report it. See link:http://grml.org/bugs/ for details
+If you find a bug please report it. See link:http://grml.org/bugs/[] for details
about how to report bugs.
See also
--------
-grml-autoconfig(8), mkpersistenthome(1), restore-config(1), save-config(1)
+grml-autoconfig(8), restore-config(1), save-config(1)
Author
------
projects / grml-autoconfig.git / blobdiff