1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
\r
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
\r
5 <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=UTF-8" />
\r
6 <meta name="generator" content="AsciiDoc 8.6.6" />
\r
7 <title>grml-live(8)</title>
\r
8 <style type="text/css">
\r
9 /* Shared CSS for AsciiDoc xhtml11 and html5 backends */
\r
13 font-family: Georgia,serif;
\r
17 h1, h2, h3, h4, h5, h6,
\r
18 div.title, caption.title,
\r
19 thead, p.table.header,
\r
21 #author, #revnumber, #revdate, #revremark,
\r
23 font-family: Arial,Helvetica,sans-serif;
\r
27 margin: 1em 5% 1em 5%;
\r
32 text-decoration: underline;
\r
48 h1, h2, h3, h4, h5, h6 {
\r
51 margin-bottom: 0.5em;
\r
56 border-bottom: 2px solid silver;
\r
76 border: 1px solid silver;
\r
81 margin-bottom: 0.5em;
\r
87 ul > li { color: #aaa; }
\r
88 ul > li > * { color: black; }
\r
102 #revnumber, #revdate, #revremark {
\r
107 border-top: 2px solid silver;
\r
108 padding-top: 0.5em;
\r
113 padding-bottom: 0.5em;
\r
117 padding-bottom: 0.5em;
\r
122 margin-bottom: 1.5em;
\r
124 div.imageblock, div.exampleblock, div.verseblock,
\r
125 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
\r
126 div.admonitionblock {
\r
128 margin-bottom: 1.5em;
\r
130 div.admonitionblock {
\r
132 margin-bottom: 2.0em;
\r
137 div.content { /* Block element content. */
\r
141 /* Block element titles. */
\r
142 div.title, caption.title {
\r
147 margin-bottom: 0.5em;
\r
153 td div.title:first-child {
\r
156 div.content div.title:first-child {
\r
159 div.content + div.title {
\r
163 div.sidebarblock > div.content {
\r
164 background: #ffffee;
\r
165 border: 1px solid #dddddd;
\r
166 border-left: 4px solid #f0f0f0;
\r
170 div.listingblock > div.content {
\r
171 border: 1px solid #dddddd;
\r
172 border-left: 5px solid #f0f0f0;
\r
173 background: #f8f8f8;
\r
177 div.quoteblock, div.verseblock {
\r
178 padding-left: 1.0em;
\r
179 margin-left: 1.0em;
\r
181 border-left: 5px solid #f0f0f0;
\r
185 div.quoteblock > div.attribution {
\r
186 padding-top: 0.5em;
\r
190 div.verseblock > pre.content {
\r
191 font-family: inherit;
\r
192 font-size: inherit;
\r
194 div.verseblock > div.attribution {
\r
195 padding-top: 0.75em;
\r
198 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
\r
199 div.verseblock + div.attribution {
\r
203 div.admonitionblock .icon {
\r
204 vertical-align: top;
\r
207 text-decoration: underline;
\r
209 padding-right: 0.5em;
\r
211 div.admonitionblock td.content {
\r
212 padding-left: 0.5em;
\r
213 border-left: 3px solid #dddddd;
\r
216 div.exampleblock > div.content {
\r
217 border-left: 3px solid #dddddd;
\r
218 padding-left: 0.5em;
\r
221 div.imageblock div.content { padding-left: 0; }
\r
222 span.image img { border-style: none; }
\r
223 a.image:visited { color: white; }
\r
227 margin-bottom: 0.8em;
\r
232 font-style: normal;
\r
235 dd > *:first-child {
\r
240 list-style-position: outside;
\r
243 list-style-type: decimal;
\r
246 list-style-type: lower-alpha;
\r
249 list-style-type: upper-alpha;
\r
252 list-style-type: lower-roman;
\r
255 list-style-type: upper-roman;
\r
258 div.compact ul, div.compact ol,
\r
259 div.compact p, div.compact p,
\r
260 div.compact div, div.compact div {
\r
262 margin-bottom: 0.1em;
\r
274 margin-bottom: 0.8em;
\r
277 padding-bottom: 15px;
\r
279 dt.hdlist1.strong, td.hdlist1.strong {
\r
283 vertical-align: top;
\r
284 font-style: normal;
\r
285 padding-right: 0.8em;
\r
289 vertical-align: top;
\r
291 div.hdlist.compact tr {
\r
297 background: yellow;
\r
300 .footnote, .footnoteref {
\r
304 span.footnote, span.footnoteref {
\r
305 vertical-align: super;
\r
309 margin: 20px 0 20px 0;
\r
310 padding: 7px 0 0 0;
\r
313 #footnotes div.footnote {
\r
319 border-top: 1px solid silver;
\r
328 padding-right: 0.5em;
\r
329 padding-bottom: 0.3em;
\r
330 vertical-align: top;
\r
332 div.colist td img {
\r
337 #footer-badges { display: none; }
\r
341 margin-bottom: 2.5em;
\r
349 margin-bottom: 0.1em;
\r
352 div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
\r
369 span.aqua { color: aqua; }
\r
370 span.black { color: black; }
\r
371 span.blue { color: blue; }
\r
372 span.fuchsia { color: fuchsia; }
\r
373 span.gray { color: gray; }
\r
374 span.green { color: green; }
\r
375 span.lime { color: lime; }
\r
376 span.maroon { color: maroon; }
\r
377 span.navy { color: navy; }
\r
378 span.olive { color: olive; }
\r
379 span.purple { color: purple; }
\r
380 span.red { color: red; }
\r
381 span.silver { color: silver; }
\r
382 span.teal { color: teal; }
\r
383 span.white { color: white; }
\r
384 span.yellow { color: yellow; }
\r
386 span.aqua-background { background: aqua; }
\r
387 span.black-background { background: black; }
\r
388 span.blue-background { background: blue; }
\r
389 span.fuchsia-background { background: fuchsia; }
\r
390 span.gray-background { background: gray; }
\r
391 span.green-background { background: green; }
\r
392 span.lime-background { background: lime; }
\r
393 span.maroon-background { background: maroon; }
\r
394 span.navy-background { background: navy; }
\r
395 span.olive-background { background: olive; }
\r
396 span.purple-background { background: purple; }
\r
397 span.red-background { background: red; }
\r
398 span.silver-background { background: silver; }
\r
399 span.teal-background { background: teal; }
\r
400 span.white-background { background: white; }
\r
401 span.yellow-background { background: yellow; }
\r
403 span.big { font-size: 2em; }
\r
404 span.small { font-size: 0.6em; }
\r
406 span.underline { text-decoration: underline; }
\r
407 span.overline { text-decoration: overline; }
\r
408 span.line-through { text-decoration: line-through; }
\r
417 font-family: monospace;
\r
418 font-size: inherit;
\r
424 margin-bottom: 1.5em;
\r
426 div.tableblock > table {
\r
427 border: 3px solid #527bbd;
\r
429 thead, p.table.header {
\r
436 /* Because the table frame attribute is overriden by CSS in most browsers. */
\r
437 div.tableblock > table[frame="void"] {
\r
438 border-style: none;
\r
440 div.tableblock > table[frame="hsides"] {
\r
441 border-left-style: none;
\r
442 border-right-style: none;
\r
444 div.tableblock > table[frame="vsides"] {
\r
445 border-top-style: none;
\r
446 border-bottom-style: none;
\r
456 font-family: monospace;
\r
457 font-size: inherit;
\r
463 margin-bottom: 1.5em;
\r
465 thead, p.tableblock.header {
\r
474 border-spacing: 0px;
\r
475 border-style: solid;
\r
476 border-color: #527bbd;
\r
477 border-collapse: collapse;
\r
479 th.tableblock, td.tableblock {
\r
482 border-style: solid;
\r
483 border-color: #527bbd;
\r
486 table.tableblock.frame-topbot {
\r
487 border-left-style: hidden;
\r
488 border-right-style: hidden;
\r
490 table.tableblock.frame-sides {
\r
491 border-top-style: hidden;
\r
492 border-bottom-style: hidden;
\r
494 table.tableblock.frame-none {
\r
495 border-style: hidden;
\r
498 th.tableblock.halign-left, td.tableblock.halign-left {
\r
501 th.tableblock.halign-center, td.tableblock.halign-center {
\r
502 text-align: center;
\r
504 th.tableblock.halign-right, td.tableblock.halign-right {
\r
508 th.tableblock.valign-top, td.tableblock.valign-top {
\r
509 vertical-align: top;
\r
511 th.tableblock.valign-middle, td.tableblock.valign-middle {
\r
512 vertical-align: middle;
\r
514 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
\r
515 vertical-align: bottom;
\r
525 padding-top: 0.5em;
\r
526 padding-bottom: 0.5em;
\r
527 border-top: 2px solid silver;
\r
528 border-bottom: 2px solid silver;
\r
531 border-style: none;
\r
533 body.manpage div.sectionbody {
\r
538 body.manpage div#toc { display: none; }
\r
541 <script type="text/javascript">
\r
543 var asciidoc = { // Namespace.
\r
545 /////////////////////////////////////////////////////////////////////
\r
546 // Table Of Contents generator
\r
547 /////////////////////////////////////////////////////////////////////
\r
549 /* Author: Mihai Bazon, September 2002
\r
550 * http://students.infoiasi.ro/~mishoo
\r
552 * Table Of Content generator
\r
555 * Feel free to use this script under the terms of the GNU General Public
\r
556 * License, as long as you do not remove or alter this notice.
\r
559 /* modified by Troy D. Hanson, September 2006. License: GPL */
\r
560 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
\r
562 // toclevels = 1..4.
\r
563 toc: function (toclevels) {
\r
565 function getText(el) {
\r
567 for (var i = el.firstChild; i != null; i = i.nextSibling) {
\r
568 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
\r
570 else if (i.firstChild != null)
\r
571 text += getText(i);
\r
576 function TocEntry(el, text, toclevel) {
\r
579 this.toclevel = toclevel;
\r
582 function tocEntries(el, toclevels) {
\r
583 var result = new Array;
\r
584 var re = new RegExp('[hH]([2-'+(toclevels+1)+'])');
\r
585 // Function that scans the DOM tree for header elements (the DOM2
\r
586 // nodeIterator API would be a better technique but not supported by all
\r
588 var iterate = function (el) {
\r
589 for (var i = el.firstChild; i != null; i = i.nextSibling) {
\r
590 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
\r
591 var mo = re.exec(i.tagName);
\r
592 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
\r
593 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
\r
603 var toc = document.getElementById("toc");
\r
608 // Delete existing TOC entries in case we're reloading the TOC.
\r
609 var tocEntriesToRemove = [];
\r
611 for (i = 0; i < toc.childNodes.length; i++) {
\r
612 var entry = toc.childNodes[i];
\r
613 if (entry.nodeName == 'div'
\r
614 && entry.getAttribute("class")
\r
615 && entry.getAttribute("class").match(/^toclevel/))
\r
616 tocEntriesToRemove.push(entry);
\r
618 for (i = 0; i < tocEntriesToRemove.length; i++) {
\r
619 toc.removeChild(tocEntriesToRemove[i]);
\r
622 // Rebuild TOC entries.
\r
623 var entries = tocEntries(document.getElementById("content"), toclevels);
\r
624 for (var i = 0; i < entries.length; ++i) {
\r
625 var entry = entries[i];
\r
626 if (entry.element.id == "")
\r
627 entry.element.id = "_toc_" + i;
\r
628 var a = document.createElement("a");
\r
629 a.href = "#" + entry.element.id;
\r
630 a.appendChild(document.createTextNode(entry.text));
\r
631 var div = document.createElement("div");
\r
632 div.appendChild(a);
\r
633 div.className = "toclevel" + entry.toclevel;
\r
634 toc.appendChild(div);
\r
636 if (entries.length == 0)
\r
637 toc.parentNode.removeChild(toc);
\r
641 /////////////////////////////////////////////////////////////////////
\r
642 // Footnotes generator
\r
643 /////////////////////////////////////////////////////////////////////
\r
645 /* Based on footnote generation code from:
\r
646 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
\r
649 footnotes: function () {
\r
650 // Delete existing footnote entries in case we're reloading the footnodes.
\r
652 var noteholder = document.getElementById("footnotes");
\r
656 var entriesToRemove = [];
\r
657 for (i = 0; i < noteholder.childNodes.length; i++) {
\r
658 var entry = noteholder.childNodes[i];
\r
659 if (entry.nodeName == 'div' && entry.getAttribute("class") == "footnote")
\r
660 entriesToRemove.push(entry);
\r
662 for (i = 0; i < entriesToRemove.length; i++) {
\r
663 noteholder.removeChild(entriesToRemove[i]);
\r
666 // Rebuild footnote entries.
\r
667 var cont = document.getElementById("content");
\r
668 var spans = cont.getElementsByTagName("span");
\r
671 for (i=0; i<spans.length; i++) {
\r
672 if (spans[i].className == "footnote") {
\r
674 var note = spans[i].getAttribute("data-note");
\r
676 // Use [\s\S] in place of . so multi-line matches work.
\r
677 // Because JavaScript has no s (dotall) regex flag.
\r
678 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
\r
679 spans[i].innerHTML =
\r
680 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
\r
681 "' title='View footnote' class='footnote'>" + n + "</a>]";
\r
682 spans[i].setAttribute("data-note", note);
\r
684 noteholder.innerHTML +=
\r
685 "<div class='footnote' id='_footnote_" + n + "'>" +
\r
686 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
\r
687 n + "</a>. " + note + "</div>";
\r
688 var id =spans[i].getAttribute("id");
\r
689 if (id != null) refs["#"+id] = n;
\r
693 noteholder.parentNode.removeChild(noteholder);
\r
695 // Process footnoterefs.
\r
696 for (i=0; i<spans.length; i++) {
\r
697 if (spans[i].className == "footnoteref") {
\r
698 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
\r
699 href = href.match(/#.*/)[0]; // Because IE return full URL.
\r
701 spans[i].innerHTML =
\r
702 "[<a href='#_footnote_" + n +
\r
703 "' title='View footnote' class='footnote'>" + n + "</a>]";
\r
709 install: function(toclevels) {
\r
712 function reinstall() {
\r
713 asciidoc.footnotes();
\r
715 asciidoc.toc(toclevels);
\r
719 function reinstallAndRemoveTimer() {
\r
720 clearInterval(timerId);
\r
724 timerId = setInterval(reinstall, 500);
\r
725 if (document.addEventListener)
\r
726 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
\r
728 window.onload = reinstallAndRemoveTimer;
\r
732 asciidoc.install(2);
\r
736 <body class="article">
\r
738 <h1>grml-live(8)</h1>
\r
740 <div id="toctitle">Table of Contents</div>
741 <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
745 <div class="sect1">
\r
746 <h2 id="_name">1. Name</h2>
\r
747 <div class="sectionbody">
\r
748 <div class="paragraph"><p>grml-live - build framework based on FAI for generating a Grml and Debian based
\r
749 Linux Live system (CD/ISO)</p></div>
\r
752 <div class="sect1">
\r
753 <h2 id="_synopsis">2. Synopsis</h2>
\r
754 <div class="sectionbody">
\r
755 <div class="paragraph"><p>grml-live [-a <architecture>] [-c <classe[s]>] [-C <configfile>] [-g
\r
756 <grml_name>] [-i <iso_name> ] [-o <output_directory>] [-r <release_name>] [-s
\r
757 <suite>] [-t <template_directory>] [-v <version_number>] [-U <username>] [
\r
758 -AbBFnNqQuVz]</p></div>
\r
761 <div class="sect1">
\r
762 <h2 id="_description">3. Description</h2>
\r
763 <div class="sectionbody">
\r
764 <div class="paragraph"><p>grml-live provides the build system for creating a Grml and Debian based Linux
\r
765 Live-CD. The build system is based on
\r
766 <a href="http://fai-project.org/">FAI</a> (Fully Automatic
\r
767 Installation). grml-live uses the "fai dirinstall" feature to generate a chroot
\r
768 system based on the class concept of FAI (see later sections for further
\r
769 details) and provides the framework to be able to generate a full-featured ISO.
\r
770 It does not use all the FAI features by default though and you don’t have to
\r
771 know FAI to be able to use it.</p></div>
\r
772 <div class="paragraph"><p>The use of FAI gives you the flexibility to choose the packages you would like
\r
773 to include on your very own Linux Live-CD without having to deal with all the
\r
774 details of a build process.</p></div>
\r
775 <div class="admonitionblock">
\r
778 <img src="./images/icons/caution.png" alt="Caution" />
\r
780 <td class="content">grml-live does <strong>not</strong> use /etc/fai for configuration but instead
\r
781 (unless overridden using the <em>'-D</em>' option). This ensures that it does not clash
\r
782 with default FAI configuration and packages, so you can use grml-live and FAI
\r
783 completely independent at the same time!</td>
\r
786 <div class="admonitionblock">
\r
789 <img src="./images/icons/note.png" alt="Note" />
\r
791 <td class="content">Please notice that you should have a fast network connection as all the Debian
\r
792 packages will be downloaded and installed via network. If you want to use a
\r
793 local mirror (strongly recommended if you plan to use grml-live more than once)
\r
794 checkout mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror),
\r
795 debmirror(1), reprepro(1) (see /usr/share/doc/grml-live/examples/reprepro/ for a
\r
796 sample configuration), apt-cacher(1) and approx(8). To avoid downloading the
\r
797 base system again and again check out <a href="#create-a-base-tgz">the base tar.gz feature</a>.</td>
\r
802 <div class="sect1">
\r
803 <h2 id="_options">4. Options</h2>
\r
804 <div class="sectionbody">
\r
805 <div class="dlist"><dl>
\r
806 <dt class="hdlist1">
\r
811 Clean up output directories before attempting the build. Packs the chroot
\r
812 into a tar archive, and removes chroot and ISO build directories before exiting.
\r
815 <dt class="hdlist1">
\r
816 -a <strong>ARCHITECTURE</strong>
\r
820 Use the specified architecture instead of the currently running one. This
\r
821 allows building a 32bit system on a 64bit host (though you can’t build a 64bit
\r
822 system on a 32bit system/kernel of course). Please notice that real
\r
823 crosscompiling (like building a ppc system on x86) isn’t possible due to the
\r
824 nature and the need of working in a chroot. Currently supported values: i386
\r
828 <dt class="hdlist1">
\r
833 Build the ISO without updating the chroot via FAI. This option is useful for
\r
834 example when working on stable releases: if you have a working base
\r
835 system/chroot and do not want to execute any further updates (via "-u" option)
\r
836 but intend to only build the ISO.
\r
839 <dt class="hdlist1">
\r
844 Build the ISO without touching the chroot at all. This option is useful if
\r
845 you modified anything that FAI or grml-live might adjust via Grml’s FAI
\r
846 scripts. It’s like the <em>-b</em> option but even more advanced. Use only if you
\r
847 really know that you do not want to update the chroot.
\r
850 <dt class="hdlist1">
\r
851 -c <strong>CLASSES</strong>
\r
855 Specify the CLASSES to be used for building the ISO via FAI. By default only
\r
856 the classes GRMLBASE, GRML_FULL and I386/AMD64 (depending on system
\r
857 architecture) are assumed, resulting in a base system of about 350MB
\r
858 total ISO size. If using a non-I386 system (like AMD64) you should specify the
\r
859 appropriate architecture as well. Additionally you can specify a class providing
\r
860 a grml-kernel (see <a href="#classes">the <em>CLASSES</em> section in this document</a> for
\r
861 details about available classes). So instead of GRML_FULL you can also use
\r
862 GRML_SMALL and GRML_FULL.
\r
866 <div class="admonitionblock">
\r
869 <img src="./images/icons/important.png" alt="Important" />
\r
871 <td class="content">All class names should be written in uppercase letters. Do not use a dash, use
\r
872 an underscore. So do not use "amd64" but "AMD64", do not use "FOO BAR" but
\r
876 <div class="dlist"><dl>
\r
877 <dt class="hdlist1">
\r
878 -C <strong>CONFIGURATION_FILE</strong>
\r
882 The specified file is used as configuration file for grml-live. By default
\r
883 /etc/grml/grml-live.conf is used as default configuration. If a file named
\r
884 /etc/grml/grml-live.local exists it is used as well (sourced after reading
\r
885 /etc/grml/grml-live.conf meant as main file for local configuration). As a last
\r
886 option the specified configuration file is sourced so it is possible to override
\r
887 settings of /etc/grml/grml-live.conf as well as of /etc/grml/grml-live.local.
\r
888 Please notice that all configuration files have to be adjusted during execution
\r
889 of grml-live, so please make sure you use /etc/grml/grml-live.conf as a base for
\r
890 your own configuration file (usually /etc/grml/grml-live.local). Please also
\r
891 notice that the configuration file specified via this option is <strong>not</strong> (yet)
\r
892 /etc/grml/grml-live.local for configuration stuff used inside
\r
895 <dt class="hdlist1">
\r
896 -d <strong>DATE</strong>
\r
900 Use specified date as build date information on the ISO instead of the default.
\r
901 The default is the date when grml-live is being executed (retrieved via
\r
902 executing <em>date +%Y-%m-%d</em>). The information is stored inside the file
\r
903 /GRML/grml-version on the ISO, /etc/grml_version in the squashfs file and in all
\r
904 the bootsplash related files. This option is useful if you want to provide an
\r
905 ISO with release information for a specific date but have to build it in
\r
906 advance. Usage example: <em>-d 2009-10-30</em>
\r
909 <dt class="hdlist1">
\r
910 -D <strong>CONFIGURATION_DIRECTORY</strong>
\r
914 The specified directory is used as configuration directory for grml-live and its
\r
915 FAI. By default /etc/grml/fai is used as default configuration directory. If
\r
916 you want to have different configuration scripts, package definitions, etc. with
\r
917 without messing with the global configuration under /etc/grml/fai provided by
\r
918 grml-live this option provides you the option to use your own configuration
\r
919 throughout this documentation.
\r
922 <dt class="hdlist1">
\r
927 Force execution and do not prompt for acknowledgment of configuration.
\r
930 <dt class="hdlist1">
\r
931 -g <strong>GRML_NAME</strong>
\r
935 Set the grml flavour name. Common usage examples: grml, grml-small, grml64.
\r
936 Please do NOT use blanks and any special characters like <em>/</em>, <em>;</em> inside
\r
937 GRML_NAME, otherwise you might notice problems while booting.
\r
940 <dt class="hdlist1">
\r
945 Display short usage information and exit.
\r
948 <dt class="hdlist1">
\r
949 -i <strong>ISO_NAME</strong>
\r
953 Specify name of ISO which will be available inside $OUTPUT_DIRECTORY/grml_isos
\r
957 <dt class="hdlist1">
\r
958 -I <strong>CHROOT_INSTALL</strong>
\r
962 Specify name of source directory which provides files that should become part of
\r
963 the chroot/ISO. Not enabled by default. Note: the files are installed under <em>/</em>
\r
964 in the chroot so you have to create the rootfs structure on your own.
\r
967 <dt class="hdlist1">
\r
972 Skip creation of the ISO file. This option is useful if you want to build/update
\r
973 the chroot and/or recreate the squashfs file without building an ISO file.
\r
976 <dt class="hdlist1">
\r
981 Bootstrap the chroot without building bootloader, squashfs, or finalizing the
\r
982 ISO. Use this option if installation of some packages fails, you want to run
\r
983 custom commands or similar.
\r
984 The main use of this option is to save time by skipping stages which aren’t
\r
985 necessary for bootstrapping the chroot and which would get executed more than
\r
986 once when iterating through the initial bootstrapping.
\r
987 Alternatively, use this option as a test run of grml-live. Once you are
\r
988 satisfied with the state of your grml_chroot, use grml-live <strong>-u</strong> to build the
\r
989 remaining stages and finalize the ISO.
\r
992 <dt class="hdlist1">
\r
993 -o <strong>OUTPUT_DIRECTORY</strong>
\r
997 Main output directory of the build process of FAI. Some directories are created
\r
998 inside this target directory, being: grml_cd (where the files for creating the
\r
999 ISO are located, including the compressed squashfs file), grml_chroot (the
\r
1000 chroot system) and grml_isos (where the resulting ISO is stored).
\r
1003 <dt class="hdlist1">
\r
1008 Build the ISO without (re-)creating the squashfs compressed file using mksquashfs.
\r
1009 This option is useful if you just want to update parts outside the chroot in the ISO.
\r
1010 Consider combining this option with the build-only option <em>-b</em>.
\r
1013 <dt class="hdlist1">
\r
1018 Build the ISO without generating a netboot package.
\r
1021 <dt class="hdlist1">
\r
1022 -r <strong>RELEASENAME</strong>
\r
1026 Specify name of the release.
\r
1029 <dt class="hdlist1">
\r
1030 -s <strong>SUITE</strong>
\r
1034 Specify the Debian suite you want to use for your live-system. Defaults to
\r
1035 "squeeze" (being current Debian/stable). Supported values are: etch, lenny,
\r
1036 squeeze, sid. Debian "squeeze" requires a recent base.tgz
\r
1040 <dt class="hdlist1">
\r
1041 -t <strong>TEMPLATE_DIRECTORY</strong>
\r
1045 Specify place of the templates used for building the ISO. By default
\r
1046 (and if not manually specified) this is /usr/share/grml-live/templates/.
\r
1049 <dt class="hdlist1">
\r
1050 -T <strong>CHROOT_ARCHIVE</strong>
\r
1054 Unpack chroot tar archive before starting. Most useful in combination with
\r
1058 <dt class="hdlist1">
\r
1063 Update existing chroot instead of rebuilding it from scratch. This option is
\r
1064 based on the softupdate feature of FAI.
\r
1067 <dt class="hdlist1">
\r
1068 -U <strong>USERNAME</strong>
\r
1072 Sets ownership of all build output files to specified username before exiting.
\r
1075 <dt class="hdlist1">
\r
1076 -v <strong>VERSION_NUMBER</strong>
\r
1080 Specify version number of the release.
\r
1083 <dt class="hdlist1">
\r
1088 Increase verbosity in the build process.
\r
1091 <dt class="hdlist1">
\r
1096 Use ZLIB instead of LZMA/XZ compression in mksquashfs part of the build process.
\r
1102 <div class="sect1">
\r
1103 <h2 id="usage-examples">5. Usage examples</h2>
\r
1104 <div class="sectionbody">
\r
1105 <div class="paragraph"><p>To get a Debian-stable and Grml-based Live-CD using /grml/grml-live
\r
1106 as build and output directory just run:</p></div>
\r
1107 <div class="literalblock">
\r
1108 <div class="content">
\r
1109 <pre><tt># grml-live</tt></pre>
\r
1111 <div class="paragraph"><p>To get a 64bit Debian-testing and grml-small based Live-CD using /srv/grml-live
\r
1112 as build and output directory use the following command line on your amd64
\r
1114 <div class="literalblock">
\r
1115 <div class="content">
\r
1116 <pre><tt># grml-live -s testing -c GRMLBASE,GRML_SMALL,AMD64 -o /srv/grml-live</tt></pre>
\r
1118 <div class="admonitionblock">
\r
1121 <img src="./images/icons/note.png" alt="Note" />
\r
1123 <td class="content">If you have enough free space inside /dev/shm (being a tmpfs, usually you should
\r
1124 have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm" and use
\r
1125 /dev/shm as build and output directory - resulting in very fast build process.
\r
1126 But please be aware of the fact that rebooting your system will result in an
\r
1127 empty /dev/shm, so please use another directory for $CHROOT_OUTPUT,
\r
1128 $BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)</td>
\r
1133 <div class="sect1">
\r
1134 <h2 id="main-features">6. Main features of grml-live</h2>
\r
1135 <div class="sectionbody">
\r
1136 <div class="ulist"><ul>
\r
1139 create a Grml-/Debian-based Linux Live-CD with one single command
\r
1144 class based concept, providing a maximum of flexibility
\r
1149 supports integration of own hooks, scripts and configuration
\r
1154 supports use and integration of own Software and/or Kernels via simple use of
\r
1155 Debian repositories
\r
1160 native support of FAI features
\r
1166 <div class="sect1">
\r
1167 <h2 id="class-concept">7. The class concept</h2>
\r
1168 <div class="sectionbody">
\r
1169 <div class="paragraph"><p>grml-live uses FAI and its class based concept for adjusting configuration and
\r
1170 setup according to your needs. This gives you flexibility and strength without
\r
1171 losing the simplicity in the build process.</p></div>
\r
1172 <div class="paragraph"><p>The main and base class provided by grml-live is named GRMLBASE. It’s strongly
\r
1173 recommended to <strong>always</strong> use the class GRMLBASE when building an ISO using
\r
1174 grml-live, as well as the architecture dependent class which provides the kernel
\r
1175 (being <em>I386</em> for x86_32 and <em>AMD64</em> for x86_64) and a GRML_* class (like
\r
1176 GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are
\r
1177 relevant for class GRMLBASE by default:</p></div>
\r
1178 <div class="literalblock">
\r
1179 <div class="content">
\r
1180 <pre><tt>${GRML_FAI_CONFIG}/config/scripts/GRMLBASE/
\r
1181 ${GRML_FAI_CONFIG}/config/debconf/GRMLBASE
\r
1182 ${GRML_FAI_CONFIG}/config/class/GRMLBASE.var
\r
1183 ${GRML_FAI_CONFIG}/config/hooks/instsoft.GRMLBASE
\r
1184 ${GRML_FAI_CONFIG}/config/package_config/GRMLBASE</tt></pre>
\r
1186 <div class="paragraph"><p>Take a look at the next section for information about the concept of those
\r
1187 files/directories.</p></div>
\r
1188 <div class="paragraph"><p>If you want to use your own configuration, extend an existing configuration
\r
1189 and/or add additional packages to your ISO just invent a new class (or extend an
\r
1190 existing one). For example if you want to use your own class named "FOOBAR" just
\r
1191 set CLASSES="GRMLBASE,GRML_SMALL,AMD64,FOOBAR" inside /etc/grml/grml-live.local
\r
1192 or invoke grml-live using the classes option: "grml-live -c
\r
1193 GRMLBASE,GRML_SMALL,AMD64,FOOBAR …".</p></div>
\r
1194 <div class="paragraph"><p>More details regarding the class concept can be found in the documentation of
\r
1195 FAI itself (being available at /usr/share/doc/fai-doc/).</p></div>
\r
1198 <div class="sect1">
\r
1199 <h2 id="classes">8. Available classes</h2>
\r
1200 <div class="sectionbody">
\r
1201 <div class="paragraph"><p>The package selection part of the classes can be found in
\r
1202 selected. The following classes are predefined:</p></div>
\r
1203 <div class="ulist"><ul>
\r
1206 DEBORPHAN: get rid of all packages listed in output of deborphan
\r
1211 GRMLBASE: the main class responsible for getting a minimal subset of what’s
\r
1212 defining a Grml system. Important parts of the buildprocess are specified in
\r
1213 this class as well, so unless you have a really good reason you should always
\r
1219 GRML_FULL: full featured Grml, also known as the "normal", full grml as
\r
1220 introduced in December 2011 (~350MB ISO size).
\r
1225 GRML_MEDIUM: medium sized Grml version, used to be known as grml-medium
\r
1226 until December 2011 (~220MB ISO size).
\r
1231 GRML_SMALL: minimum sized Grml version, known as grml-small (~110MB ISO
\r
1237 GRML_XL: large size Grml version, used to be known as "full grml" until
\r
1238 December 2011 (~700MB ISO size).
\r
1243 LATEX: LaTeX(-related) packages like auctex, texlive,…
\r
1244 (which used to be shipped by grml before the LaTeX removal)
\r
1249 LATEX_CLEANUP: get rid of several very large LaTeX directories
\r
1250 (like some /usr/share/doc/texlive-*, /usr/share/doc/texmf,…)
\r
1255 LOCALES: use full featured locales setup (see /etc/locale.gen.grml). This
\r
1256 avoids to get rid of /usr/share/locale - which happens by default otherwise - as
\r
1262 NO_ONLINE: do not run scripts during the chroot build process which require a
\r
1263 network connection
\r
1268 RELEASE: run some specific scripts and commands to provide the workflow for an
\r
1269 official grml release
\r
1274 REMOVE_DOCS: get rid of documentation directories (like /usr/share/doc,
\r
1275 /usr/share/man/, /usr/share/info,…)
\r
1280 SOURCES: retrieve Debian source packages after installation. Files will be
\r
1281 placed in the output directory under grml_sources.
\r
1286 XORG: providing important packages for use with a base grml-featured X.org
\r
1293 <div class="sect1">
\r
1294 <h2 id="files">9. Files</h2>
\r
1295 <div class="sectionbody">
\r
1296 <div class="paragraph"><p>Notice that grml-live ships FAI configuration files that do not use the same
\r
1297 namespace as the FAI packages itself. This ensures that grml-live does not clash
\r
1298 with your usual FAI configuration, so instead of /etc/fai/fai.conf (package
\r
1299 below. To get an idea how another configuration or example files could look like
\r
1300 check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
\r
1301 fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html
\r
1302 provides documentation regarding configuration possibilities.</p></div>
\r
1303 <div class="literalblock">
\r
1304 <div class="content">
\r
1305 <pre><tt>/usr/sbin/grml-live</tt></pre>
\r
1307 <div class="paragraph"><p>Script for the main build process. Requires root permissions for execution.</p></div>
\r
1308 <div class="literalblock">
\r
1309 <div class="content">
\r
1310 <pre><tt>/etc/grml/grml-live.conf</tt></pre>
\r
1312 <div class="paragraph"><p>Main configuration file for grml-live which should be considered as a reference
\r
1313 configuration file only. Please use /etc/grml/grml-live.local for local
\r
1314 configuration instead.</p></div>
\r
1315 <div class="literalblock">
\r
1316 <div class="content">
\r
1317 <pre><tt>/etc/grml/grml-live.local</tt></pre>
\r
1319 <div class="paragraph"><p>All the local configuration should go to this file. This file overrides any
\r
1320 defaults of grml-live. Configurations via /etc/grml/grml-live.local are preferred
\r
1321 over the ones from /etc/grml/grml-live.conf. If you want to override settings
\r
1322 from /etc/grml/grml-live.local as well you have to specify them on the grml-live
\r
1323 commandline.</p></div>
\r
1324 <div class="literalblock">
\r
1325 <div class="content">
\r
1326 <pre><tt>${GRML_FAI_CONFIG}/fai.conf</tt></pre>
\r
1328 <div class="paragraph"><p>Main configuration file for FAI which specifies where all the configuration
\r
1329 files and scripts for FAI/grml-live can be found. By default the configuration
\r
1330 variables are FAI_CONFIG_SRC=file:///etc/grml/fai/config and
\r
1331 GRML_FAI_CONFIG=/etc/grml/fai/config - both pointing to a directory shipped by
\r
1332 grml-live out-of-the-box so you shouldn’t have to configure anything in this
\r
1334 <div class="literalblock">
\r
1335 <div class="content">
\r
1336 <pre><tt>${GRML_FAI_CONFIG}/make-fai-nfsroot.conf</tt></pre>
\r
1338 <div class="paragraph"><p>This file is used by make-fai-nfsroot(8) only. Usually you don’t have to change
\r
1339 anything inside this file. If you want to modify NFSROOT though you can adjust
\r
1340 it there.</p></div>
\r
1341 <div class="literalblock">
\r
1342 <div class="content">
\r
1343 <pre><tt>${GRML_FAI_CONFIG}/NFSROOT</tt></pre>
\r
1345 <div class="paragraph"><p>This file specifies the package list for creating the NFSROOT.</p></div>
\r
1346 <div class="literalblock">
\r
1347 <div class="content">
\r
1348 <pre><tt>${GRML_FAI_CONFIG}/config/</tt></pre>
\r
1350 <div class="paragraph"><p>The main directory for configuration of FAI/grml-live. More details below.</p></div>
\r
1351 <div class="literalblock">
\r
1352 <div class="content">
\r
1353 <pre><tt>${GRML_FAI_CONFIG}/config/class/</tt></pre>
\r
1355 <div class="paragraph"><p>This directory contains files which specify main configuration variables for the
\r
1356 FAI classes.</p></div>
\r
1357 <div class="literalblock">
\r
1358 <div class="content">
\r
1359 <pre><tt>${GRML_FAI_CONFIG}/config/debconf/</tt></pre>
\r
1361 <div class="paragraph"><p>This directory provides the files for preseeding/configuration of debconf
\r
1362 through files.</p></div>
\r
1363 <div class="literalblock">
\r
1364 <div class="content">
\r
1365 <pre><tt>${GRML_FAI_CONFIG}/config/hooks/</tt></pre>
\r
1367 <div class="paragraph"><p>This directory provides files for customising the build process through hooks.
\r
1368 Hooks are user defined programs or scripts, which are called during the
\r
1369 installation process.</p></div>
\r
1370 <div class="literalblock">
\r
1371 <div class="content">
\r
1372 <pre><tt>${GRML_FAI_CONFIG}/config/package_config/</tt></pre>
\r
1374 <div class="paragraph"><p>Directory with lists of software packages to be installed or removed. The
\r
1375 different classes describe what should find its way to your ISO. When running
\r
1376 "grml-live -c GRMLBASE,GRML_SMALL,AMD64 …" only the configuration of GRMLBASE,
\r
1377 GRML_SMALL and and AMD64 will be taken. If you use <em>grml-live -c
\r
1378 GRMLBASE,GRML_SMALL,AMD64,FOOBAR …</em> then the files of GRMLBASE, GRML_SMALL,
\r
1379 AMD64 <strong>plus</strong> the files from FOOBAR will be taken. So just create a new class to
\r
1380 adjust the package selection according to your needs. Please notice that the
\r
1381 directory GRMLBASE contains a package list defining a minimum but still
\r
1382 reasonable package configuration.</p></div>
\r
1383 <div class="literalblock">
\r
1384 <div class="content">
\r
1385 <pre><tt>${GRML_FAI_CONFIG}/config/scripts/</tt></pre>
\r
1387 <div class="paragraph"><p>Scripts for customising the ISO within the build process.</p></div>
\r
1388 <div class="literalblock">
\r
1389 <div class="content">
\r
1390 <pre><tt>${GRML_FAI_CONFIG}/live-initramfs/</tt></pre>
\r
1392 <div class="paragraph"><p>This directory provides the files used for building the initramfs/initrd via
\r
1393 live-initramfs(8).</p></div>
\r
1396 <div class="sect1">
\r
1397 <h2 id="log-files">10. Available log files</h2>
\r
1398 <div class="sectionbody">
\r
1399 <div class="paragraph"><p>Starting with grml-live version 0.17.0 you should find log files in a directory
\r
1400 named <em>grml_logs</em> in the output directory (next to grml_isos, grml_chroot,…).</p></div>
\r
1401 <div class="paragraph"><p>grml-live versions before 0.17.0 used to log into /var/log/grml-live.log
\r
1402 and /var/log/fai/grml.</p></div>
\r
1405 <div class="sect1">
\r
1406 <h2 id="requirements">11. Requirements for the build system</h2>
\r
1407 <div class="sectionbody">
\r
1408 <div class="ulist"><ul>
\r
1411 any Debian based system should be sufficient (if it doesn’t work it’s a bug,
\r
1412 please send us a bug report then). Check out <a href="#deploy-on-debian">How do I deploy grml-live on a plain Debian installation</a> for details how to set up grml-live
\r
1413 on a plain, original Debian system.
\r
1418 enough free disk space; at least 800MB are required for a minimal grml-live
\r
1419 run (~400MB for the chroot [$CHROOT_OUTPUT], ~150MB for the build target
\r
1420 [$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some
\r
1421 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
\r
1422 total free disk space
\r
1427 fast network access for retrieving the Debian packages used for creating the
\r
1428 chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
\r
1433 <div class="paragraph"><p>For further information see next section.</p></div>
\r
1436 <div class="sect1">
\r
1437 <h2 id="current_state">12. Current state of grml-live with squashfs-tools and kernel</h2>
\r
1438 <div class="sectionbody">
\r
1439 <div class="paragraph"><p>Use squashfs-tools >=4.2-1 (available from Grml repositories as well as from
\r
1440 Debian/testing and Debian/unstable) to build Grml (based) ISOs featuring kernel
\r
1441 version 2.6.38-grml[64] or newer.</p></div>
\r
1444 <div class="sect1">
\r
1445 <h2 id="faq">13. FAQ</h2>
\r
1446 <div class="sectionbody">
\r
1447 <div class="sect2">
\r
1448 <h3 id="deploy-on-debian">13.1. How do I deploy grml-live on a plain Debian installation?</h3>
\r
1449 <div class="paragraph"><p>The easiest way to get a running grml-live setup is to just use Grml.
\r
1450 Of course using grml-live on a plain, original Debian installation is supported
\r
1451 as well. So there we go.</p></div>
\r
1452 <div class="paragraph"><p>What we have: plain, original Debian squeeze (6.0).</p></div>
\r
1453 <div class="paragraph"><p>What we want: build a Grml ISO based on Debian/wheezy for the amd64 architecture
\r
1454 using grml-live.</p></div>
\r
1455 <div class="sect3">
\r
1456 <h4 id="_instructions">13.1.1. Instructions</h4>
\r
1457 <div class="literalblock">
\r
1458 <div class="content">
\r
1459 <pre><tt># adjust sources.list:
\r
1460 cat >> /etc/apt/sources.list << EOF</tt></pre>
\r
1462 <div class="literalblock">
\r
1463 <div class="content">
\r
1464 <pre><tt># grml stable repository:
\r
1465 deb http://deb.grml.org/ grml-stable main
\r
1466 # deb-src http://deb.grml.org/ grml-stable main</tt></pre>
\r
1468 <div class="literalblock">
\r
1469 <div class="content">
\r
1470 <pre><tt># grml testing/development repository:
\r
1471 deb http://deb.grml.org/ grml-testing main
\r
1472 # deb-src http://deb.grml.org/ grml-testing main
\r
1475 <div class="literalblock">
\r
1476 <div class="content">
\r
1477 <pre><tt># adjust apt-pinning (only prefer squashfs stuff from grml):
\r
1478 cat >> /etc/apt/preferences << EOF
\r
1480 Pin: origin deb.grml.org
\r
1481 Pin-Priority: 1</tt></pre>
\r
1483 <div class="literalblock">
\r
1484 <div class="content">
\r
1485 <pre><tt>Package: squashfs-tools
\r
1486 Pin: origin deb.grml.org
\r
1490 <div class="literalblock">
\r
1491 <div class="content">
\r
1492 <pre><tt># get keyring for apt:
\r
1494 apt-get --allow-unauthenticated install grml-debian-keyring</tt></pre>
\r
1496 <div class="literalblock">
\r
1497 <div class="content">
\r
1498 <pre><tt># optionally(!) install basefile so we don't have to build basic
\r
1499 # chroot from scratch, grab from http://daily.grml.org/
\r
1500 # mkdir -p /etc/grml/fai/config/basefiles/
\r
1501 # mv base.tgz /etc/grml/fai/config/basefiles/I386.tar.gz
\r
1502 # mv base64.tgz /etc/grml/fai/config/basefiles/AMD64.tar.gz</tt></pre>
\r
1504 <div class="literalblock">
\r
1505 <div class="content">
\r
1506 <pre><tt># install relevant tools
\r
1507 # please check out http://grml.org/grml-live/#current_state when encountering problems!
\r
1508 apt-get -o APT::Install-Recommends=false install grml-live squashfs-tools</tt></pre>
\r
1510 <div class="literalblock">
\r
1511 <div class="content">
\r
1512 <pre><tt># adjust grml-live configuration for our needs:
\r
1513 cat > /etc/grml/grml-live.local << EOF
\r
1514 ## want a faster build process and don't need smaller ISOs?
\r
1515 ## if so use zlib compression
\r
1516 # SQUASHFS_OPTIONS="-comp gzip -b 256k"
\r
1517 ## want to use a specific squashfs binary?
\r
1518 # SQUASHFS_BINARY='/usr/bin/mksquashfs'
\r
1519 ## install local files into the chroot
\r
1520 # CHROOT_INSTALL="/etc/grml/fai/chroot_install"
\r
1521 ## adjust if necessary (defaults to /grml/grml-live):
\r
1522 ## OUTPUT="/srv/grml-live"
\r
1523 FAI_DEBOOTSTRAP="wheezy http://cdn.debian.net/debian/"
\r
1525 CLASSES="GRMLBASE,GRML_FULL,AMD64"
\r
1528 <div class="literalblock">
\r
1529 <div class="content">
\r
1530 <pre><tt># just optional(!) - upgrade FAI to latest available version:
\r
1531 cat >> /etc/apt/sources.list << EOF
\r
1533 deb http://fai-project.org/download squeeze koeln
\r
1536 <div class="literalblock">
\r
1537 <div class="content">
\r
1538 <pre><tt># get gpg key of FAI repos and install current FAI version:
\r
1539 gpg -a --recv-keys AB9B66FD; gpg -a --export AB9B66FD | apt-key add -
\r
1541 apt-get install fai-client fai-server fai-doc</tt></pre>
\r
1543 <div class="paragraph"><p>That’s it. Now invoking <em>grml-live -V</em> should build the ISO. If everything
\r
1544 worked as expected the last line of the shell output should look like:</p></div>
\r
1545 <div class="literalblock">
\r
1546 <div class="content">
\r
1547 <pre><tt>[*] Successfully finished execution of grml-live [running 687 seconds]</tt></pre>
\r
1549 <div class="paragraph"><p>and the ISO can be found inside /grml-live/grml-live/grml_isos/ then.</p></div>
\r
1552 <div class="sect2">
\r
1553 <h3 id="grml_fai_config_variable">13.2. What is $GRML_FAI_CONFIG?</h3>
\r
1554 <div class="paragraph"><p>The variable <em>$GRML_FAI_CONFIG</em> is pointing to the directory /etc/grml/fai by
\r
1555 default. To provide you a maximum of flexibility you can set up your own
\r
1556 configuration directory (e.g. based on /etc/grml/fai) and use this directory
\r
1557 running grml-live with the <em>-D <config_dir></em> option. Now <em>$GRML_FAI_CONFIG</em>
\r
1558 points to the specified directory instead of using /etc/grml/fai and all the
\r
1559 configuration files, scripts and hooks will be taken from your
\r
1560 <em>$GRML_FAI_CONFIG</em> directory.</p></div>
\r
1562 <div class="sect2">
\r
1563 <h3 id="how-to-debug">13.3. I’ve problems with the build process. How to start debugging?</h3>
\r
1564 <div class="paragraph"><p>Check out the logs inside the directory <em>grml_logs</em> next to your grml_chroot,
\r
1565 grml_isos,… directories.</p></div>
\r
1566 <div class="paragraph"><p>If you need help with grml-live or would like to see new features as part of
\r
1567 grml-live you can get commercial support via
\r
1568 <a href="http://grml-solutions.com/">Grml Solutions</a>.</p></div>
\r
1570 <div class="sect2">
\r
1571 <h3 id="install-local-files">13.4. How do I install further files into the chroot/ISO?</h3>
\r
1572 <div class="paragraph"><p>Just point the configuration variable CHROOT_INSTALL to the directory which
\r
1573 provides the files you would like to install. Note that the files are installed
\r
1574 under <em>/</em> in the chroot - so you have to create the rootfs structure on your
\r
1575 own. Usage example:</p></div>
\r
1576 <div class="literalblock">
\r
1577 <div class="content">
\r
1578 <pre><tt>echo "CHROOT_INSTALL=\$GRML_FAI_CONFIG/chroot_install" >> /etc/grml/grml-live.local
\r
1579 mkdir -p /etc/grml/fai/chroot_install/usr/src/
\r
1580 wget example.org/foo.tar.gz
\r
1581 mv foo.tar.gz /etc/grml/fai/chroot_install/usr/src/
\r
1582 grml-live ...</tt></pre>
\r
1585 <div class="sect2">
\r
1586 <h3 id="local-debian-mirror">13.5. Can I use my own (local) Debian mirror?</h3>
\r
1587 <div class="paragraph"><p>Yes. Set up an according sources.list configuration as class file in
\r
1588 FAI_DEBOOTSTRAP (if not already using NFSROOT’s base.tgz) inside
\r
1589 /etc/grml/grml-live.conf[.local]. If you’re setting up your own class file don’t
\r
1590 forget to include the class name in the class list (grml-live -c …).</p></div>
\r
1591 <div class="paragraph"><p>If you want to use a local (for example NFS mount) mirror additionally then
\r
1592 adjust MIRROR_DIRECTORY in /etc/grml/grml-live.conf[.local] as well.</p></div>
\r
1593 <div class="paragraph"><p>If you want to use a HTTP Proxy (like apt-cacher-ng), set APT_PROXY. Example:</p></div>
\r
1594 <div class="literalblock">
\r
1595 <div class="content">
\r
1596 <pre><tt>APT_PROXY="http://localhost:3142/"</tt></pre>
\r
1599 <div class="sect2">
\r
1600 <h3 id="add-additional-debian-packages">13.6. How do I add additional Debian package(s) to my CD/ISO?</h3>
\r
1601 <div class="paragraph"><p>Just create a new class (using the package_config directory):</p></div>
\r
1602 <div class="literalblock">
\r
1603 <div class="content">
\r
1604 <pre><tt># cat > /etc/grml/fai/config/package_config/MIKA << EOF
\r
1605 PACKAGES aptitude</tt></pre>
\r
1607 <div class="literalblock">
\r
1608 <div class="content">
\r
1610 another_name_of_a_debian_package
\r
1614 <div class="paragraph"><p>and specify it when invoking grml-live then:</p></div>
\r
1615 <div class="literalblock">
\r
1616 <div class="content">
\r
1617 <pre><tt># grml-live -c GRMLBASE,GRML_SMALL,AMD64,MIKA</tt></pre>
\r
1620 <div class="sect2">
\r
1621 <h3 id="reset-grml-live-configuration">13.7. I fscked up my grml-live configuration. How do I reset it to the defaults?</h3>
\r
1622 <div class="paragraph"><p>Notice: this deletes all your grml-live configuration files. If that’s really
\r
1623 what you are searching for just run:</p></div>
\r
1624 <div class="literalblock">
\r
1625 <div class="content">
\r
1626 <pre><tt>rm -rf /etc/grml/fai /etc/grml/grml-live.conf
\r
1627 dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb</tt></pre>
\r
1630 <div class="sect2">
\r
1631 <h3 id="create-a-base-tgz">13.8. How do I create a base.tgz for use as NFSROOT?</h3>
\r
1632 <div class="paragraph"><p>First of all build the chroot system:</p></div>
\r
1633 <div class="literalblock">
\r
1634 <div class="content">
\r
1635 <pre><tt>mkdir /tmp/nfsroot && cd /tmp/nfsroot
\r
1636 debootstrap squeeze /tmp/nfsroot/ http://cdn.debian.net/debian
\r
1637 tar zcf base.tgz ./</tt></pre>
\r
1639 <div class="paragraph"><p>Then check out where your NFSROOT is located:</p></div>
\r
1640 <div class="literalblock">
\r
1641 <div class="content">
\r
1642 <pre><tt># grep '^NFSROOT' /etc/grml/fai/make-fai-nfsroot.conf
\r
1643 NFSROOT=/grml/fai/nfsroot</tt></pre>
\r
1645 <div class="paragraph"><p>So as /grml/fai/nfsroot is your NFSROOT place the file under
\r
1646 /grml/fai/nfsroot/live/filesystem.dir/var/tmp/:</p></div>
\r
1647 <div class="literalblock">
\r
1648 <div class="content">
\r
1649 <pre><tt>mv base.tgz /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz</tt></pre>
\r
1651 <div class="paragraph"><p>or even better use /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz instead.
\r
1652 Use I386 as $CLASSNAME for i386 builds and AMD64 for amd64 builds.</p></div>
\r
1653 <div class="paragraph"><p>Now running "grml-live …" will use this file as main system instead of
\r
1654 executing debootstrap. Check out the output for the following lines if using
\r
1655 NFSROOT:</p></div>
\r
1656 <div class="literalblock">
\r
1657 <div class="content">
\r
1659 Calling task_extrbase
\r
1660 Unpacking Debian base archive
\r
1661 Extracting /grml/fai/nfsroot/live/filesystem.dir/var/tmp/base.tgz
\r
1662 Calling task_mirror
\r
1665 <div class="paragraph"><p>or if using /etc/grml/fai/config/basefiles/$CLASSNAME.tar.gz for:</p></div>
\r
1666 <div class="literalblock">
\r
1667 <div class="content">
\r
1669 ftar: extracting /etc/grml/fai/config/basefiles///AMD64.tar.gz to
\r
1670 /grml-live/grml-live_20071029.22138/grml_chroot//
\r
1673 <div class="admonitionblock">
\r
1676 <img src="./images/icons/tip.png" alt="Tip" />
\r
1678 <td class="content">Existing base.tgz can be found at <a href="http://daily.grml.org/">http://daily.grml.org/</a></td>
\r
1682 <div class="sect2">
\r
1683 <h3 id="apt-cacher">13.9. Set up apt-cacher-ng for use with grml-live</h3>
\r
1684 <div class="paragraph"><p>Make sure /etc/grml/grml-live.local provides according APT_PROXY and
\r
1685 FAI_DEBOOTSTRAP:</p></div>
\r
1686 <div class="literalblock">
\r
1687 <div class="content">
\r
1688 <pre><tt># cat /etc/grml/grml-live.local
\r
1690 APT_PROXY="http://localhost:3142/"
\r
1692 FAI_DEBOOTSTRAP="squeeze http://localhost:3142/cdn.debian.net/debian squeeze main contrib non-free"</tt></pre>
\r
1694 <div class="paragraph"><p>Make sure apt-cacher-ng is running (<em>/etc/init.d/apt-cacher-ng restart</em>).
\r
1695 That’s it. All downloaded files will be cached in /var/cache/apt-cacher-ng then.</p></div>
\r
1697 <div class="sect2">
\r
1698 <h3 id="revert_manifold">13.10. How do I revert the manifold feature from an ISO?</h3>
\r
1699 <div class="paragraph"><p>The so called manifold feature Grml ISOs use by default allows one to use the same
\r
1700 ISO for CD boot and USB boot. If you notice any problems when booting just
\r
1701 revert the manifold feature running:</p></div>
\r
1702 <div class="literalblock">
\r
1703 <div class="content">
\r
1704 <pre><tt>% dd if=/dev/zero of=grml.iso bs=512 count=1 conv=notrunc</tt></pre>
\r
1706 <div class="paragraph"><p>To switch from manifold to isohybrid mode (an alternative approach provided by
\r
1707 syslinux) then just execute:</p></div>
\r
1708 <div class="literalblock">
\r
1709 <div class="content">
\r
1710 <pre><tt>% isohybrid grml.iso</tt></pre>
\r
1713 <div class="sect2">
\r
1714 <h3 id="basetgz">13.11. How do I create a base tar.gz (I386.tar.gz or AMD64.tar.gz)</h3>
\r
1715 <div class="paragraph"><p>Execute the following commands (requires root):</p></div>
\r
1716 <div class="literalblock">
\r
1717 <div class="content">
\r
1718 <pre><tt>ARCH='amd64' # replace with i386 if necessary
\r
1719 SUITE='squeeze' # using the current stable release should always work
\r
1720 debootstrap --arch "$ARCH" --exclude=info,tasksel,tasksel-data "$SUITE" "$ARCH" http://debian.netcologne.de/debian
\r
1722 rm var/cache/apt/archives/*.deb
\r
1723 tar zcf ../"${ARCH}".tar.gz *</tt></pre>
\r
1725 <div class="paragraph"><p>And finally place the generated tarball in /etc/grml/fai/config/basefiles/ (note
\r
1726 that it needs to be uppercase letters matching the class names, so: AMD64.tar.gz
\r
1727 for amd64 and I386.tar.gz for i386).</p></div>
\r
1729 <div class="sect2">
\r
1730 <h3 id="autobuild">13.12. How do I set up an autobuild environment?</h3>
\r
1731 <div class="paragraph"><p>If you want to set up a system like <a href="http://daily.grml.org/">daily.grml.org</a>
\r
1732 the Debian package grml-live-buildd provides all you need to start. Start with
\r
1733 figuring out the cron job script /usr/share/grml-live/buildd/cronjob.sh.</p></div>
\r
1734 <div class="paragraph"><p>If you want to automatically update the grml-live Debian package on your build
\r
1735 system based on the git tree of grml-live (so you get bleeding edge of
\r
1736 development which might is interesting for services like daily.grml.org) the
\r
1737 provided release_helper.sh script provides everything you need. Execute as root:</p></div>
\r
1738 <div class="literalblock">
\r
1739 <div class="content">
\r
1740 <pre><tt>echo "deb file:/home/grml-live-git/grml-live.build-area/ ./" >> /etc/apt/sources.list.d/grml-live.list
\r
1741 adduser --disabled-login --disabled-password grml-live-git</tt></pre>
\r
1743 <div class="paragraph"><p>Execute <em>visudo</em> to update sudo configuration and add the following line:</p></div>
\r
1744 <div class="literalblock">
\r
1745 <div class="content">
\r
1746 <pre><tt>grml-live-git ALL=NOPASSWD: /usr/bin/apt-get</tt></pre>
\r
1748 <div class="paragraph"><p>Switch to user grml-live-git and configure the rest:</p></div>
\r
1749 <div class="literalblock">
\r
1750 <div class="content">
\r
1751 <pre><tt>su - grml-live-git
\r
1752 mkdir grml-live.build-area
\r
1753 git clone git://git.grml.org/grml-live.git
\r
1754 git config --global user.name "Grml-Live Git Autobuild"
\r
1755 git config --global user.email "grml-live-git@$(hostname)"</tt></pre>
\r
1757 <div class="paragraph"><p>Finally install a cron job (as user grml-live-git) like:</p></div>
\r
1758 <div class="literalblock">
\r
1759 <div class="content">
\r
1760 <pre><tt>30 00 * * * cd /home/grml-live-git/grml-live.git/ && env AUTOBUILD=1 scripts/release_helper.sh >/home/grml-live-git/grml-live-build.log</tt></pre>
\r
1762 <div class="paragraph"><p>Tip: To find out the build date of the installed grml-live package just execute:</p></div>
\r
1763 <div class="literalblock">
\r
1764 <div class="content">
\r
1765 <pre><tt>% apt-cache policy grml-live | grep 'Installed.*autobuild'
\r
1766 Installed: 0.13.1~autobuild1300450381</tt></pre>
\r
1768 <div class="paragraph"><p>and run "date -ud @$STRING" where $STRING is the number behind the "autobuild",
\r
1770 <div class="literalblock">
\r
1771 <div class="content">
\r
1772 <pre><tt>% date -ud @1300450081
\r
1773 Fri Mar 18 12:08:01 UTC 2011</tt></pre>
\r
1778 <div class="sect1">
\r
1779 <h2 id="download">14. Download / install grml-live as a Debian package</h2>
\r
1780 <div class="sectionbody">
\r
1781 <div class="paragraph"><p>Debian packages are available through the grml-repository at
\r
1782 <a href="http://deb.grml.org/pool/main/g/grml-live/">deb.grml.org</a>. If you want to
\r
1783 build a Debian package on your own (using for example a specific version or the
\r
1784 current development tree), just execute:</p></div>
\r
1785 <div class="literalblock">
\r
1786 <div class="content">
\r
1787 <pre><tt>git clone git://git.grml.org/grml-live
\r
1789 debuild -us -uc</tt></pre>
\r
1793 <div class="sect1">
\r
1794 <h2 id="source">15. Source</h2>
\r
1795 <div class="sectionbody">
\r
1796 <div class="paragraph"><p>The source of grml-live is available at
\r
1797 <a href="https://github.com/grml/grml-live/">https://github.com/grml/grml-live/</a></p></div>
\r
1800 <div class="sect1">
\r
1801 <h2 id="bugs">16. Bugs</h2>
\r
1802 <div class="sectionbody">
\r
1803 <div class="paragraph"><p>Please report feedback, <a href="http://grml.org/bugs/">bugreports</a> and wishes
\r
1804 <a href="http://grml.org/contact/">to the Grml team</a>!</p></div>
\r
1807 <div class="sect1">
\r
1808 <h2 id="documentation">17. Documentation</h2>
\r
1809 <div class="sectionbody">
\r
1810 <div class="paragraph"><p>The most recent grml-live documentation is available online at
\r
1811 <a href="http://grml.org/grml-live/">http://grml.org/grml-live/</a> and for offline reading also available
\r
1812 in different formats:</p></div>
\r
1813 <div class="ulist"><ul>
\r
1816 <a href="http://grml.org/grml-live/grml-live.epub">http://grml.org/grml-live/grml-live.epub</a>
\r
1821 <a href="http://grml.org/grml-live/grml-live.pdf">http://grml.org/grml-live/grml-live.pdf</a>
\r
1827 <div class="sect1">
\r
1828 <h2 id="authors">18. Authors</h2>
\r
1829 <div class="sectionbody">
\r
1830 <div class="paragraph"><p>Michael Prokop <<a href="mailto:mika@grml.org">mika@grml.org</a>></p></div>
\r
1834 <div id="footnotes"><hr /></div>
\r
1836 <div id="footer-text">
\r
1837 Last updated 2011-12-12 16:10:01 CET
\r