X-Git-Url: http://git.grml.org/?p=grml-live.git;a=blobdiff_plain;f=docs%2Fgrml-live.txt;h=ad6b8fb8b56b952ddfae7e4464b371e701d58caf;hp=35241150a0dff0676c7cd2c1111053343bdf223e;hb=121b3484e;hpb=e44be9972f80fb31c08a7c87b478966caffaa8fa diff --git a/docs/grml-live.txt b/docs/grml-live.txt index 3524115..ad6b8fb 100644 --- a/docs/grml-live.txt +++ b/docs/grml-live.txt @@ -14,7 +14,7 @@ grml-live [-a ] [-c ] [-C ] [ -e ] [-g ] [-i ] [ -o ] [-r ] [-s ] [ -t ] [-v ] [-U ] [ --AbBFnNqQuVz] +-w ] [-AbBFnNqQuVz] Description ----------- @@ -232,6 +232,22 @@ Specify version number of the release. 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. @@ -285,7 +301,7 @@ 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 dependent class which provides the kernel (being 'I386' for x86_32 and 'AMD64' for x86_64) and a GRML_* class (like -GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are +GRML_SMALL or GRML_FULL). The following files and directories are relevant for class GRMLBASE by default: ${GRML_FAI_CONFIG}/config/scripts/GRMLBASE/ @@ -329,17 +345,11 @@ this class as well, so unless you have a really good reason you should always use this class. * GRML_FULL: full featured Grml, also known as the "normal", full grml as -introduced in December 2011 (~350MB ISO size). - -* GRML_MEDIUM: medium sized Grml version, used to be known as grml-medium -until December 2011 (~220MB ISO size). +introduced in December 2011 (~460MB ISO size). -* GRML_SMALL: minimum sized Grml version, known as grml-small (~110MB ISO +* GRML_SMALL: minimum sized Grml version, known as grml-small (~230MB ISO size). -* GRML_XL: large size Grml version, used to be known as "full grml" until -December 2011 (~700MB ISO size). - * LATEX: LaTeX(-related) packages like auctex, texlive,... (which used to be shipped by grml before the LaTeX removal) @@ -481,9 +491,8 @@ For further information see next section. 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 @@ -626,7 +635,7 @@ How do I add additional Debian package(s) to my CD/ISO? 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 @@ -647,35 +656,6 @@ what you are searching for just run: 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 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -707,36 +687,122 @@ syslinux) then just execute: % 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): + + 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 ./ + +[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. + +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: -Execute the following commands (requires root): + % cd /home/foobar/packages + % dpkg-scanpackages . /dev/null | gzip > Packages.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 * +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 -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). +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 ------