-e <extract_iso_name>] [-g <grml_name>] [-i <iso_name>] [
-o <output_directory>] [-r <release_name>] [-s <suite>] [
-t <template_directory>] [-v <version_number>] [-U <username>] [
--AbBFnNqQuVz]
+-w <date>] [-AbBFnNqQuVz]
Description
-----------
Specify the CLASSES to be used for building the ISO via FAI. By default only
the classes GRMLBASE, GRML_FULL and I386/AMD64 (depending on system
-architecture) are assumed, resulting in a base system of about 350MB
-total ISO size. If using a non-I386 system (like AMD64) you should specify the
-appropriate architecture as well. Additionally you can specify a class providing
-a grml-kernel (see <<classes,the 'CLASSES' section in this document>> for
-details about available classes). So instead of GRML_FULL you can also use
-GRML_SMALL and GRML_FULL.
+architecture) are assumed. Additionally you can specify a class providing a
+(grml-)kernel (see <<classes,the 'CLASSES' section in this document>> for
+details about available classes). So instead of GRML_FULL you can also use e.g.
+GRML_SMALL.
[IMPORTANT]
All class names should be written in uppercase letters. Do not use a dash, use
Increase verbosity in the build process.
+ -w **DATE**::
+
+The wayback machine. Build the system using Debian archives from the specified
+date. Valid date formats are yyyymmddThhmmssZ or simply yyyymmdd. To learn
+which snapshots exist, i.e. which date strings are valid, simply browse the
+lists on http://snapshot.debian.org/. If there is no import at the exact time
+you specified you will get the latest available timestamp which is before the
+time you specified.
+This option is useful especially for release and debugging builds - for example
+if you know that the Debian archive was in a good state on a specific date but
+you want to build it on another day in the future, where the archive might not
+be as needed anymore. Please be aware that this is restricted to the plain
+Debian repositories only, as referred to in /etc/apt/sources.list.d/debian.list
+(so neither the Grml repositories nor any further custom ones are affected by
+the wayback machine).
+
-z::
Use ZLIB instead of LZMA/XZ compression in mksquashfs part of the build process.
Usage examples
--------------
-To get a Debian-stable and Grml-based Live-CD using /grml/grml-live
+To get a Debian-stable and Grml-based Live-CD using ./grml
as build and output directory just run:
# grml-live
* DEBORPHAN: get rid of all packages listed in output of deborphan
+* FILE_RC: instead of using systemd as init system use file-rc instead. file-rc
+was the init system used by Grml until and including stable release 2014.11,
+starting with beginning of 2016 Grml switched to systemd instead. If you want to
+build a live system in the old style using file-rc instead of systemd then enable
+this class. Please notice that support for file-rc is no longer being actively
+maintained (the Grml team happily accepts patches though) and file-rc (upstream
+wise) might disappear too.
+
* FRESHCLAM: execute freshclam (if it's present) to update clamav definitions
(increases resulting ISO size ~70MB). By default it's skipped to avoid bigger
ISO size.
* GRMLBASE: the main class responsible for getting a minimal subset of what's
defining a Grml system. Important parts of the buildprocess are specified in
this class as well, so unless you have a really good reason you should always
-use this class.
+use this class. Please be aware that using *just* the GRMLBASE class won't be
+enough, because the kernel packages (e.g. linux-image-i386-grml +
+linux-image-amd64-grml) are chosen in further GRML_* classes (to provide maximum
+flexibility with kernel selection). If you don't want to use the existing
+GRML_FULL or GRML_SMALL classes, define your own CLASS file choosing the kernel
+package you want to use (and don't forget to include your CLASS in the arguments
+of grml-live's -c... command line option).
* GRML_FULL: full featured Grml, also known as the "normal", full grml as
-introduced in December 2011 (~460MB ISO size).
+introduced in December 2011 (~600MB ISO size).
-* GRML_SMALL: minimum sized Grml version, known as grml-small (~230MB ISO
+* GRML_SMALL: minimum sized Grml version, known as grml-small (~300MB ISO
size).
* LATEX: LaTeX(-related) packages like auctex, texlive,...
grml-live on a plain Debian installation>> for details how to set up grml-live
on a plain, original Debian system.
-* enough free disk space; at least 800MB are required for a minimal grml-live
-run (\~400MB for the chroot [$CHROOT_OUTPUT], \~150MB for the build target
-[$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some
-temporary files), if you plan to use GRML_FULL you should have at least 4GB of
-total free disk space
+* enough free disk space; at least 1.5GB are required for a minimal grml-live
+run (\~850MB for the chroot [$CHROOT_OUTPUT], \~300MB for the build target
+[$BUILD_OUTPUT], \~30MB for the netboot files and \~300MB for the resulting ISO
+[$ISO_OUTPUT] plus some temporary files), if you plan to use GRML_FULL you
+should have at least 4GB of total free disk space
* fast network access for retrieving the Debian packages used for creating the
chroot (check out "local mirror" to workaround this problem as far as possible)
Current state of grml-live with squashfs-tools and kernel
---------------------------------------------------------
-Use squashfs-tools >=4.2-1 (available from Grml repositories as well as from
-Debian) to build Grml (based) ISOs featuring kernel version 2.6.38-grml[64] or
-newer.
+Use squashfs-tools >=4.2-1 to build Grml (based) ISOs featuring kernel version
+2.6.38-grml[64] or newer.
[[faq]]
FAQ
# SQUASHFS_BINARY='/usr/bin/mksquashfs'
## install local files into the chroot
# CHROOT_INSTALL="/etc/grml/fai/chroot_install"
- ## adjust if necessary (defaults to /grml/grml-live):
+ ## adjust if necessary (defaults to ./grml/):
## OUTPUT="/srv/grml-live"
FAI_DEBOOTSTRAP="jessie http://ftp.debian.org/debian/"
# ARCH="amd64"
Just create a new class (using the package_config directory):
# cat > /etc/grml/fai/config/package_config/MIKA << EOF
- PACKAGES aptitude
+ PACKAGES install
vim
another_name_of_a_debian_package
rm -rf /etc/grml/fai /etc/grml/grml-live.conf
dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb
-[[create-a-base-tgz]]
-How do I create a base.tgz?
-~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-First of all create the chroot using debootstrap:
-
- BASECHROOT='/tmp/basefile'
- debootstrap jessie "$BASECHROOT" http://ftp.debian.org/debian
- tar -C "$BASECHROOT" --exclude='var/cache/apt/archives/*.deb' -zcf base.tar.gz ./
-
-[TIP]
-By default debootstrap builds a chroot matching the architecture of the running
-host system. If you're using an amd64 system and want to build an i386 base.tgz
-then invoke debootstrap using the '--arch i386' option. Disclaimer: building an
-AMD64 base.tgz won't work if you are using a 32bit kernel system of course.
-
-Then move the base.tar.gz to /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz.
-Use e.g. I386 as $CLASSNAME for i386 chroots and AMD64 for amd64 chroots.
-
-Now executing grml-live should use this file as base system instead of executing
-debootstrap. Check out the output for something like:
-
- [...]
- ftar: extracting //etc/grml/fai/config/basefiles///AMD64.tar.gz to /srv/grml64_testing/grml_chroot//
- [...]
-
-[TIP]
-Existing base.tgz can be found at http://daily.grml.org/
-
[[apt-cacher]]
Set up apt-cacher-ng for use with grml-live
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
% isohybrid grml.iso
-[[basetgz]]
+[[create-a-base-tgz]]
How do I create a base tar.gz (I386.tar.gz or AMD64.tar.gz)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+[[basetgz]]
+
+First of all create the chroot using debootstrap (requires root):
-Execute the following commands (requires root):
+ BASECHROOT='/tmp/basefile' # path where the chroot gets generated
+ SUITE='jessie' # using the current stable release should always work
+ debootstrap --exclude=info,tasksel,tasksel-data "$SUITE" "$BASECHROOT" http://ftp.debian.org/debian
+ tar -C "$BASECHROOT" --exclude='var/cache/apt/archives/*.deb' -zcf "${SUITE}".tar.gz ./
- ARCH='amd64' # replace with i386 if necessary
- SUITE='jessie' # using the current stable release should always work
- debootstrap --arch "$ARCH" --exclude=info,tasksel,tasksel-data "$SUITE" "$ARCH" http://debian.netcologne.de/debian
- cd "$ARCH"
- rm var/cache/apt/archives/*.deb
- tar zcf ../"${ARCH}".tar.gz *
+[TIP]
+By default debootstrap builds a chroot matching the architecture of the running
+host system. If you're using an amd64 system and want to build an i386 base.tgz
+then invoke debootstrap using the '--arch i386' option. Disclaimer: building an
+AMD64 base.tgz won't work if you are using a 32bit kernel system of course.
-And finally place the generated tarball in /etc/grml/fai/config/basefiles/ (note
-that it needs to be uppercase letters matching the class names, so: AMD64.tar.gz
-for amd64 and I386.tar.gz for i386).
+Finally place the generated tarball in /etc/grml/fai/config/basefiles/ (note
+that it needs to be uppercase letters matching the class names, so: e.g.
+AMD64.tar.gz for amd64 and I386.tar.gz for i386).
+
+Then executing grml-live should use this file as base system instead of executing
+debootstrap. Check out the output for something like:
+
+ [...]
+ ftar: extracting //etc/grml/fai/config/basefiles///AMD64.tar.gz to /srv/grml64_testing/grml_chroot//
+ [...]
+
+[[localrepos]]
+How to use your own local repository
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Let's assume you have Debian package(s) in your filesystem inside
+`/home/foobar/local-packages` and want to provide them to your grml-live build.
+This can be achieved either 1) through a bind mount (using the MIRROR_DIRECTORY
+configuration) or 2) by serving a repository via HTTP.
+
+Serving via bind mount / MIRROR_DIRECTORY
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Make sure to create an according sources.list configuration file, e.g. using
+your own class name `CUSTOM`:
+
+ # cat > /etc/grml/fai/config/files/etc/apt/sources.list.d/local-packages.list/CUSTOM << EOF
+ deb file:///home/foobar/local-packages ./
+ EOF
+
+Add the according MIRROR_DIRECTORY configuration to your grml-live configuration:
+
+ # echo "MIRROR_DIRECTORY='/home/foobar/packages'" >> /etc/grml/grml-live.local
+
+Make sure the local directory looks like a mirror:
+
+ % cd /home/foobar/packages
+ % dpkg-scanpackages . /dev/null | gzip > Packages.gz
+
+Finally invoke grml-live with your class name (`CUSTOM` in this example) added
+to the list of classes on the command line (see grml-live option `-c`).
+
+Serving a repository via HTTP
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+Make sure to create an according sources.list configuration file, e.g. using
+your own class name `CUSTOM`:
+
+ # cat > /etc/grml/fai/config/files/etc/apt/sources.list.d/local-packages.list/CUSTOM << EOF
+ deb http://127.0.0.1:8000/ ./
+ EOF
+
+Make sure the local directory is served via HTTP on the according IP address and
+port. For the `http://127.0.0.1:8000/` example from above it should be enough to
+just invoke:
+
+ % cd /home/foobar/packages
+ % dpkg-scanpackages . /dev/null | gzip > Packages.gz
+ % python -m SimpleHTTPServer 8000
+
+[TIP]
+Of course you can also use a real Debian repository setup using tools like
+reprepro(1) and/or using a real web server, though for quick debugging sessions
+python's SimpleHTTPServer in combination with dpkg-scanpackages from package
+dpkg-dev is a simple and easy approach.
+
+Finally invoke grml-live with your class name (`CUSTOM` in this example) added
+to the list of classes on the command line (see grml-live option `-c`).
[[download]]
Download / install grml-live as a Debian package
------------------------------------------------
-Debian packages are available through the grml-repository at
-link:http://deb.grml.org/pool/main/g/grml-live/[deb.grml.org]. If you want to
-build a Debian package on your own (using for example a specific version or the
-current development tree), just execute:
+Stable Debian packages are available through the grml-repository at
+link:http://deb.grml.org/pool/main/g/grml-live/[deb.grml.org] and the latest
+Git commits are available as Debian packages from
+link:http://jenkins.grml.org/job/grml-live-binaries/[jenkins.grml.org].
+If you want to build a Debian package on your own (using for example a specific
+version or the current development tree), just execute:
git clone git://git.grml.org/grml-live
cd grml-live
debuild -us -uc
+[[run-from-git]]
+Run grml-live directly from git
+-------------------------------
+
+In case you want to run grml-live directly from the git repository checkout
+(after making sure all dependencies are installed), you should set
+`GRML_FAI_CONFIG` so that a) it finds the according FAI configuration files and
+b) does not use the config files of an possibly installed `grml-live` package.
+Usage example:
+
+ # export GRML_FAI_CONFIG=$(pwd)/etc/grml/fai
+ # export SCRIPTS_DIRECTORY=$(pwd)/scripts
+ # ./grml-live -s sid -a amd64 -c GRMLBASE,GRML_FULL,AMD64
+
[[source]]
Source
------
projects / grml-live.git / blobdiff