/
grml-live.html
1180 lines (1143 loc) · 36.9 KB
/
grml-live.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.2.2" />
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
}
strong {
font-weight: bold;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1 {
border-bottom: 2px solid silver;
}
h2 {
border-bottom: 2px solid silver;
padding-top: 0.5em;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revision {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble,
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-right: 10%;
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.5em;
margin-bottom: 2.5em;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock {
margin-right: 0%;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock > div.content {
padding-left: 2.0em;
}
div.attribution {
text-align: right;
}
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 2px solid silver;
}
div.exampleblock > div.content {
border-left: 2px solid silver;
padding: 0.5em;
}
div.verseblock div.content {
white-space: pre;
}
div.imageblock div.content { padding-left: 0; }
div.imageblock img { border: 1px solid silver; }
span.image img { border-style: none; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: italic;
}
dd > *:first-child {
margin-top: 0;
}
ul, ol {
list-style-position: outside;
}
ol.olist2 {
list-style-type: lower-alpha;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
div.hlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hlist td {
padding-bottom: 5px;
}
td.hlist1 {
vertical-align: top;
font-style: italic;
padding-right: 0.8em;
}
td.hlist2 {
vertical-align: top;
}
@media print {
div#footer-badges { display: none; }
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-content {
padding-left: 2.0em;
}
div.exampleblock-content {
border-left: 2px solid silver;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<title>grml-live(8)</title>
</head>
<body>
<div id="header">
<h1>grml-live(8)</h1>
</div>
<h2>Name</h2>
<div class="sectionbody">
<p>grml-live - build framework based on FAI for generating a grml and Debian based
Linux Live system (CD/ISO)</p>
</div>
<h2>Synopsis</h2>
<div class="sectionbody">
<p>grml-live [-a <architecture>] [-c <classe[s]>] [-C <configfile>] [-g
<grml_name>] [-i <iso_name> ] [-o <output_directory>] [-r <release_name>] [-s
<suite>] [-t <template_directory>] [-v <version_number>] [-bFhuVz]</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/caution.png" alt="Caution" />
</td>
<td class="content">Please check out <a href="#current_state">the <em>Current state of grml-live with squashfs-tools and kernel</em> section</a> for details about current state of involved
tools before starting with grml-live or if you encounter any problems.</td>
</tr></table>
</div>
</div>
<h2>Description</h2>
<div class="sectionbody">
<p>grml-live provides the build system for creating a grml and Debian based Linux
Live-CD. The build system is based on
<a href="http://www.informatik.uni-koeln.de/fai/">FAI</a> (Fully Automatic
Installation). grml-live uses the "fai dirinstall" feature to generate a chroot
system based on the class concept of FAI (see later sections for further
details) and provides the framework to be able to generate a full-featured ISO.
It does not use all the FAI features by default though and you don't have to
know FAI to be able to use it.</p>
<p>The use of FAI gives you the flexibility to choose the packages you would like
to include on your very own Linux Live-CD without having to deal with all the
details of a build process.</p>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/caution.png" alt="Caution" />
</td>
<td class="content">grml-live does <strong>not</strong> use /etc/fai for configuration but instead
provides and uses /etc/grml/fai. This ensures that it does not clash with
default FAI configuration and packages, so you can use grml-live and FAI
completely independent at the same time!</td>
</tr></table>
</div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">Please notice that you should have a fast network connection as all the Debian
packages will be downloaded and installed via network. If you want to use a
local mirror (strongly recommended if you plan to use grml-live more than once)
checkout mkdebmirror (see /usr/share/doc/grml-live/examples/mkdebmirror),
debmirror(1), reprepro(1) (see /usr/share/doc/grml-live/examples/reprepro/ for a
sample configuration), apt-cacher(1) and approx(8). To avoid downloading the
base system again and again check out FAI's NFSROOT (see FAQ of this document
for details).</td>
</tr></table>
</div>
</div>
<h2>Options</h2>
<div class="sectionbody">
<dl>
<dt>
-a <strong>ARCHITECTURE</strong>
</dt>
<dd>
<p>
Use the specified architecture instead of the currently running one. This
allows building a 32bit system on a 64bit host (though you can't build a 64bit
system on a 32bit system/kernel of course). Please notice that real
crosscompiling (like building a ppc system on x86) isn't possible due to the
nature and the need of working in a chroot. Currently supported values: i386
and amd64.
</p>
</dd>
<dt>
-b
</dt>
<dd>
<p>
Build the ISO without updating the chroot via FAI. This option is useful for
example when working on stable releases: if you have a working base
system/chroot and do not want to execute any further updates (via "-u" option)
but intend to only build the ISO.
</p>
</dd>
<dt>
-c <strong>CLASSES</strong>
</dt>
<dd>
<p>
Specify the CLASSES to be used for building the ISO via FAI. By default only
the classes GRMLBASE, GRML_SMALL and I386 are assumed, resulting in a small base
system (being about ~150MB total ISO size). If using a non-I386 system (like
amd64) you should specify the appropriate architecture as well. Additionally you
can specify a class providing a grml-kernel (see
<a href="#classes">the <em>CLASSES</em> section in this document</a> for details about available classes).
So instead of GRML_SMALL you can also use GRML_MEDIUM and GRML_FULL.
</p>
</dd>
<dt>
-C <strong>CONFIGURATION_FILE</strong>
</dt>
<dd>
<p>
The specified file is used as configuration file for grml-live. By default
/etc/grml/grml-live.conf is used for main configuration. If a file named
/etc/grml/grml-live.local exists it is used as well (sourced after reading
/etc/grml/grml-live.conf to allow overriding settings). As a last option the
specified configuration file is sourced so it is possible to override settings
of /etc/grml/grml-live.conf as well as of /etc/grml/grml-live.local. Please
notice that all configuration files have to be adjusted during execution of
grml-live, so please make sure you use /etc/grml/grml-live.conf as a base for
your own configuration file. Please also notice that the configuration file
specified via this option is <strong>not</strong> (yet) supported inside the
scripts/hooks/classes at /etc/grml/fai/config. Instead use
/etc/grml/grml-live.conf and/or /etc/grml/grml-live.local for configuration
stuff used inside /etc/grml/fai/config.
</p>
</dd>
<dt>
-F
</dt>
<dd>
<p>
Force execution and do not prompt for acknowledgment of configuration.
</p>
</dd>
<dt>
-g <strong>GRML_NAME</strong>
</dt>
<dd>
<p>
Set the grml flavour name. Common usage examples: grml, grml-small, grml64.
Please do NOT use blanks and any special characters like <em>/</em>, <em>;</em> inside
GRML_NAME, otherwise you might notice problems with booting.
</p>
</dd>
<dt>
-h
</dt>
<dd>
<p>
Display short usage information and exit.
</p>
</dd>
<dt>
-i <strong>ISO_NAME</strong>
</dt>
<dd>
<p>
Specify name of ISO which will be available inside $OUTPUT_DIRECTORY/grml_isos
by default.
</p>
</dd>
<dt>
-o <strong>OUTPUT_DIRECTORY</strong>
</dt>
<dd>
<p>
Main output directory of the build process of FAI. Some directories are created
inside this target directory, being: grml_cd (where the files for creating the
ISO are located, including the compressed squashfs file), grml_chroot (the
chroot system) and grml_isos (where the resulting ISO is stored).
</p>
</dd>
<dt>
-r <strong>RELEASENAME</strong>
</dt>
<dd>
<p>
Specify name of the release.
</p>
</dd>
<dt>
-s <strong>SUITE</strong>
</dt>
<dd>
<p>
Specify the Debian suite you want to use for your live-system. Defaults to
"etch" (being current Debian/stable). Supported values are: etch, lenny, sid.
</p>
</dd>
<dt>
-t <strong>TEMPLATE_DIRECTORY</strong>
</dt>
<dd>
<p>
Specify place of the templates used for building the ISO. By default
(and if not manually specified) this is /usr/share/grml-live/templates/.
</p>
</dd>
<dt>
-u
</dt>
<dd>
<p>
Update existing chroot instead of rebuilding it from scratch. This option is
based on the softupdate feature of FAI.
</p>
</dd>
<dt>
-v <strong>VERSION_NUMBER</strong>
</dt>
<dd>
<p>
Specify version number of the release.
</p>
</dd>
<dt>
-V
</dt>
<dd>
<p>
Increase verbosity in the build process.
</p>
</dd>
<dt>
-z
</dt>
<dd>
<p>
Use ZLIB instead of LZMA compression in mksquashfs part of the build process.
</p>
</dd>
</dl>
</div>
<h2>Usage examples</h2>
<div class="sectionbody">
<p>To get a small, Debian-stable and grml-based Live-CD using /grml/grml-live
as build and output directory just run:</p>
<div class="literalblock">
<div class="content">
<pre><tt># grml-live</tt></pre>
</div></div>
<p>To get a small Debian-unstable and grml-small based Live-CD using
/home/mika/grml-live as build and output directory just use:</p>
<div class="literalblock">
<div class="content">
<pre><tt># grml-live -s sid -c GRMLBASE,GRML_SMALL,I386 -o /home/mika/grml-live</tt></pre>
</div></div>
<p>To get a medium sized, Debian-unstable and grml-based Live-CD for i386
architecture using /grml/grml-live as build and output directory just run:</p>
<div class="literalblock">
<div class="content">
<pre><tt># grml-live -s sid -a i386 -c GRMLBASE,GRML_MEDIUM,I386</tt></pre>
</div></div>
<p>To get a small, Debian-unstable and grml-based Live-CD using /tmp as build and
output directory and use grml_0.0-3.iso as ISO name (placed inside
/tmp/grml_isos) just invoke:</p>
<div class="literalblock">
<div class="content">
<pre><tt># grml-live -o /tmp -c GRMLBASE,GRML_SMALL,I386 -s sid -i grml_0.0-3.iso</tt></pre>
</div></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<img src="./images/icons/note.png" alt="Note" />
</td>
<td class="content">If you have about 700MB of free space inside /dev/shm (being a tmpfs, usually
you should have >=1GB of RAM) just run "mount -o remount,suid,dev,rw /dev/shm"
and use /dev/shm as build and output directory - resulting in very fast build
process. But please be aware of the fact that rebooting your system will result
in an empty /dev/shm, so please use another directory for $CHROOT_OUTPUT,
$BUILD_OUTPUT and $ISO_OUTPUT if you plan to create more persistent output. :)</td>
</tr></table>
</div>
</div>
<h2>Main features of grml-live</h2>
<div class="sectionbody">
<ul>
<li>
<p>
create a grml-/Debian-based Linux Live-CD with one single command
</p>
</li>
<li>
<p>
class based concept, providing a maximum of flexibility
</p>
</li>
<li>
<p>
supports integration of own hooks, scripts and configuration
</p>
</li>
<li>
<p>
supports use and integration of own Software and/or Kernels via simple use of
Debian repositories
</p>
</li>
<li>
<p>
native support of FAI features
</p>
</li>
<li>
<p>
multi-arch support (work in progress)
</p>
</li>
</ul>
</div>
<h2>The class concept</h2>
<div class="sectionbody">
<p>grml-live uses FAI and its class based concept for adjusting configuration and
setup according to your needs. This gives you flexibility and strength without
losing the simplicity in the build process.</p>
<p>The main and base class provided by grml-live is named GRMLBASE. It's strongly
recommended to <strong>always</strong> use the class GRMLBASE when building an ISO using
grml-live, as well as the architecture dependent class which provides the kernel
(being <em>I386</em> for x86_32 and <em>AMD64</em> for x86_64) and a GRML_* class (like
GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are
relevant for class GRMLBASE by default:</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/config/scripts/GRMLBASE/
/etc/grml/fai/config/debconf/GRMLBASE
/etc/grml/fai/config/class/GRMLBASE.var
/etc/grml/fai/config/hooks/instsoft.GRMLBASE
/etc/grml/fai/config/package_config/GRMLBASE</tt></pre>
</div></div>
<p>Take a look at the next section for information about the concept of those
files/directories.</p>
<p>If you want to use your own configuration, extend an existing configuration
and/or add additional packages to your ISO just invent a new class (or extend an
existing one). For example if you want to use your own class named "FOOBAR" just
extend CLASSES="GRMLBASE,GRML_SMALL,I386" inside /etc/grml/grml-live.conf to
CLASSES="GRMLBASE,GRML_SMALL,I386,FOOBAR" or invoke grml-live using the classes
option: "grml-live -c GRMLBASE,GRML_SMALL,I386,FOOBAR …".</p>
<p>More details regarding the class concept can be found in the documentation of
FAI itself (being available at /usr/share/doc/fai-doc/).</p>
</div>
<h2><a id="classes"></a>Available classes</h2>
<div class="sectionbody">
<p>The package selection part of the classes can be found in
/etc/grml/fai/config/package_config whereas some further classes are defined for
example in /etc/grml/fai/config/scripts/ so specific feature sets can be
selected. The following classes are predefined:</p>
<ul>
<li>
<p>
DEBORPHAN: get rid of all packages listed in output of Deborphan
</p>
</li>
<li>
<p>
GRMLBASE: the main class responsible for getting a minimal subset of what's
defining a grml system. Important parts of the buildprocess are specified in
this class as well, so unless you have a really good reason you should always
use this class.
</p>
</li>
<li>
<p>
GRML_FORENSIC: tools for forensic investigations which has been created
by people from <a href="http://www.forensic-geeks.org/">forensic-geeks.org</a>.
</p>
</li>
<li>
<p>
GRML_FULL: full featured grml, also known as the "normal", full grml.
</p>
</li>
<li>
<p>
GRML_MEDIUM: medium sized grml version, known as grml-medium
</p>
</li>
<li>
<p>
GRML_POWERPC: grml for PowerPC architecture, not supported yet (still work in
progress)
</p>
</li>
<li>
<p>
GRML_SMALL: minimum sized grml version, known as grml-small
</p>
</li>
<li>
<p>
LATEX_CLEANUP: get rid of several very large LaTeX directories
(like some /usr/share/doc/texlive-*, /usr/share/doc/texmf,…)
</p>
</li>
<li>
<p>
LOCALES: use full featured locales setup (see /etc/locale.gen.grml)
</p>
</li>
<li>
<p>
NO_ONLINE: do not run scripts during the chroot build process which require a
network connection
</p>
</li>
<li>
<p>
RELEASE: run some specific scripts and commands to provide the workflow for an
official grml release
</p>
</li>
<li>
<p>
REMOVE_DOCS: get rid of documentation directories (like /usr/share/doc,
/usr/share/man/, /usr/share/info,…)
</p>
</li>
<li>
<p>
XORG: providing important packages for use with a base grml-featured X.org
setup
</p>
</li>
</ul>
</div>
<h2>Files</h2>
<div class="sectionbody">
<p>Notice that grml-live ships FAI configuration files that do not use the same
namespace as the FAI packages itself. This ensures that grml-live does not clash
with your usual FAI configuration, so instead of /etc/fai/fai.conf (package
fai-client) grml uses /etc/grml/fai/fai.conf instead. For more details see
below. To get an idea how another configuration or example files could look like
check out /usr/share/doc/fai-doc/examples/simple/ (provided by Debian package
fai-doc). Furthermore /usr/share/doc/fai-doc/fai-guide.html/ch-config.html
provides documentation regarding configuration possibilities.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/usr/sbin/grml-live</tt></pre>
</div></div>
<p>Script for the main build process. Requires root permissions for execution.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/grml-live.conf</tt></pre>
</div></div>
<p>Main configuration file for grml-live. All the important steps can be configured
at this stage.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/fai.conf</tt></pre>
</div></div>
<p>Main configuration file for FAI which specifies where all the configuration
files and scripts for FAI/grml-live can be found. By default it is set to
FAI_CONFIGDIR=/etc/grml/fai/config, a directory shipped by grml-live
out-of-the-box so you shouldn't have to configure anything in this file.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/make-fai-nfsroot.conf</tt></pre>
</div></div>
<p>This file is used by make-fai-nfsroot(8) only. Usually you don't have to change
anything inside this file. If you want to modify NFSROOT though you can adjust
it there.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/NFSROOT</tt></pre>
</div></div>
<p>This file specifies the package list for creating the NFSROOT.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/apt/sources.list</tt></pre>
</div></div>
<p>This file specifies which mirrors should be used for retreiving the Debian
packages used for creating the main chroot (including all the software you would
like to see included). If you want to use a local mirror you either have to
adjust this file or use the GRML_LIVE_SOURCES variable inside
/etc/grml/grml-live.conf which modifies /etc/grml/fai/apt/sources.list
on-the-fly then.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/config/</tt></pre>
</div></div>
<p>The main directory for configuration of FAI/grml-live. More details below.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/config/class/</tt></pre>
</div></div>
<p>This directory contains files which specify main configuration variables for the
FAI classes.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/config/debconf/</tt></pre>
</div></div>
<p>This directory provides the files for preseeding/configuration of debconf
through files.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/config/hooks/</tt></pre>
</div></div>
<p>This directory provides files for customising the build process through hooks.
Hooks are user defined programs or scripts, which are called during the
installation process.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/config/package_config/</tt></pre>
</div></div>
<p>Directory with lists of software packages to be installed or removed. The
different classes describe what should find its way to your ISO. When running
"grml-live -c GRMLBASE,GRML_SMALL,I386 …" only the configuration of GRMLBASE,
GRML_SMALL and and I386 will be taken. If you use <em>grml-live -c
GRMLBASE,GRML_SMALL,I386,FOOBAR …</em> then the files of GRMLBASE, GRML_SMALL,
I386 <strong>plus</strong> the files from FOOBAR will be taken. So just create a new class to
adjust the package selection according to your needs. Please notice that the
directory GRMLBASE contains a package list defining a minimum but still
reasonable package configuration.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/config/scripts/</tt></pre>
</div></div>
<p>Scripts for customising the ISO within the build process.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/files/</tt></pre>
</div></div>
<p>This directory provides files used inside the scripts of
/etc/grml/fai/config/scripts/*. For a full documentation what happens with the
files please refer to the source of the scripts.</p>
<div class="literalblock">
<div class="content">
<pre><tt>/etc/grml/fai/live-initramfs/</tt></pre>
</div></div>
<p>This directory provides the files used for building the initramfs/initrd via
live-initramfs(8).</p>
</div>
<h2>Available log files</h2>
<div class="sectionbody">
<p>grml-live itself logs to /var/log/grml-live.log. Unless you set ZERO_LOGFILE in
/etc/grml/grml-live.conf the output is appended to the file. If you set the
ZERO_LOGFILE configuration option the logfile will be truncated on each new
invocation of grml-live.</p>
<p>The FAI part of grml-live logs to /var/log/fai/$HOSTNAME/ - so the
default being /var/log/fai/grml/.</p>
<p>If you are using the grml-live buildd you will find the logs of the grml-live
run at /var/log/grml-buildd.stdout and /var/log/grml-buildd.stderr.</p>
</div>
<h2>Requirements for the build system</h2>
<div class="sectionbody">
<ul>
<li>
<p>
any Debian based system should be sufficient (if not it's a bug, so please
send us a bug report then) [a usual <a href="http://grml.org/grml2hd/">grml2hd</a>
harddisk installation ships all you need]
</p>
</li>
<li>
<p>
enough free disk space; at least 800MB are required for a minimal grml-live
run (~400MB for the chroot [$CHROOT_OUTPUT], ~150MB for the build target
[$BUILD_OUTPUT] and ~150MB for the resulting ISO [$ISO_OUTPUT] plus some
temporary files), if you plan to use GRML_FULL you should have at least 4GB of
total free disk space
</p>
</li>
<li>
<p>
fast network access for retreiving the Debian packages used for creating the
chroot (check out "local mirror" and "NFSROOT" to workaround this problem as far
as possiblbe)
</p>
</li>
</ul>
<p>For further information see next section.</p>
</div>
<h2><a id="current_state"></a>Current state of grml-live with squashfs-tools and kernel</h2>
<div class="sectionbody">
<p>To make it easier to track problems this section documents current state of
grml-live playing together with squashfs-tools / squashfs-lzma-tools (for
building the compressed file) and the kernel version. Documentation of this
section is up2date by 27th of september 2008.</p>
<h3>System</h3>
<ul>
<li>
<p>
grml-live, version 0.9.4
</p>
</li>
<li>
<p>
building grml-medium (Debian/unstable)
</p>
</li>
<li>
<p>
software versions used in the ISO (being installed automatically, recorded
just as a reference):
</p>
<div class="literalblock">
<div class="content">
<pre><tt>ii busybox 1:1.10.2-2 Tiny utilities for small and embedded systems
ii initramfs-tools 0.92f.grml01 tools for generating an initramfs
ii klibc-utils 1.5.12-2 small utilities built with klibc for early boot
ii live-initramfs 1.139.1-2grml.01 Debian Live initramfs hook
ii lvm2 2.02.39-2 The Linux Logical Volume Manager
ii mdadm 2.6.7-3.1 tool to administer Linux MD arrays (software RAID)
ii udev 0.125-6grml0 /dev/ and hotplug management daemon</tt></pre>
</div></div>
</li>
</ul>
<h3>Using squashfs-lzma-tools 3.3-1 on the build system</h3>
<p>squashfs-lzma-tools from the grml repository supports kernel 2.6.26-grml
(version >=grml.05) using both lzma and zlib (-nolzma) compression. It's the
recommended package for building ISOs with grml-live currently.</p>
<h3>Using squashfs-tools 1:3.3-7 on the build system</h3>
<p>squashfs-tools 1:3.3-7 is available via Debian/unstable and Debian/testing
(lenny) pool running:</p>
<div class="literalblock">
<div class="content">
<pre><tt># aptitude install squashfs-tools=1:3.3-7</tt></pre>
</div></div>
<p>or directly via downloading the files
http://grml.org/squashfs/squashfs-tools_3.3-7_i386.deb (for x86) or
http://grml.org/squashfs/squashfs-tools_3.3-7_amd64.deb (for amd64) [both build
on and for Debian/etch but working with testing and unstable as well].</p>
<p>Please notice that squashfs-tools 1:3.3-7 does NOT support LZMA compression at
all. The -nolzma option of mksquashfs is not available therefore (even
though grml-live will deactivate it for you automatically anyway). Please
use squashfs-lzma-tools instead.</p>
<ul>
<li>
<p>
Kernel 2.6.23-grml: does NOT work, please use squashfs-tools 1:3.2r2-9exp1
instead if you still want to use kernel 2.6.23
</p>
</li>
<li>
<p>
Kernel 2.6.26-grml: works
</p>
</li>
</ul>
<h3>Using squashfs-tools 1:3.2r2-9exp1 on the build system</h3>
<p>squashfs-tools 1:3.2r2-9exp1 is available via the grml-testing repository,
running:</p>
<div class="literalblock">
<div class="content">
<pre><tt># aptitude install squashfs-tools=1:3.2r2-9exp1</tt></pre>
</div></div>
<p>or directly via downloading the files
http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_i386.deb (for x86) or
http://grml.org/squashfs/squashfs-tools_3.2r2-9exp1_amd64.deb (for amd64).</p>
<p>Versions with ZLIB compression (SQUASHFS_OPTIONS=<em>-nolzma</em> or -z
option in grml-live cmdline):</p>
<ul>
<li>
<p>
Kernel 2.6.23-grml: works
</p>
</li>
<li>
<p>
Kernel 2.6.26-grml: works
</p>
</li>
</ul>
<p>Versions with LZMA compression:</p>
<ul>
<li>
<p>
Kernel 2.6.23-grml: works
</p>
</li>
<li>
<p>
Kernel 2.6.26-grml: does NOT work, please use zlib mode instead
</p>
</li>
</ul>
</div>
<h2>FAQ</h2>
<div class="sectionbody">
<h3>Help, I'm using Debian etch and I don't have FAI version >3.2</h3>
<div class="literalblock">
<div class="content">
<pre><tt>wget http://www.informatik.uni-koeln.de/fai/download/etch/fai-client_3.2.8_all.deb \
http://www.informatik.uni-koeln.de/fai/download/etch/fai-server_3.2.8_all.deb \
http://www.informatik.uni-koeln.de/fai/download/etch/fai-doc_3.2.8_all.deb
dpkg -i fai-client_3.2.8_all.deb fai-server_3.2.8_all.deb fai-doc_3.2.8_all.deb</tt></pre>
</div></div>
<p>or check out the <a href="http://www.informatik.uni-koeln.de/fai/">FAI-homepage</a> for
further details.</p>
<h3>I've problems with the build process. How to start debugging?</h3>
<p>Check out the logs inside /var/log/fai/… If you don't have the time to debug
the problem in further detail or don't know how to proceed just send a copy of
your config, logs and the commandline with a short problem description to
<mika@grml.org>:</p>
<div class="literalblock">
<div class="content">
<pre><tt># history | grep grml-live > /etc/grml/grml_live.cmdline
# tar zcf grml_live_problem.tar.gz /etc/grml/grml-live.conf \
/etc/grml/grml-buildd.conf /var/log/fai /etc/grml/fai</tt></pre>
</div></div>