grml-live [-c <classe[s]>] [-t <target_directory>] [-F] [-h|--help]
*******************************************************************************
-Important! grml-live is under heavy construction, your feedback is highly
+Important! grml-live is under heavy construction, though your feedback is highly
appreciated. This document is growing as requested. If you have questions which
aren't answered by this document yet please let me (mika@grml.org) know!
*******************************************************************************
independent!
[NOTE]
+
Please notice that you should have a fast network connection as all the Debian
packages will be installed via network. If you want to use a local mirror
-(strongly recommended!) checkout
-mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror)
-debmirro(1) and reprepro(1) (check out
-/usr/share/doc/grml-live/examples/reprepro/ for a sample configuration).
-To avoid downloading of the base system check out FAI's
-NFSROOT (check docs for ../fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz).
+(strongly recommended!) checkout mkdebmirror (see
+/usr/share/doc/grml-live/examples/mkdebmirror), debmirror(1), reprepro(1) (see
+/usr/share/doc/grml-live/examples/reprepro/ for a sample configuration) and
+approx(8). To avoid downloading of the base system check out FAI's NFSROOT (check
+docs for ../fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz).
Options
-------
-c **CLASSES**::
Specify the CLASSES to be used for building the ISO via fai. By default only
-the classes GRML and I386 are assumed, resulting in a small base system (being
-about ~150MB ISO size).
+the classes GRMLBASE and I386 are assumed, resulting in a small base system
+(being about ~150MB ISO size).
+
+ -s **SUITE**::
+
+Specify the Debian suite you want to use for your live-system. Defaults to
+"etch"; support values are: etch, lenny, sid, stable, testing, unstable.
-t **TARGET_DIRECTORY**::
-Output directory of the build process of FAI - being the chroot
-used for building the ISO.
+Main output directory of the build process of FAI. Three directories are
+created inside the target directory, being: grml_cd/ - where the files for
+creating the ISO are located (including the compressed squashfs file),
+grml_chroot/ - the generated chroot system and grml_isos/ - where the resulting
+ISO is stored.
-F::
-Force execution and do not display summary of configuration details.
+Force execution and do not prompt for / display summary of configuration
+details.
- -h|--help::
+ -h::
Display short usage information and exit.
+ -v::
+
+Increase verbosity in the build process.
+
How to get your own live-cd - the easy, fast and simple way
-----------------------------------------------------------
-To get a small, Debian-stable and grml based live-cd using /dev/shm/
+To get a small, Debian-stable and grml based live-cd using /grml/grml-live
as build and output directory:
# grml-live
+To get a small Debian-unstable and grml-small based live-cd using
+/home/mika/grml-live as build and output directory:
+
+ # grml-live -c GRMLBASE,GRML_SMALL,I386 -t /home/mika/grml-live
+
[NOTE]
If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
empty /dev/shm, so please another directory for $CHROOT_TARGET, $BUILD_TARGET
and $ISO_TARGET if you plan to create more persistent output. :)
+Features
+--------
+
+* create a grml-/Debian-based Linux Live-CD with one single command
+
+* class based concept, providing a maximum of flexibility
+
+* supports integration of own hooks, scripts and configuration
+
+* supports use and integration of own Software and/or Kernels via use of Debian
+repositories
+
+* native support of FAI features
+
+* multi-arch support (work in progress)
+
The class concept
-----------------
according to your needs. This gives you flexibility and strength without losing
the simplicity in the build process.
-The main and base class provided by grml-live is named GRML. It's strongly
-recommended to **always** use the class GRML when building an ISO using
+The main and base class provided by grml-live is named GRMLBASE. It's strongly
+recommended to **always** use the class GRMLBASE when building an ISO using
grml-live as well as the architecture dependend class (being 'I386' for x86_32
currently only). The following files and directories are relevant for class GRML
by default:
- /etc/grml/fai/config/scripts/GRML/
- /etc/grml/fai/config/debconf/GRML
- /etc/grml/fai/config/class/GRML.var
- /etc/grml/fai/config/hooks/instsoft.GRML
- /etc/grml/fai/config/package_config/GRML
+ /etc/grml/fai/config/scripts/GRMLBASE/
+ /etc/grml/fai/config/debconf/GRMLBASE
+ /etc/grml/fai/config/class/GRMLBASE.var
+ /etc/grml/fai/config/hooks/instsoft.GRMLBASE
+ /etc/grml/fai/config/package_config/GRMLBASE
Take a look at the next section for information about the concept of those
files/directories.
If you want to use your own configuration, extend an existing configuration
and/or add additional packages to your ISO just invent a new class. For example
-if you want to use your own class named "FOOBAR" just extend CLASSES="GRML" inside
-/etc/grml/grml-live.conf to CLASSES="GRML,FOOBAR" or invoke grml-live using
-the classes option: "grml-live -c GRML,FOOBAR ...".
+if you want to use your own class named "FOOBAR" just extend CLASSES="GRMLBASE"
+inside /etc/grml/grml-live.conf to CLASSES="GRMLBASE,FOOBAR" or invoke grml-live
+using the classes option: "grml-live -c GRMLBASE,FOOBAR ...".
More details regarding the class concept can be found in the documentation of
FAI (available at /usr/share/doc/fai-doc/).
File with lists of software packages to be installed or removed. The different
classes describe what should find its way to your ISO. When running 'fai -v -C
-/etc/grml/fai -cGRML dirinstall ...' only the files from the directory GRML/
-will be taken, if you use 'fai -v -C /etc/grml/fai -cGRML,FOOBAR dirinstall ...'
-then the files of GRML/ **plus** the files from FOOBAR/ will be taken. So just
-create a new class to adjust it to your needs. Please notice that the directory
-GRML contains a package list defining a minimum but still reasonable package
-configuration.
+/etc/grml/fai -cGRMLBASE dirinstall ...' only the files from the directory GRML/
+will be taken, if you use 'fai -v -C /etc/grml/fai -cGRMLBASE,FOOBAR dirinstall
+...' then the files of GRML/ **plus** the files from FOOBAR/ will be taken. So
+just create a new class to adjust it to your needs. Please notice that the
+directory GRML contains a package list defining a minimum but still reasonable
+package configuration.
/etc/grml/fai/config/scripts/
Scripts for customising the ISO within build process.
+ /etc/grml/fai/files/
+
+This directory provides files used inside the scripts of
+/etc/grml/fai/config/scripts/*. For a full documentation what happens with the
+files please refer to the source of the scripts.
+
/etc/grml/fai/live-initramfs/
This directory provides the files used for building the initramfs/initrd via
Known TODOs
-----------
-* do not use /dev/shm/ als default target directory (which one do we want to use
-instead?)
+* make sure the suite-target adjusts the mirror definitions according (working
+also vice versa!) and you can define the mirror more central (without having to
+deal with /etc/grml/grml-live.conf, /etc/grml/fai/make-fai-nfsroot.conf and
+/etc/grml/fai/apt/sources.list; debootstrap [FAI_DEBOOTSTRAP] vs. apt inside
+chroot [sources.list] as well)
+
+* make sure $TARGET is mounted rw,suid,dev
+
+* write a step-by-step guide **how** to adjust **what** at **which** place
* add support for amd64 [gebi?] + ppc [formorer?] (and identify all packages
that are arch specific so we have a clean package list in all classes)
* support different grml-flavours through classes right out-of-the-box (being:
-grml, grml64, grml-small for at least x86, amd64 and ppc) [currently it defaults
-to Debian/stable I386]
-
-* support setting grml-live configuration on the command line to provide
-different flavours using the commandline only
-
-* really support signed apt repositories (currently it's deactivated via fai's
-dirinstall for some packages)
+grml, grml64, grml-small (in progress) for at least x86, amd64 and ppc)
-* explain (and provide configuration for) the use of NFSROOT
+* support signed apt repositories (currently it's deactivated via FAI's
+FAI_ALLOW_UNSIGNED=1 for some packages in the toolchain)
-* support setting stuff like ISO name, version,... (especially for stuff inside
-x86_files/boot/isolinux)
+* explain (and provide configuration for) use of NFSROOT
-* support "final builds" (including stuff like md5sums)
+* support setting stuff like ISO name, version,... on-the-fly (especially for
+stuff inside boot/isolinux/*)
-* use hooks of FAI as far as possible in all grml-live scripts
+* support "final builds" (including stuff like generating md5sums, gpg,...)
* the grml-live class(es) should send output as used inside FAI as well (so it's
not as verbose unless you specify it, make it configurable)
-* provide possibility for cleanup of all created build directories
+* provide possibility for cleanup of all created build directories and
+a smart summary of the buildprocess (including "took ... minutes/seconds to
+build...)
+
+* support hooks to allow further customisation of the build process
+
+* test the package on non-grml systems (and maybe even non-Debian) as well
+
+Debian package
+--------------
-* support hooks to further allow customisation of the build process
+Debian packages will be available through the grml-repository at
+link:http://deb.grml.org/[http://deb.grml.org/] as soon as the grml-team
+considers grml-live as stable enough. In the meantime just build the package on
+your own:
-* support nocolor-option for /etc/grml/fai/grml/grml_cleanup_chroot
+ hg clone http://hg.grml.org/grml-live
+ cd grml-live
+ debuild -us -uc
-* copy files from $FAI_CONFIGDIR/... instead of using 'cat > $FILE << EOF ...'
-inside all the /etc/grml/fai/config/scripts/GRML/-scripts
+Source
+------
-* provide autostart-stuff (for Windows) inside root of $BUILD_TARGET (the
-grml-cd)
+The source of grml-live is available at
+link:http://hg.grml.org/grml-live/[http://hg.grml.org/grml-live/]
Bugs
----
projects / grml-live.git / blobdiff