X-Git-Url: https://git.grml.org/?p=grml-live.git;a=blobdiff_plain;f=docs%2Fgrml-live.txt;h=335a92ba023d41584266caba25e75b4c226b1266;hp=0cf9f3b2ecad2e0357b530350bfcf631ffe4010b;hb=6136081d91da776f9a892f62a8bf7c79df545c14;hpb=d900a0e4047e51b27cda624a104ae97a1625c080 diff --git a/docs/grml-live.txt b/docs/grml-live.txt index 0cf9f3b..335a92b 100644 --- a/docs/grml-live.txt +++ b/docs/grml-live.txt @@ -81,11 +81,17 @@ really know that you do not want to update the chroot. Specify the CLASSES to be used for building the ISO via FAI. By default only the classes GRMLBASE, GRML_MEDIUM and I386 are assumed, resulting in a small base system (being about ~180MB total ISO size). If using a non-I386 system (like -amd64) you should specify the appropriate architecture as well. Additionally you +AMD64) you should specify the appropriate architecture as well. Additionally you can specify a class providing a grml-kernel (see <> for details about available classes). So instead of GRML_MEDIUM you can also use GRML_SMALL and GRML_FULL. +[IMPORTANT] +All class names should be written in uppercase letters. Do not use a dash, use +an underscore. So do not use "amd64" but "AMD64", do not use "FOO BAR" but +"FOO_BAR". + + -C **CONFIGURATION_FILE**:: The specified file is used as configuration file for grml-live. By default @@ -290,9 +296,6 @@ 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. -* GRML_FORENSIC: tools for forensic investigations which has been created -by people from link:http://www.forensic-geeks.org/[forensic-geeks.org]. - * GRML_FULL: full featured grml, also known as the "normal", full grml. * GRML_MEDIUM: medium sized grml version, known as grml-medium @@ -350,7 +353,7 @@ configuration instead. /etc/grml/grml-live.local All the local configuration should go to this file. This file overrides any -defaults of grml-live. Configurations via /etc/grml/grml-live.local are prefered +defaults of grml-live. Configurations via /etc/grml/grml-live.local are preferred over the ones from /etc/grml/grml-live.conf. If you want to override settings from /etc/grml/grml-live.local as well you have to specify them on the grml-live commandline. @@ -382,7 +385,7 @@ like to see included). Important: this file should *not* be adjusted manually! Instead use the GRML_LIVE_SOURCES variable inside /etc/grml/grml-live.conf or /etc/grml/grml-live.local which modifies /etc/grml/fai/apt/sources.list on-the-fly via grml-live then. If you want to generally adjust apt configuration -check out /etc/grml/fai/files/etc/apt instead. +use FAI's fcopy command with /etc/grml/fai/config/files instead. /etc/grml/fai/config/ @@ -420,12 +423,6 @@ reasonable package configuration. Scripts for customising the ISO within the 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 @@ -435,10 +432,9 @@ live-initramfs(8). Available log files ------------------- -grml-live itself logs to /var/log/grml-live.log. Unless you set ZERO_LOGFILE in -/etc/grml/grml-live.conf the output is appended to the file. If you set the -ZERO_LOGFILE configuration option the logfile will be truncated on each new -invocation of grml-live. +grml-live itself logs to /var/log/grml-live.log. Unless you set PRESERVE_LOGFILE +in your grml-live configuration the file is cleared on each new invocation of +grml-live. The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the default being /var/log/fai/grml/. @@ -446,6 +442,10 @@ default being /var/log/fai/grml/. If you are using the grml-live buildd you will find the logs of the grml-live run at /var/log/grml-buildd.stdout and /var/log/grml-buildd.stderr. +If you want to store build information in a database just install the +grml-live-db Debian package. Further details available in the grml-live-db +manpage. + [[requirements]] Requirements for the build system --------------------------------- @@ -538,22 +538,23 @@ ZLIB compression. Just use the defaults for enabling LZMA or use grml-live's * Kernel 2.6.26-grml[64]: does not work * Kernel 2.6.28-grml[64]: does not work * Kernel 2.6.31-grml[64]: works +* Kernel 2.6.33-grml[64]: works [NOTE] Please use squashfs-lzma-tools >=4.0-2 from Grml if you want to remaster any grml release being MORE RECENT than 2009.05. -Using squashfs-tools 1:4.0-1 on the build system +Using squashfs-tools 1:4.0-X on the build system ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -squashfs-tools 1:4.0-1 is available in Debian/unstable and Debian/testing. It +squashfs-tools >=1:4.0-1 is available in Debian/unstable and Debian/testing. It provides the mksquashfs and unsquashfs binaries. The package does NOT conflict with the squashfs-lzma-tools 4.0-2 package (you can install both of them at the same time). The packages can be downloaded from -link:ftp://ftp.de.debian.org/debian/pool/main/s/squashfs/[ftp://ftp.de.debian.org/debian/pool/main/s/squashfs/] +link:ftp://ftp.de.debian.org/debian/pool/main/s/squashfs-tools/[ftp://ftp.de.debian.org/debian/pool/main/s/squashfs-tools/] It provides support for the new squashfs file format version 4 and therefore requires kernel versions newer than 2.6.28-grml[64]. @@ -565,9 +566,10 @@ Grml's squashfs-lzma-tools (see section above) instead. * Kernel 2.6.26-grml[64]: does not work * Kernel 2.6.28-grml[64]: does not work * Kernel 2.6.31-grml[64]: works +* Kernel 2.6.33-grml[64]: works [NOTE] -Please use squashfs-tools 1:4.0-1 only if you want to remaster grml releases +Please use squashfs-tools >=1:4.0-1 only if you want to remaster grml releases MORE RECENT than 2009.05 using the ZLIB compression. Using squashfs-lzma-tools 3.3-1 on the build system @@ -664,11 +666,11 @@ Instructions # grml stable repository: deb http://deb.grml.org/ grml-stable main - deb-src http://deb.grml.org/ grml-stable main + # deb-src http://deb.grml.org/ grml-stable main # grml testing/development repository: deb http://deb.grml.org/ grml-testing main - deb-src http://deb.grml.org/ grml-testing main + # deb-src http://deb.grml.org/ grml-testing main EOF # adjust apt-pinning (only prefer squashfs stuff from grml): @@ -710,7 +712,7 @@ Instructions FAI_DEBOOTSTRAP="squeeze http://cdn.debian.net/debian/" ARCH="i386" CLASSES="GRMLBASE,GRML_MEDIUM,I386" - ZERO_LOGFILE='1' + # PRESERVE_LOGFILE='1' # ZERO_FAI_LOGFILE='1' GRML_LIVE_SOURCES=" deb http://deb.grml.org/ grml-stable main @@ -759,7 +761,8 @@ description to : # history | grep grml-live > /etc/grml/grml_live.cmdline # tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \ - /etc/grml/grml-buildd.conf /var/log/fai /etc/grml/fai + /etc/grml/grml_live.cmdline /etc/grml/grml-buildd.conf \ + /var/log/fai /etc/grml/fai -> finally mail grml_live_problem.tar.gz to If you need help with grml-live or would like to see new features as part of @@ -837,7 +840,7 @@ taken. If you customise the variables in /etc/grml/grml-live.conf then the two files will be adjusted during runtime automatically. If MIRROR_DIRECTORY and MIRROR_SOURCES are specified the local mirror will be -taken as first entry in the generated sources.list so it's prefered over +taken as first entry in the generated sources.list so it's preferred over non-local mirrors. Using a fallback mirror (via providing several mirrors in GRML_LIVE_SOURCES as used by default) is a recommended setting.