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.9" />
\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
90 .monospaced, code, pre {
\r
91 font-family: "Courier New", Courier, monospace;
\r
98 white-space: pre-wrap;
\r
108 #revnumber, #revdate, #revremark {
\r
113 border-top: 2px solid silver;
\r
114 padding-top: 0.5em;
\r
119 padding-bottom: 0.5em;
\r
123 padding-bottom: 0.5em;
\r
128 margin-bottom: 1.5em;
\r
130 div.imageblock, div.exampleblock, div.verseblock,
\r
131 div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
\r
132 div.admonitionblock {
\r
134 margin-bottom: 1.5em;
\r
136 div.admonitionblock {
\r
138 margin-bottom: 2.0em;
\r
143 div.content { /* Block element content. */
\r
147 /* Block element titles. */
\r
148 div.title, caption.title {
\r
153 margin-bottom: 0.5em;
\r
159 td div.title:first-child {
\r
162 div.content div.title:first-child {
\r
165 div.content + div.title {
\r
169 div.sidebarblock > div.content {
\r
170 background: #ffffee;
\r
171 border: 1px solid #dddddd;
\r
172 border-left: 4px solid #f0f0f0;
\r
176 div.listingblock > div.content {
\r
177 border: 1px solid #dddddd;
\r
178 border-left: 5px solid #f0f0f0;
\r
179 background: #f8f8f8;
\r
183 div.quoteblock, div.verseblock {
\r
184 padding-left: 1.0em;
\r
185 margin-left: 1.0em;
\r
187 border-left: 5px solid #f0f0f0;
\r
191 div.quoteblock > div.attribution {
\r
192 padding-top: 0.5em;
\r
196 div.verseblock > pre.content {
\r
197 font-family: inherit;
\r
198 font-size: inherit;
\r
200 div.verseblock > div.attribution {
\r
201 padding-top: 0.75em;
\r
204 /* DEPRECATED: Pre version 8.2.7 verse style literal block. */
\r
205 div.verseblock + div.attribution {
\r
209 div.admonitionblock .icon {
\r
210 vertical-align: top;
\r
213 text-decoration: underline;
\r
215 padding-right: 0.5em;
\r
217 div.admonitionblock td.content {
\r
218 padding-left: 0.5em;
\r
219 border-left: 3px solid #dddddd;
\r
222 div.exampleblock > div.content {
\r
223 border-left: 3px solid #dddddd;
\r
224 padding-left: 0.5em;
\r
227 div.imageblock div.content { padding-left: 0; }
\r
228 span.image img { border-style: none; vertical-align: text-bottom; }
\r
229 a.image:visited { color: white; }
\r
233 margin-bottom: 0.8em;
\r
238 font-style: normal;
\r
241 dd > *:first-child {
\r
246 list-style-position: outside;
\r
249 list-style-type: decimal;
\r
252 list-style-type: lower-alpha;
\r
255 list-style-type: upper-alpha;
\r
258 list-style-type: lower-roman;
\r
261 list-style-type: upper-roman;
\r
264 div.compact ul, div.compact ol,
\r
265 div.compact p, div.compact p,
\r
266 div.compact div, div.compact div {
\r
268 margin-bottom: 0.1em;
\r
280 margin-bottom: 0.8em;
\r
283 padding-bottom: 15px;
\r
285 dt.hdlist1.strong, td.hdlist1.strong {
\r
289 vertical-align: top;
\r
290 font-style: normal;
\r
291 padding-right: 0.8em;
\r
295 vertical-align: top;
\r
297 div.hdlist.compact tr {
\r
303 background: yellow;
\r
306 .footnote, .footnoteref {
\r
310 span.footnote, span.footnoteref {
\r
311 vertical-align: super;
\r
315 margin: 20px 0 20px 0;
\r
316 padding: 7px 0 0 0;
\r
319 #footnotes div.footnote {
\r
325 border-top: 1px solid silver;
\r
334 padding-right: 0.5em;
\r
335 padding-bottom: 0.3em;
\r
336 vertical-align: top;
\r
338 div.colist td img {
\r
343 #footer-badges { display: none; }
\r
347 margin-bottom: 2.5em;
\r
355 margin-bottom: 0.1em;
\r
358 div.toclevel0, div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
\r
375 span.aqua { color: aqua; }
\r
376 span.black { color: black; }
\r
377 span.blue { color: blue; }
\r
378 span.fuchsia { color: fuchsia; }
\r
379 span.gray { color: gray; }
\r
380 span.green { color: green; }
\r
381 span.lime { color: lime; }
\r
382 span.maroon { color: maroon; }
\r
383 span.navy { color: navy; }
\r
384 span.olive { color: olive; }
\r
385 span.purple { color: purple; }
\r
386 span.red { color: red; }
\r
387 span.silver { color: silver; }
\r
388 span.teal { color: teal; }
\r
389 span.white { color: white; }
\r
390 span.yellow { color: yellow; }
\r
392 span.aqua-background { background: aqua; }
\r
393 span.black-background { background: black; }
\r
394 span.blue-background { background: blue; }
\r
395 span.fuchsia-background { background: fuchsia; }
\r
396 span.gray-background { background: gray; }
\r
397 span.green-background { background: green; }
\r
398 span.lime-background { background: lime; }
\r
399 span.maroon-background { background: maroon; }
\r
400 span.navy-background { background: navy; }
\r
401 span.olive-background { background: olive; }
\r
402 span.purple-background { background: purple; }
\r
403 span.red-background { background: red; }
\r
404 span.silver-background { background: silver; }
\r
405 span.teal-background { background: teal; }
\r
406 span.white-background { background: white; }
\r
407 span.yellow-background { background: yellow; }
\r
409 span.big { font-size: 2em; }
\r
410 span.small { font-size: 0.6em; }
\r
412 span.underline { text-decoration: underline; }
\r
413 span.overline { text-decoration: overline; }
\r
414 span.line-through { text-decoration: line-through; }
\r
416 div.unbreakable { page-break-inside: avoid; }
\r
426 margin-bottom: 1.5em;
\r
428 div.tableblock > table {
\r
429 border: 3px solid #527bbd;
\r
431 thead, p.table.header {
\r
438 /* Because the table frame attribute is overriden by CSS in most browsers. */
\r
439 div.tableblock > table[frame="void"] {
\r
440 border-style: none;
\r
442 div.tableblock > table[frame="hsides"] {
\r
443 border-left-style: none;
\r
444 border-right-style: none;
\r
446 div.tableblock > table[frame="vsides"] {
\r
447 border-top-style: none;
\r
448 border-bottom-style: none;
\r
459 margin-bottom: 1.5em;
\r
461 thead, p.tableblock.header {
\r
470 border-spacing: 0px;
\r
471 border-style: solid;
\r
472 border-color: #527bbd;
\r
473 border-collapse: collapse;
\r
475 th.tableblock, td.tableblock {
\r
478 border-style: solid;
\r
479 border-color: #527bbd;
\r
482 table.tableblock.frame-topbot {
\r
483 border-left-style: hidden;
\r
484 border-right-style: hidden;
\r
486 table.tableblock.frame-sides {
\r
487 border-top-style: hidden;
\r
488 border-bottom-style: hidden;
\r
490 table.tableblock.frame-none {
\r
491 border-style: hidden;
\r
494 th.tableblock.halign-left, td.tableblock.halign-left {
\r
497 th.tableblock.halign-center, td.tableblock.halign-center {
\r
498 text-align: center;
\r
500 th.tableblock.halign-right, td.tableblock.halign-right {
\r
504 th.tableblock.valign-top, td.tableblock.valign-top {
\r
505 vertical-align: top;
\r
507 th.tableblock.valign-middle, td.tableblock.valign-middle {
\r
508 vertical-align: middle;
\r
510 th.tableblock.valign-bottom, td.tableblock.valign-bottom {
\r
511 vertical-align: bottom;
\r
521 padding-top: 0.5em;
\r
522 padding-bottom: 0.5em;
\r
523 border-top: 2px solid silver;
\r
524 border-bottom: 2px solid silver;
\r
527 border-style: none;
\r
529 body.manpage div.sectionbody {
\r
534 body.manpage div#toc { display: none; }
\r
539 <script type="text/javascript">
\r
541 var asciidoc = { // Namespace.
\r
543 /////////////////////////////////////////////////////////////////////
\r
544 // Table Of Contents generator
\r
545 /////////////////////////////////////////////////////////////////////
\r
547 /* Author: Mihai Bazon, September 2002
\r
548 * http://students.infoiasi.ro/~mishoo
\r
550 * Table Of Content generator
\r
553 * Feel free to use this script under the terms of the GNU General Public
\r
554 * License, as long as you do not remove or alter this notice.
\r
557 /* modified by Troy D. Hanson, September 2006. License: GPL */
\r
558 /* modified by Stuart Rackham, 2006, 2009. License: GPL */
\r
560 // toclevels = 1..4.
\r
561 toc: function (toclevels) {
\r
563 function getText(el) {
\r
565 for (var i = el.firstChild; i != null; i = i.nextSibling) {
\r
566 if (i.nodeType == 3 /* Node.TEXT_NODE */) // IE doesn't speak constants.
\r
568 else if (i.firstChild != null)
\r
569 text += getText(i);
\r
574 function TocEntry(el, text, toclevel) {
\r
577 this.toclevel = toclevel;
\r
580 function tocEntries(el, toclevels) {
\r
581 var result = new Array;
\r
582 var re = new RegExp('[hH]([1-'+(toclevels+1)+'])');
\r
583 // Function that scans the DOM tree for header elements (the DOM2
\r
584 // nodeIterator API would be a better technique but not supported by all
\r
586 var iterate = function (el) {
\r
587 for (var i = el.firstChild; i != null; i = i.nextSibling) {
\r
588 if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
\r
589 var mo = re.exec(i.tagName);
\r
590 if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
\r
591 result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
\r
601 var toc = document.getElementById("toc");
\r
606 // Delete existing TOC entries in case we're reloading the TOC.
\r
607 var tocEntriesToRemove = [];
\r
609 for (i = 0; i < toc.childNodes.length; i++) {
\r
610 var entry = toc.childNodes[i];
\r
611 if (entry.nodeName.toLowerCase() == 'div'
\r
612 && entry.getAttribute("class")
\r
613 && entry.getAttribute("class").match(/^toclevel/))
\r
614 tocEntriesToRemove.push(entry);
\r
616 for (i = 0; i < tocEntriesToRemove.length; i++) {
\r
617 toc.removeChild(tocEntriesToRemove[i]);
\r
620 // Rebuild TOC entries.
\r
621 var entries = tocEntries(document.getElementById("content"), toclevels);
\r
622 for (var i = 0; i < entries.length; ++i) {
\r
623 var entry = entries[i];
\r
624 if (entry.element.id == "")
\r
625 entry.element.id = "_toc_" + i;
\r
626 var a = document.createElement("a");
\r
627 a.href = "#" + entry.element.id;
\r
628 a.appendChild(document.createTextNode(entry.text));
\r
629 var div = document.createElement("div");
\r
630 div.appendChild(a);
\r
631 div.className = "toclevel" + entry.toclevel;
\r
632 toc.appendChild(div);
\r
634 if (entries.length == 0)
\r
635 toc.parentNode.removeChild(toc);
\r
639 /////////////////////////////////////////////////////////////////////
\r
640 // Footnotes generator
\r
641 /////////////////////////////////////////////////////////////////////
\r
643 /* Based on footnote generation code from:
\r
644 * http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
\r
647 footnotes: function () {
\r
648 // Delete existing footnote entries in case we're reloading the footnodes.
\r
650 var noteholder = document.getElementById("footnotes");
\r
654 var entriesToRemove = [];
\r
655 for (i = 0; i < noteholder.childNodes.length; i++) {
\r
656 var entry = noteholder.childNodes[i];
\r
657 if (entry.nodeName.toLowerCase() == 'div' && entry.getAttribute("class") == "footnote")
\r
658 entriesToRemove.push(entry);
\r
660 for (i = 0; i < entriesToRemove.length; i++) {
\r
661 noteholder.removeChild(entriesToRemove[i]);
\r
664 // Rebuild footnote entries.
\r
665 var cont = document.getElementById("content");
\r
666 var spans = cont.getElementsByTagName("span");
\r
669 for (i=0; i<spans.length; i++) {
\r
670 if (spans[i].className == "footnote") {
\r
672 var note = spans[i].getAttribute("data-note");
\r
674 // Use [\s\S] in place of . so multi-line matches work.
\r
675 // Because JavaScript has no s (dotall) regex flag.
\r
676 note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
\r
677 spans[i].innerHTML =
\r
678 "[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
\r
679 "' title='View footnote' class='footnote'>" + n + "</a>]";
\r
680 spans[i].setAttribute("data-note", note);
\r
682 noteholder.innerHTML +=
\r
683 "<div class='footnote' id='_footnote_" + n + "'>" +
\r
684 "<a href='#_footnoteref_" + n + "' title='Return to text'>" +
\r
685 n + "</a>. " + note + "</div>";
\r
686 var id =spans[i].getAttribute("id");
\r
687 if (id != null) refs["#"+id] = n;
\r
691 noteholder.parentNode.removeChild(noteholder);
\r
693 // Process footnoterefs.
\r
694 for (i=0; i<spans.length; i++) {
\r
695 if (spans[i].className == "footnoteref") {
\r
696 var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
\r
697 href = href.match(/#.*/)[0]; // Because IE return full URL.
\r
699 spans[i].innerHTML =
\r
700 "[<a href='#_footnote_" + n +
\r
701 "' title='View footnote' class='footnote'>" + n + "</a>]";
\r
707 install: function(toclevels) {
\r
710 function reinstall() {
\r
711 asciidoc.footnotes();
\r
713 asciidoc.toc(toclevels);
\r
717 function reinstallAndRemoveTimer() {
\r
718 clearInterval(timerId);
\r
722 timerId = setInterval(reinstall, 500);
\r
723 if (document.addEventListener)
\r
724 document.addEventListener("DOMContentLoaded", reinstallAndRemoveTimer, false);
\r
726 window.onload = reinstallAndRemoveTimer;
\r
730 asciidoc.install(2);
\r
734 <body class="article">
\r
736 <h1>grml-live(8)</h1>
\r
738 <div id="toctitle">Table of Contents</div>
739 <noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
743 <div class="sect1">
\r
744 <h2 id="_name">1. Name</h2>
\r
745 <div class="sectionbody">
\r
746 <div class="paragraph"><p>grml-live - build framework based on FAI for generating a Grml and Debian based
\r
747 Linux Live system (CD/ISO)</p></div>
\r
750 <div class="sect1">
\r
751 <h2 id="_synopsis">2. Synopsis</h2>
\r
752 <div class="sectionbody">
\r
753 <div class="paragraph"><p>grml-live [-a <architecture>] [-c <classe[s]>] [-C <configfile>] [
\r
754 -e <extract_iso_name>] [-g <grml_name>] [-i <iso_name>] [
\r
755 -o <output_directory>] [-r <release_name>] [-s <suite>] [
\r
756 -t <template_directory>] [-v <version_number>] [-U <username>] [
\r
757 -w <date>] [-AbBFnNqQuVz]</p></div>
\r
760 <div class="sect1">
\r
761 <h2 id="_description">3. Description</h2>
\r
762 <div class="sectionbody">
\r
763 <div class="paragraph"><p>grml-live provides the build system for creating a Grml and Debian based Linux
\r
764 Live-CD. The build system is based on
\r
765 <a href="http://fai-project.org/">FAI</a> (Fully Automatic
\r
766 Installation). grml-live uses the "fai dirinstall" feature to generate a chroot
\r
767 system based on the class concept of FAI (see later sections for further
\r
768 details) and provides the framework to be able to generate a full-featured ISO.
\r
769 It does not use all the FAI features by default though and you don’t have to
\r
770 know FAI to be able to use it.</p></div>
\r
771 <div class="paragraph"><p>The use of FAI gives you the flexibility to choose the packages you would like
\r
772 to include on your very own Linux Live-CD without having to deal with all the
\r
773 details of a build process.</p></div>
\r
774 <div class="admonitionblock">
\r
777 <img src="./images/icons/caution.png" alt="Caution" />
\r
779 <td class="content">grml-live does <strong>not</strong> use /etc/fai for configuration but instead
\r
780 (unless overridden using the <em>'-D</em>' option). This ensures that it does not clash
\r
781 with default FAI configuration and packages, so you can use grml-live and FAI
\r
782 completely independent at the same time!</td>
\r
785 <div class="admonitionblock">
\r
788 <img src="./images/icons/note.png" alt="Note" />
\r
790 <td class="content">Please notice that you should have a fast network connection as all the Debian
\r
791 packages will be downloaded and installed via network. If you want to use a
\r
792 local mirror (strongly recommended if you plan to use grml-live more than once)
\r
793 checkout mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror),
\r
794 debmirror(1), reprepro(1) (see /usr/share/doc/grml-live/examples/reprepro/ for a
\r
795 sample configuration), apt-cacher(1) and approx(8). To avoid downloading the
\r
796 base system again and again check out <a href="#create-a-base-tgz">the base tar.gz feature</a>.</td>
\r
801 <div class="sect1">
\r
802 <h2 id="_options">4. Options</h2>
\r
803 <div class="sectionbody">
\r
804 <div class="dlist"><dl>
\r
805 <dt class="hdlist1">
\r
810 Clean up all output directories before running the build process. After finishing,
\r
811 clean up the Chroot target and Build target directories.
\r
814 <dt class="hdlist1">
\r
815 -a <strong>ARCHITECTURE</strong>
\r
819 Use the specified architecture instead of the currently running one. This
\r
820 allows building a 32bit system on a 64bit host (though you can’t build a 64bit
\r
821 system on a 32bit system/kernel of course). Please notice that real
\r
822 crosscompiling (like building a ppc system on x86) isn’t possible due to the
\r
823 nature and the need of working in a chroot. Currently supported values: i386
\r
827 <dt class="hdlist1">
\r
832 Build the ISO without updating the chroot via FAI. This option is useful for
\r
833 example when working on stable releases: if you have a working base
\r
834 system/chroot and do not want to execute any further updates (via "-u" option)
\r
835 but intend to only build the ISO.
\r
838 <dt class="hdlist1">
\r
843 Build the ISO without touching the chroot at all. This option is useful if
\r
844 you modified anything that FAI or grml-live might adjust via Grml’s FAI
\r
845 scripts. It’s like the <em>-b</em> option but even more advanced. Use only if you
\r
846 really know that you do not want to update the chroot.
\r
849 <dt class="hdlist1">
\r
850 -c <strong>CLASSES</strong>
\r
854 Specify the CLASSES to be used for building the ISO via FAI. By default only
\r
855 the classes GRMLBASE, GRML_FULL and I386/AMD64 (depending on system
\r
856 architecture) are assumed, resulting in a base system of about 350MB
\r
857 total ISO size. If using a non-I386 system (like AMD64) you should specify the
\r
858 appropriate architecture as well. Additionally you can specify a class providing
\r
859 a grml-kernel (see <a href="#classes">the <em>CLASSES</em> section in this document</a> for
\r
860 details about available classes). So instead of GRML_FULL you can also use
\r
861 GRML_SMALL and GRML_FULL.
\r
865 <div class="admonitionblock">
\r
868 <img src="./images/icons/important.png" alt="Important" />
\r
870 <td class="content">All class names should be written in uppercase letters. Do not use a dash, use
\r
871 an underscore. So do not use "amd64" but "AMD64", do not use "FOO BAR" but
\r
875 <div class="dlist"><dl>
\r
876 <dt class="hdlist1">
\r
877 -C <strong>CONFIGURATION_FILE</strong>
\r
881 The specified file is used as configuration file for grml-live. By default
\r
882 /etc/grml/grml-live.conf is used as default configuration. If a file named
\r
883 /etc/grml/grml-live.local exists it is used as well (sourced after reading
\r
884 /etc/grml/grml-live.conf meant as main file for local configuration). As a last
\r
885 option the specified configuration file is sourced so it is possible to override
\r
886 settings of /etc/grml/grml-live.conf as well as of /etc/grml/grml-live.local.
\r
887 Please notice that all configuration files have to be adjusted during execution
\r
888 of grml-live, so please make sure you use /etc/grml/grml-live.conf as a base for
\r
889 your own configuration file (usually /etc/grml/grml-live.local). Please also
\r
890 notice that the configuration file specified via this option is <strong>not</strong> (yet)
\r
891 /etc/grml/grml-live.local for configuration stuff used inside
\r
894 <dt class="hdlist1">
\r
895 -d <strong>DATE</strong>
\r
899 Use specified date as build date information on the ISO instead of the default.
\r
900 The default is the date when grml-live is being executed (retrieved via
\r
901 executing <em>date +%Y-%m-%d</em>). The information is stored inside the file
\r
902 /GRML/grml-version on the ISO, /etc/grml_version in the squashfs file and in all
\r
903 the bootsplash related files. This option is useful if you want to provide an
\r
904 ISO with release information for a specific date but have to build it in
\r
905 advance. Usage example: <em>-d 2009-10-30</em>
\r
908 <dt class="hdlist1">
\r
909 -D <strong>CONFIGURATION_DIRECTORY</strong>
\r
913 The specified directory is used as configuration directory for grml-live and its
\r
914 FAI. By default /etc/grml/fai is used as default configuration directory. If
\r
915 you want to have different configuration scripts, package definitions, etc. with
\r
916 without messing with the global configuration under /etc/grml/fai provided by
\r
917 grml-live this option provides you the option to use your own configuration
\r
918 throughout this documentation.
\r
921 <dt class="hdlist1">
\r
922 -e <strong>EXTRACT_ISO_NAME</strong>
\r
926 The squashfs inside the specified ISO will be extracted and used as the chroot.
\r
927 This option is useful for remastering, in combination with -A and -b or -u.
\r
930 <dt class="hdlist1">
\r
935 Force execution and do not prompt for acknowledgment of configuration.
\r
938 <dt class="hdlist1">
\r
939 -g <strong>GRML_NAME</strong>
\r
943 Set the grml flavour name. Common usage examples: grml, grml-small, grml64.
\r
944 Please do NOT use blanks and any special characters like <em>/</em>, <em>;</em> inside
\r
945 GRML_NAME, otherwise you might notice problems while booting.
\r
948 <dt class="hdlist1">
\r
953 Display short usage information and exit.
\r
956 <dt class="hdlist1">
\r
957 -i <strong>ISO_NAME</strong>
\r
961 Specify name of ISO which will be available inside $OUTPUT_DIRECTORY/grml_isos
\r
965 <dt class="hdlist1">
\r
966 -I <strong>CHROOT_INSTALL</strong>
\r
970 Specify name of source directory which provides files that should become part of
\r
971 the chroot/ISO. Not enabled by default. Note: the files are installed under <em>/</em>
\r
972 in the chroot so you have to create the rootfs structure on your own.
\r
975 <dt class="hdlist1">
\r
980 Skip creation of the ISO file. This option is useful if you want to build/update
\r
981 the chroot and/or recreate the squashfs file without building an ISO file.
\r
984 <dt class="hdlist1">
\r
989 Bootstrap the chroot without building bootloader, squashfs, or finalizing the
\r
990 ISO. Use this option if installation of some packages fails, you want to run
\r
991 custom commands or similar.
\r
992 The main use of this option is to save time by skipping stages which aren’t
\r
993 necessary for bootstrapping the chroot and which would get executed more than
\r
994 once when iterating through the initial bootstrapping.
\r
995 Alternatively, use this option as a test run of grml-live. Once you are
\r
996 satisfied with the state of your grml_chroot, use grml-live <strong>-u</strong> to build the
\r
997 remaining stages and finalize the ISO.
\r
1000 <dt class="hdlist1">
\r
1001 -o <strong>OUTPUT_DIRECTORY</strong>
\r
1005 Main output directory of the build process of FAI. Some directories are created
\r
1006 inside this target directory, being: grml_cd (where the files for creating the
\r
1007 ISO are located, including the compressed squashfs file), grml_chroot (the
\r
1008 chroot system) and grml_isos (where the resulting ISO is stored).
\r
1011 <dt class="hdlist1">
\r
1016 Build the ISO without (re-)creating the squashfs compressed file using mksquashfs.
\r
1017 This option is useful if you just want to update parts outside the chroot in the ISO.
\r
1018 Consider combining this option with the build-only option <em>-b</em>.
\r
1021 <dt class="hdlist1">
\r
1026 Build the ISO without generating a netboot package.
\r
1029 <dt class="hdlist1">
\r
1030 -r <strong>RELEASENAME</strong>
\r
1034 Specify name of the release.
\r
1037 <dt class="hdlist1">
\r
1038 -s <strong>SUITE</strong>
\r
1042 Specify the Debian suite you want to use for your live-system. If unset defaults
\r
1043 to "testing". Supported values are: stable, testing, unstable (or their
\r
1044 corresponding release names like "jessie"). Please be aware that recent Debian
\r
1045 suites might require a recent base.tgz
\r
1049 <dt class="hdlist1">
\r
1050 -t <strong>TEMPLATE_DIRECTORY</strong>
\r
1054 Specify place of the templates used for building the ISO. By default
\r
1055 (and if not manually specified) this is /usr/share/grml-live/templates/.
\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
1092 -w <strong>DATE</strong>
\r
1096 The wayback machine. Build the system using Debian archives from the specified
\r
1097 date. Valid date formats are yyyymmddThhmmssZ or simply yyyymmdd. To learn
\r
1098 which snapshots exist, i.e. which date strings are valid, simply browse the
\r
1099 lists on <a href="http://snapshot.debian.org/">http://snapshot.debian.org/</a>. If there is no import at the exact time
\r
1100 you specified you will get the latest available timestamp which is before the
\r
1101 time you specified.
\r
1102 This option is useful especially for release and debugging builds - for example
\r
1103 if you know that the Debian archive was in a good state on a specific date but
\r
1104 you want to build it on another day in the future, where the archive might not
\r
1105 be as needed anymore. Please be aware that this is restricted to the plain
\r
1106 Debian repositories only, as referred to in /etc/apt/sources.list.d/debian.list
\r
1107 (so neither the Grml repositories nor any further custom ones are affected by
\r
1108 the wayback machine).
\r
1111 <dt class="hdlist1">
\r
1116 Use ZLIB instead of LZMA/XZ compression in mksquashfs part of the build process.
\r
1122 <div class="sect1">
\r
1123 <h2 id="usage-examples">5. Usage examples</h2>
\r
1124 <div class="sectionbody">
\r
1125 <div class="paragraph"><p>To get a Debian-stable and Grml-based Live-CD using /grml/grml-live
\r
1126 as build and output directory just run:</p></div>
\r
1127 <div class="literalblock">
\r
1128 <div class="content">
\r
1129 <pre><code># grml-live</code></pre>
\r
1131 <div class="paragraph"><p>To get a 64bit Debian-testing and grml-small based Live-CD using /srv/grml-live
\r
1132 as build and output directory use the following command line on your amd64
\r
1134 <div class="literalblock">
\r
1135 <div class="content">
\r
1136 <pre><code># grml-live -s testing -c GRMLBASE,GRML_SMALL,AMD64 -o /srv/grml-live</code></pre>
\r
1138 <div class="admonitionblock">
\r
1141 <img src="./images/icons/note.png" alt="Note" />
\r
1143 <td class="content">If you have enough RAM, just run "mount -t tmpfs none /media/ramdisk" to get a
\r
1144 tmpfs ("RAMDISK"), and use /media/ramdisk as build and output directory - this
\r
1145 results in a very fast build process. Note that these files will be gone when
\r
1151 <div class="sect1">
\r
1152 <h2 id="main-features">6. Main features of grml-live</h2>
\r
1153 <div class="sectionbody">
\r
1154 <div class="ulist"><ul>
\r
1157 create a Grml-/Debian-based Linux Live-CD with one single command
\r
1162 class based concept, providing a maximum of flexibility
\r
1167 supports integration of own hooks, scripts and configuration
\r
1172 supports use and integration of own Software and/or Kernels via simple use of
\r
1173 Debian repositories
\r
1178 native support of FAI features
\r
1184 <div class="sect1">
\r
1185 <h2 id="class-concept">7. The class concept</h2>
\r
1186 <div class="sectionbody">
\r
1187 <div class="paragraph"><p>grml-live uses FAI and its class based concept for adjusting configuration and
\r
1188 setup according to your needs. This gives you flexibility and strength without
\r
1189 losing the simplicity in the build process.</p></div>
\r
1190 <div class="paragraph"><p>The main and base class provided by grml-live is named GRMLBASE. It’s strongly
\r
1191 recommended to <strong>always</strong> use the class GRMLBASE when building an ISO using
\r
1192 grml-live, as well as the architecture dependent class which provides the kernel
\r
1193 (being <em>I386</em> for x86_32 and <em>AMD64</em> for x86_64) and a GRML_* class (like
\r
1194 GRML_SMALL or GRML_FULL). The following files and directories are
\r
1195 relevant for class GRMLBASE by default:</p></div>
\r
1196 <div class="literalblock">
\r
1197 <div class="content">
\r
1198 <pre><code>${GRML_FAI_CONFIG}/config/scripts/GRMLBASE/
\r
1199 ${GRML_FAI_CONFIG}/config/debconf/GRMLBASE
\r
1200 ${GRML_FAI_CONFIG}/config/class/GRMLBASE.var
\r
1201 ${GRML_FAI_CONFIG}/config/hooks/instsoft.GRMLBASE
\r
1202 ${GRML_FAI_CONFIG}/config/package_config/GRMLBASE</code></pre>
\r
1204 <div class="paragraph"><p>Take a look at the next section for information about the concept of those
\r
1205 files/directories.</p></div>
\r
1206 <div class="paragraph"><p>If you want to use your own configuration, extend an existing configuration
\r
1207 and/or add additional packages to your ISO just invent a new class (or extend an
\r
1208 existing one). For example if you want to use your own class named "FOOBAR" just
\r
1209 set CLASSES="GRMLBASE,GRML_SMALL,AMD64,FOOBAR" inside /etc/grml/grml-live.local
\r
1210 or invoke grml-live using the classes option: "grml-live -c
\r
1211 GRMLBASE,GRML_SMALL,AMD64,FOOBAR …".</p></div>
\r
1212 <div class="paragraph"><p>More details regarding the class concept can be found in the documentation of
\r
1213 FAI itself (being available at /usr/share/doc/fai-doc/).</p></div>
\r
1216 <div class="sect1">
\r
1217 <h2 id="classes">8. Available classes</h2>
\r
1218 <div class="sectionbody">
\r
1219 <div class="paragraph"><p>The package selection part of the classes can be found in
\r
1220 selected. The following classes are predefined:</p></div>
\r
1221 <div class="ulist"><ul>
\r
1224 DEBORPHAN: get rid of all packages listed in output of deborphan
\r
1229 FRESHCLAM: execute freshclam (if it’s present) to update clamav definitions
\r
1230 (increases resulting ISO size ~70MB). By default it’s skipped to avoid bigger
\r
1236 GRMLBASE: the main class responsible for getting a minimal subset of what’s
\r
1237 defining a Grml system. Important parts of the buildprocess are specified in
\r
1238 this class as well, so unless you have a really good reason you should always
\r
1244 GRML_FULL: full featured Grml, also known as the "normal", full grml as
\r
1245 introduced in December 2011 (~460MB ISO size).
\r
1250 GRML_SMALL: minimum sized Grml version, known as grml-small (~230MB ISO
\r
1256 LATEX: LaTeX(-related) packages like auctex, texlive,…
\r
1257 (which used to be shipped by grml before the LaTeX removal)
\r
1262 LATEX_CLEANUP: get rid of several very large LaTeX directories
\r
1263 (like some /usr/share/doc/texlive-*, /usr/share/doc/texmf,…)
\r
1268 LOCALES: use full featured locales setup (see /etc/locale.gen.grml). This
\r
1269 avoids to get rid of /usr/share/locale - which happens by default otherwise - as
\r
1275 NO_ONLINE: do not run scripts during the chroot build process which require a
\r
1276 network connection
\r
1281 RELEASE: run some specific scripts and commands to provide the workflow for an
\r
1282 official grml release
\r
1287 REMOVE_DOCS: get rid of documentation directories (like /usr/share/doc,
\r
1288 /usr/share/man/, /usr/share/info,…)
\r
1293 SOURCES: retrieve Debian source packages after installation. Files will be
\r
1294 placed in the output directory under grml_sources.
\r
1299 XORG: providing important packages for use with a base grml-featured X.org
\r
1306 <div class="sect1">
\r
1307 <h2 id="files">9. Files</h2>
\r
1308 <div class="sectionbody">
\r
1309 <div class="paragraph"><p>Notice that grml-live ships FAI configuration files that do not use the same
\r
1310 namespace as the FAI packages itself. This ensures that grml-live does not clash
\r
1311 with your usual FAI configuration, so instead of /etc/fai/fai.conf (package
\r
1312 below. To get an idea how another configuration or example files could look like
\r
1313 check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
\r
1314 fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html
\r
1315 provides documentation regarding configuration possibilities.</p></div>
\r
1316 <div class="literalblock">
\r
1317 <div class="content">
\r
1318 <pre><code>/usr/sbin/grml-live</code></pre>
\r
1320 <div class="paragraph"><p>Script for the main build process. Requires root permissions for execution.</p></div>
\r
1321 <div class="literalblock">
\r
1322 <div class="content">
\r
1323 <pre><code>/etc/grml/grml-live.conf</code></pre>
\r
1325 <div class="paragraph"><p>Main configuration file for grml-live which should be considered as a reference
\r
1326 configuration file only. Please use /etc/grml/grml-live.local for local
\r
1327 configuration instead.</p></div>
\r
1328 <div class="literalblock">
\r
1329 <div class="content">
\r
1330 <pre><code>/etc/grml/grml-live.local</code></pre>
\r
1332 <div class="paragraph"><p>All the local configuration should go to this file. This file overrides any
\r
1333 defaults of grml-live. Configurations via /etc/grml/grml-live.local are preferred
\r
1334 over the ones from /etc/grml/grml-live.conf. If you want to override settings
\r
1335 from /etc/grml/grml-live.local as well you have to specify them on the grml-live
\r
1336 commandline.</p></div>
\r
1337 <div class="literalblock">
\r
1338 <div class="content">
\r
1339 <pre><code>${GRML_FAI_CONFIG}/fai.conf</code></pre>
\r
1341 <div class="paragraph"><p>Main configuration file for FAI which specifies where all the configuration
\r
1342 files and scripts for FAI/grml-live can be found. By default the configuration
\r
1343 variables are FAI_CONFIG_SRC=file:///etc/grml/fai/config and
\r
1344 GRML_FAI_CONFIG=/etc/grml/fai/config - both pointing to a directory shipped by
\r
1345 grml-live out-of-the-box so you shouldn’t have to configure anything in this
\r
1347 <div class="literalblock">
\r
1348 <div class="content">
\r
1349 <pre><code>${GRML_FAI_CONFIG}/config/</code></pre>
\r
1351 <div class="paragraph"><p>The main directory for configuration of FAI/grml-live. More details below.</p></div>
\r
1352 <div class="literalblock">
\r
1353 <div class="content">
\r
1354 <pre><code>${GRML_FAI_CONFIG}/config/class/</code></pre>
\r
1356 <div class="paragraph"><p>This directory contains files which specify main configuration variables for the
\r
1357 FAI classes.</p></div>
\r
1358 <div class="literalblock">
\r
1359 <div class="content">
\r
1360 <pre><code>${GRML_FAI_CONFIG}/config/debconf/</code></pre>
\r
1362 <div class="paragraph"><p>This directory provides the files for preseeding/configuration of debconf
\r
1363 through files.</p></div>
\r
1364 <div class="literalblock">
\r
1365 <div class="content">
\r
1366 <pre><code>${GRML_FAI_CONFIG}/config/hooks/</code></pre>
\r
1368 <div class="paragraph"><p>This directory provides files for customising the build process through hooks.
\r
1369 Hooks are user defined programs or scripts, which are called during the
\r
1370 installation process.</p></div>
\r
1371 <div class="literalblock">
\r
1372 <div class="content">
\r
1373 <pre><code>${GRML_FAI_CONFIG}/config/package_config/</code></pre>
\r
1375 <div class="paragraph"><p>Directory with lists of software packages to be installed or removed. The
\r
1376 different classes describe what should find its way to your ISO. When running
\r
1377 "grml-live -c GRMLBASE,GRML_SMALL,AMD64 …" only the configuration of GRMLBASE,
\r
1378 GRML_SMALL and and AMD64 will be taken. If you use <em>grml-live -c
\r
1379 GRMLBASE,GRML_SMALL,AMD64,FOOBAR …</em> then the files of GRMLBASE, GRML_SMALL,
\r
1380 AMD64 <strong>plus</strong> the files from FOOBAR will be taken. So just create a new class to
\r
1381 adjust the package selection according to your needs. Please notice that the
\r
1382 directory GRMLBASE contains a package list defining a minimum but still
\r
1383 reasonable package configuration.</p></div>
\r
1384 <div class="literalblock">
\r
1385 <div class="content">
\r
1386 <pre><code>${GRML_FAI_CONFIG}/config/scripts/</code></pre>
\r
1388 <div class="paragraph"><p>Scripts for customising the ISO within the build process.</p></div>
\r
1389 <div class="literalblock">
\r
1390 <div class="content">
\r
1391 <pre><code>${GRML_FAI_CONFIG}/live-initramfs/</code></pre>
\r
1393 <div class="paragraph"><p>This directory provides the files used for building the initramfs/initrd via
\r
1394 live-initramfs(8).</p></div>
\r
1397 <div class="sect1">
\r
1398 <h2 id="log-files">10. Available log files</h2>
\r
1399 <div class="sectionbody">
\r
1400 <div class="paragraph"><p>Starting with grml-live version 0.17.0 you should find log files in a directory
\r
1401 named <em>grml_logs</em> in the output directory (next to grml_isos, grml_chroot,…).</p></div>
\r
1402 <div class="paragraph"><p>grml-live versions before 0.17.0 used to log into /var/log/grml-live.log
\r
1403 and /var/log/fai/grml.</p></div>
\r
1406 <div class="sect1">
\r
1407 <h2 id="requirements">11. Requirements for the build system</h2>
\r
1408 <div class="sectionbody">
\r
1409 <div class="ulist"><ul>
\r
1412 any Debian based system should be sufficient (if it doesn’t work it’s a bug,
\r
1413 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
1414 on a plain, original Debian system.
\r
1419 enough free disk space; at least 800MB are required for a minimal grml-live
\r
1420 run (~400MB for the chroot [$CHROOT_OUTPUT], ~150MB for the build target
\r
1421 [$BUILD_OUTPUT] and \~150MB for the resulting ISO [$ISO_OUTPUT] plus some
\r
1422 temporary files), if you plan to use GRML_FULL you should have at least 4GB of
\r
1423 total free disk space
\r
1428 fast network access for retrieving the Debian packages used for creating the
\r
1429 chroot (check out "local mirror" to workaround this problem as far as possible)
\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 to build Grml (based) ISOs featuring kernel version
\r
1440 2.6.38-grml[64] or newer.</p></div>
\r
1443 <div class="sect1">
\r
1444 <h2 id="faq">13. FAQ</h2>
\r
1445 <div class="sectionbody">
\r
1446 <div class="sect2">
\r
1447 <h3 id="deploy-on-debian">13.1. How do I deploy grml-live on a plain Debian installation?</h3>
\r
1448 <div class="paragraph"><p>The easiest way to get a running grml-live setup is to just use Grml.
\r
1449 Of course using grml-live on a plain, original Debian installation is supported
\r
1450 as well. So there we go.</p></div>
\r
1451 <div class="paragraph"><p>What we have: plain, original Debian jessie (8.x).</p></div>
\r
1452 <div class="paragraph"><p>What we want: build a Grml ISO based on Debian/jessie for the amd64 architecture
\r
1453 using grml-live.</p></div>
\r
1454 <div class="sect3">
\r
1455 <h4 id="_instructions">13.1.1. Instructions</h4>
\r
1456 <div class="literalblock">
\r
1457 <div class="content">
\r
1458 <pre><code># adjust sources.list:
\r
1459 cat >> /etc/apt/sources.list << EOF</code></pre>
\r
1461 <div class="literalblock">
\r
1462 <div class="content">
\r
1463 <pre><code># grml stable repository:
\r
1464 deb http://deb.grml.org/ grml-stable main
\r
1465 # deb-src http://deb.grml.org/ grml-stable main</code></pre>
\r
1467 <div class="literalblock">
\r
1468 <div class="content">
\r
1469 <pre><code># grml testing/development repository:
\r
1470 deb http://deb.grml.org/ grml-testing main
\r
1471 # deb-src http://deb.grml.org/ grml-testing main
\r
1474 <div class="literalblock">
\r
1475 <div class="content">
\r
1476 <pre><code># get keyring for apt:
\r
1478 apt-get --allow-unauthenticated install grml-debian-keyring</code></pre>
\r
1480 <div class="literalblock">
\r
1481 <div class="content">
\r
1482 <pre><code># optionally(!) install basefile so we don't have to build basic
\r
1483 # chroot from scratch, grab from http://daily.grml.org/
\r
1484 # mkdir -p /etc/grml/fai/config/basefiles/
\r
1485 # mv I386.tar.gz /etc/grml/fai/config/basefiles/
\r
1486 # mv AMD64.tar.gz /etc/grml/fai/config/basefiles/</code></pre>
\r
1488 <div class="literalblock">
\r
1489 <div class="content">
\r
1490 <pre><code># install relevant tools
\r
1491 apt-get --no-install-recommends install grml-live</code></pre>
\r
1493 <div class="literalblock">
\r
1494 <div class="content">
\r
1495 <pre><code># adjust grml-live configuration for our needs:
\r
1496 cat > /etc/grml/grml-live.local << EOF
\r
1497 ## want a faster build process and don't need smaller ISOs?
\r
1498 ## if so use zlib compression
\r
1499 # SQUASHFS_OPTIONS="-comp gzip -b 256k"
\r
1500 ## want to use a specific squashfs binary?
\r
1501 # SQUASHFS_BINARY='/usr/bin/mksquashfs'
\r
1502 ## install local files into the chroot
\r
1503 # CHROOT_INSTALL="/etc/grml/fai/chroot_install"
\r
1504 ## adjust if necessary (defaults to /grml/grml-live):
\r
1505 ## OUTPUT="/srv/grml-live"
\r
1506 FAI_DEBOOTSTRAP="jessie http://ftp.debian.org/debian/"
\r
1508 CLASSES="GRMLBASE,GRML_FULL,AMD64"
\r
1511 <div class="literalblock">
\r
1512 <div class="content">
\r
1513 <pre><code># just optional(!) - upgrade FAI to latest available version:
\r
1514 cat >> /etc/apt/sources.list.d/fai.list << EOF
\r
1515 deb http://jenkins.grml.org/debian fai main
\r
1516 deb-src http://jenkins.grml.org/debian fai main
\r
1519 <div class="literalblock">
\r
1520 <div class="content">
\r
1521 <pre><code># get gpg key of FAI repos and install current FAI version:
\r
1522 wget -O - http://jenkins.grml.org/debian/C525F56752D4A654.asc | sudo apt-key add -
\r
1524 apt-get install fai-client fai-server fai-doc</code></pre>
\r
1526 <div class="paragraph"><p>That’s it. Now invoking <em>grml-live -V</em> should build the ISO. If everything
\r
1527 worked as expected the last line of the shell output should look like:</p></div>
\r
1528 <div class="literalblock">
\r
1529 <div class="content">
\r
1530 <pre><code>[*] Successfully finished execution of grml-live [running 687 seconds]</code></pre>
\r
1532 <div class="paragraph"><p>and the ISO can be found inside /grml-live/grml-live/grml_isos/ then.</p></div>
\r
1535 <div class="sect2">
\r
1536 <h3 id="grml_fai_config_variable">13.2. What is $GRML_FAI_CONFIG?</h3>
\r
1537 <div class="paragraph"><p>The variable <em>$GRML_FAI_CONFIG</em> is pointing to the directory /etc/grml/fai by
\r
1538 default. To provide you a maximum of flexibility you can set up your own
\r
1539 configuration directory (e.g. based on /etc/grml/fai) and use this directory
\r
1540 running grml-live with the <em>-D <config_dir></em> option. Now <em>$GRML_FAI_CONFIG</em>
\r
1541 points to the specified directory instead of using /etc/grml/fai and all the
\r
1542 configuration files, scripts and hooks will be taken from your
\r
1543 <em>$GRML_FAI_CONFIG</em> directory.</p></div>
\r
1545 <div class="sect2">
\r
1546 <h3 id="how-to-debug">13.3. I’ve problems with the build process. How to start debugging?</h3>
\r
1547 <div class="paragraph"><p>Check out the logs inside the directory <em>grml_logs</em> next to your grml_chroot,
\r
1548 grml_isos,… directories.</p></div>
\r
1549 <div class="paragraph"><p>If you need help with grml-live or would like to see new features as part of
\r
1550 grml-live you can get commercial support via
\r
1551 <a href="http://grml-solutions.com/">Grml Solutions</a>.</p></div>
\r
1553 <div class="sect2">
\r
1554 <h3 id="install-local-files">13.4. How do I install further files into the chroot/ISO?</h3>
\r
1555 <div class="paragraph"><p>Just point the configuration variable CHROOT_INSTALL to the directory which
\r
1556 provides the files you would like to install. Note that the files are installed
\r
1557 under <em>/</em> in the chroot - so you have to create the rootfs structure on your
\r
1558 own. Usage example:</p></div>
\r
1559 <div class="literalblock">
\r
1560 <div class="content">
\r
1561 <pre><code>echo "CHROOT_INSTALL=\$GRML_FAI_CONFIG/chroot_install" >> /etc/grml/grml-live.local
\r
1562 mkdir -p /etc/grml/fai/chroot_install/usr/src/
\r
1563 wget example.org/foo.tar.gz
\r
1564 mv foo.tar.gz /etc/grml/fai/chroot_install/usr/src/
\r
1565 grml-live ...</code></pre>
\r
1568 <div class="sect2">
\r
1569 <h3 id="local-debian-mirror">13.5. Can I use my own (local) Debian mirror?</h3>
\r
1570 <div class="paragraph"><p>Yes. Set up an according sources.list configuration as class file in
\r
1571 FAI_DEBOOTSTRAP (if not already using a base.tgz) inside
\r
1572 /etc/grml/grml-live.conf[.local]. If you’re setting up your own class file don’t
\r
1573 forget to include the class name in the class list (grml-live -c …).</p></div>
\r
1574 <div class="paragraph"><p>If you want to use a local (for example NFS mount) mirror additionally then
\r
1575 adjust MIRROR_DIRECTORY in /etc/grml/grml-live.conf[.local] as well.</p></div>
\r
1576 <div class="paragraph"><p>If you want to use a HTTP Proxy (like apt-cacher-ng), set APT_PROXY. Example:</p></div>
\r
1577 <div class="literalblock">
\r
1578 <div class="content">
\r
1579 <pre><code>APT_PROXY="http://localhost:3142/"</code></pre>
\r
1582 <div class="sect2">
\r
1583 <h3 id="add-additional-debian-packages">13.6. How do I add additional Debian package(s) to my CD/ISO?</h3>
\r
1584 <div class="paragraph"><p>Just create a new class (using the package_config directory):</p></div>
\r
1585 <div class="literalblock">
\r
1586 <div class="content">
\r
1587 <pre><code># cat > /etc/grml/fai/config/package_config/MIKA << EOF
\r
1588 PACKAGES aptitude</code></pre>
\r
1590 <div class="literalblock">
\r
1591 <div class="content">
\r
1593 another_name_of_a_debian_package
\r
1597 <div class="paragraph"><p>and specify it when invoking grml-live then:</p></div>
\r
1598 <div class="literalblock">
\r
1599 <div class="content">
\r
1600 <pre><code># grml-live -c GRMLBASE,GRML_SMALL,AMD64,MIKA</code></pre>
\r
1603 <div class="sect2">
\r
1604 <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
1605 <div class="paragraph"><p>Notice: this deletes all your grml-live configuration files. If that’s really
\r
1606 what you are searching for just run:</p></div>
\r
1607 <div class="literalblock">
\r
1608 <div class="content">
\r
1609 <pre><code>rm -rf /etc/grml/fai /etc/grml/grml-live.conf
\r
1610 dpkg -i --force-confnew --force-confmiss /path/to/grml-live_..._all.deb</code></pre>
\r
1613 <div class="sect2">
\r
1614 <h3 id="apt-cacher">13.8. Set up apt-cacher-ng for use with grml-live</h3>
\r
1615 <div class="paragraph"><p>Make sure /etc/grml/grml-live.local provides according APT_PROXY and
\r
1616 FAI_DEBOOTSTRAP:</p></div>
\r
1617 <div class="literalblock">
\r
1618 <div class="content">
\r
1619 <pre><code># cat /etc/grml/grml-live.local
\r
1621 APT_PROXY="http://localhost:3142/"
\r
1623 FAI_DEBOOTSTRAP="jessie http://localhost:3142/ftp.debian.org/debian jessie main contrib non-free"</code></pre>
\r
1625 <div class="paragraph"><p>Make sure apt-cacher-ng is running (<em>/etc/init.d/apt-cacher-ng restart</em>).
\r
1626 That’s it. All downloaded files will be cached in /var/cache/apt-cacher-ng then.</p></div>
\r
1628 <div class="sect2">
\r
1629 <h3 id="revert_manifold">13.9. How do I revert the manifold feature from an ISO?</h3>
\r
1630 <div class="paragraph"><p>The so called manifold feature Grml ISOs use by default allows one to use the same
\r
1631 ISO for CD boot and USB boot. If you notice any problems when booting just
\r
1632 revert the manifold feature running:</p></div>
\r
1633 <div class="literalblock">
\r
1634 <div class="content">
\r
1635 <pre><code>% dd if=/dev/zero of=grml.iso bs=512 count=1 conv=notrunc</code></pre>
\r
1637 <div class="paragraph"><p>To switch from manifold to isohybrid mode (an alternative approach provided by
\r
1638 syslinux) then just execute:</p></div>
\r
1639 <div class="literalblock">
\r
1640 <div class="content">
\r
1641 <pre><code>% isohybrid grml.iso</code></pre>
\r
1644 <div class="sect2">
\r
1645 <h3 id="create-a-base-tgz">13.10. How do I create a base tar.gz (I386.tar.gz or AMD64.tar.gz)</h3>
\r
1646 <div class="paragraph" id="basetgz"><p>First of all create the chroot using debootstrap (requires root):</p></div>
\r
1647 <div class="literalblock">
\r
1648 <div class="content">
\r
1649 <pre><code>BASECHROOT='/tmp/basefile' # path where the chroot gets generated
\r
1650 SUITE='jessie' # using the current stable release should always work
\r
1651 debootstrap --exclude=info,tasksel,tasksel-data "$SUITE" "$BASECHROOT" http://ftp.debian.org/debian
\r
1652 tar -C "$BASECHROOT" --exclude='var/cache/apt/archives/*.deb' -zcf "${SUITE}".tar.gz ./</code></pre>
\r
1654 <div class="admonitionblock">
\r
1657 <img src="./images/icons/tip.png" alt="Tip" />
\r
1659 <td class="content">By default debootstrap builds a chroot matching the architecture of the running
\r
1660 host system. If you’re using an amd64 system and want to build an i386 base.tgz
\r
1661 then invoke debootstrap using the <em>--arch i386</em> option. Disclaimer: building an
\r
1662 AMD64 base.tgz won’t work if you are using a 32bit kernel system of course.</td>
\r
1665 <div class="paragraph"><p>Finally place the generated tarball in /etc/grml/fai/config/basefiles/ (note
\r
1666 that it needs to be uppercase letters matching the class names, so: e.g.
\r
1667 AMD64.tar.gz for amd64 and I386.tar.gz for i386).</p></div>
\r
1668 <div class="paragraph"><p>Then executing grml-live should use this file as base system instead of executing
\r
1669 debootstrap. Check out the output for something like:</p></div>
\r
1670 <div class="literalblock">
\r
1671 <div class="content">
\r
1673 ftar: extracting //etc/grml/fai/config/basefiles///AMD64.tar.gz to /srv/grml64_testing/grml_chroot//
\r
1674 [...]</code></pre>
\r
1677 <div class="sect2">
\r
1678 <h3 id="localrepos">13.11. How to use your own local repository</h3>
\r
1679 <div class="paragraph"><p>Let’s assume you have Debian package(s) in your filesystem inside
\r
1680 <code>/home/foobar/local-packages</code> and want to provide them to your grml-live build.
\r
1681 This can be achieved either 1) through a bind mount (using the MIRROR_DIRECTORY
\r
1682 configuration) or 2) by serving a repository via HTTP.</p></div>
\r
1683 <div class="sect3">
\r
1684 <h4 id="_serving_via_bind_mount_mirror_directory">13.11.1. Serving via bind mount / MIRROR_DIRECTORY</h4>
\r
1685 <div class="paragraph"><p>Make sure to create an according sources.list configuration file, e.g. using
\r
1686 your own class name <code>CUSTOM</code>:</p></div>
\r
1687 <div class="literalblock">
\r
1688 <div class="content">
\r
1689 <pre><code># cat > /etc/grml/fai/config/files/etc/apt/sources.list.d/local-packages.list/CUSTOM << EOF
\r
1690 deb file:///home/foobar/local-packages ./
\r
1693 <div class="paragraph"><p>Add the according MIRROR_DIRECTORY configuration to your grml-live configuration:</p></div>
\r
1694 <div class="literalblock">
\r
1695 <div class="content">
\r
1696 <pre><code># echo "MIRROR_DIRECTORY='/home/foobar/packages'" >> /etc/grml/grml-live.local</code></pre>
\r
1698 <div class="paragraph"><p>Make sure the local directory looks like a mirror:</p></div>
\r
1699 <div class="literalblock">
\r
1700 <div class="content">
\r
1701 <pre><code>% cd /home/foobar/packages
\r
1702 % dpkg-scanpackages . /dev/null | gzip > Packages.gz</code></pre>
\r
1704 <div class="paragraph"><p>Finally invoke grml-live with your class name (<code>CUSTOM</code> in this example) added
\r
1705 to the list of classes on the command line (see grml-live option <code>-c</code>).</p></div>
\r
1707 <div class="sect3">
\r
1708 <h4 id="_serving_a_repository_via_http">13.11.2. Serving a repository via HTTP</h4>
\r
1709 <div class="paragraph"><p>Make sure to create an according sources.list configuration file, e.g. using
\r
1710 your own class name <code>CUSTOM</code>:</p></div>
\r
1711 <div class="literalblock">
\r
1712 <div class="content">
\r
1713 <pre><code># cat > /etc/grml/fai/config/files/etc/apt/sources.list.d/local-packages.list/CUSTOM << EOF
\r
1714 deb http://127.0.0.1:8000/ ./
\r
1717 <div class="paragraph"><p>Make sure the local directory is served via HTTP on the according IP address and
\r
1718 port. For the <code>http://127.0.0.1:8000/</code> example from above it should be enough to
\r
1719 just invoke:</p></div>
\r
1720 <div class="literalblock">
\r
1721 <div class="content">
\r
1722 <pre><code>% cd /home/foobar/packages
\r
1723 % dpkg-scanpackages . /dev/null | gzip > Packages.gz
\r
1724 % python -m SimpleHTTPServer 8000</code></pre>
\r
1726 <div class="admonitionblock">
\r
1729 <img src="./images/icons/tip.png" alt="Tip" />
\r
1731 <td class="content">Of course you can also use a real Debian repository setup using tools like
\r
1732 reprepro(1) and/or using a real web server, though for quick debugging sessions
\r
1733 python’s SimpleHTTPServer in combination with dpkg-scanpackages from package
\r
1734 dpkg-dev is a simple and easy approach.</td>
\r
1737 <div class="paragraph"><p>Finally invoke grml-live with your class name (<code>CUSTOM</code> in this example) added
\r
1738 to the list of classes on the command line (see grml-live option <code>-c</code>).</p></div>
\r
1743 <div class="sect1">
\r
1744 <h2 id="download">14. Download / install grml-live as a Debian package</h2>
\r
1745 <div class="sectionbody">
\r
1746 <div class="paragraph"><p>Stable Debian packages are available through the grml-repository at
\r
1747 <a href="http://deb.grml.org/pool/main/g/grml-live/">deb.grml.org</a> and the latest
\r
1748 Git commits are available as Debian packages from
\r
1749 <a href="http://jenkins.grml.org/job/grml-live-binaries/">jenkins.grml.org</a>.
\r
1750 If you want to build a Debian package on your own (using for example a specific
\r
1751 version or the current development tree), just execute:</p></div>
\r
1752 <div class="literalblock">
\r
1753 <div class="content">
\r
1754 <pre><code>git clone git://git.grml.org/grml-live
\r
1756 debuild -us -uc</code></pre>
\r
1760 <div class="sect1">
\r
1761 <h2 id="run-from-git">15. Run grml-live directly from git</h2>
\r
1762 <div class="sectionbody">
\r
1763 <div class="paragraph"><p>In case you want to run grml-live directly from the git repository checkout
\r
1764 (after making sure all dependencies are installed), you should set
\r
1765 <code>GRML_FAI_CONFIG</code> so that a) it finds the according FAI configuration files and
\r
1766 b) does not use the config files of an possibly installed <code>grml-live</code> package.
\r
1767 Usage example:</p></div>
\r
1768 <div class="literalblock">
\r
1769 <div class="content">
\r
1770 <pre><code># export GRML_FAI_CONFIG=$(pwd)/etc/grml/fai
\r
1771 # export SCRIPTS_DIRECTORY=$(pwd)/scripts
\r
1772 # ./grml-live -s sid -a amd64 -c GRMLBASE,GRML_FULL,AMD64</code></pre>
\r
1776 <div class="sect1">
\r
1777 <h2 id="source">16. Source</h2>
\r
1778 <div class="sectionbody">
\r
1779 <div class="paragraph"><p>The source of grml-live is available at
\r
1780 <a href="https://github.com/grml/grml-live/">https://github.com/grml/grml-live/</a></p></div>
\r
1783 <div class="sect1">
\r
1784 <h2 id="bugs">17. Bugs</h2>
\r
1785 <div class="sectionbody">
\r
1786 <div class="paragraph"><p>Please report feedback, <a href="http://grml.org/bugs/">bugreports</a> and wishes
\r
1787 <a href="http://grml.org/contact/">to the Grml team</a>!</p></div>
\r
1790 <div class="sect1">
\r
1791 <h2 id="documentation">18. Documentation</h2>
\r
1792 <div class="sectionbody">
\r
1793 <div class="paragraph"><p>The most recent grml-live documentation is available online at
\r
1794 <a href="http://grml.org/grml-live/">http://grml.org/grml-live/</a> and for offline reading also available
\r
1795 in different formats:</p></div>
\r
1796 <div class="ulist"><ul>
\r
1799 <a href="http://grml.org/grml-live/grml-live.epub">http://grml.org/grml-live/grml-live.epub</a>
\r
1804 <a href="http://grml.org/grml-live/grml-live.pdf">http://grml.org/grml-live/grml-live.pdf</a>
\r
1810 <div class="sect1">
\r
1811 <h2 id="authors">19. Authors</h2>
\r
1812 <div class="sectionbody">
\r
1813 <div class="paragraph"><p>Michael Prokop <<a href="mailto:mika@grml.org">mika@grml.org</a>></p></div>
\r
1817 <div id="footnotes"><hr /></div>
\r
1819 <div id="footer-text">
\r
1821 2016-02-15 22:15:22 CET
\r