| 1 |
<html> |
| 2 |
<head> |
| 3 |
<title>Setup</title> |
| 4 |
</head> |
| 5 |
<body> |
| 6 |
<h1>Setup</h1> |
| 7 |
|
| 8 |
<p>Configuration for debian-cd is stored in the file CONF.sh. This |
| 9 |
file is a shell script that is sourced in by the build scripts; |
| 10 |
options are set up in the file using standard shell syntax for |
| 11 |
environment variable handling.</p> |
| 12 |
|
| 13 |
<p>The file that is shipped by default with debian-cd is |
| 14 |
well-commented, but is rather large and may be initimidating to new |
| 15 |
users. There are <strong>lots</strong> of options, but most of them |
| 16 |
have sane defaults and can be ignored in common use.</p> |
| 17 |
|
| 18 |
<h2>Necessary configuration</h2> |
| 19 |
|
| 20 |
<p>The key options that would always be configured by a user are:</p> |
| 21 |
|
| 22 |
<ul> |
| 23 |
<li><code>CODENAME</code> - typically "etch", "lenny" or "sid" |
| 24 |
<li><code>DEBVERSION</code> - the version number to go with that codename |
| 25 |
<li><code>OFFICIAL</code> - do <strong>not</strong> claim to be making official Debian CDs here! |
| 26 |
<li><code>MIRROR</code> - specify the absolute path to your mirror of the Debian archive |
| 27 |
<li><code>TDIR</code> - a path to a temporary directory; should be on the same filesystem as <code>MIRROR</code> so that hard links work |
| 28 |
<li><code>OUT</code> - the directory where ISO images and/or jigdo files will be created |
| 29 |
<li><code>APTTMP</code> - another temporary directory for layout code; can live anywhere |
| 30 |
<li><code>ARCHES</code> - (optionally) specify the architecture(s) to |
| 31 |
build for. If you you want a multi-arch disc set, specify all the |
| 32 |
arches you want as one argument, using quotes (e.g. "amd64 i386 |
| 33 |
powerpc") |
| 34 |
<li><code>DISKTYPE</code> - the type of disc you're trying to |
| 35 |
build. Recognised values are: <code>BC</code>, <code>NETINST</code>, |
| 36 |
<code>CD</code>, <code>CD700</code>, <code>DVD</code> and |
| 37 |
<code>CUSTOM</code>. The disc type is mainly used to decide the |
| 38 |
allowable size per output image. If you choose <code>CUSTOM</code>, |
| 39 |
then you'll also need to set <code>CUSTOMSIZE</code> to the size of |
| 40 |
your media. |
| 41 |
</ul> |
| 42 |
|
| 43 |
<p>Setting these options is sufficient to allow creation of a standard |
| 44 |
set of CDs for your architecture, that should look very similar to the |
| 45 |
official Debian builds. To actually start the build for one |
| 46 |
architecture, run <code>build.sh $ARCH</code>. To build for more |
| 47 |
architectures, run <code>build_all.sh</code>.</p> |
| 48 |
|
| 49 |
<h2>More advanced configuration</h2> |
| 50 |
|
| 51 |
<p>A larger set of options that might be commonly tweaked by users |
| 52 |
wanting to make different images include:</p> |
| 53 |
|
| 54 |
<ul> |
| 55 |
<li><code>DI_WWW_HOME</code> - specify the location of d-i boot images to go on the first CD rather than the default ones from the mirror |
| 56 |
<li><code>CONTRIB</code> - whether or not to allow packages from the contrib section onto the CDs |
| 57 |
<li><code>NONFREE</code> - whether or not to allow packages from the non-free section onto the CDs |
| 58 |
<li><code>EXTRANONFREE</code> - like <code>NONFREE</code>, but sort the non-free packages to a separate last CD instead of mixing them in |
| 59 |
<li><code>LOCAL</code> - if you have a local set of packages that you want to merge into your CDs, specify the location here. The location should look just like the other sections (main, contrib, non-free) with Packages files etc. |
| 60 |
<li><code>LOCALDEBS</code> - if you have set <code>LOCAL</code> above |
| 61 |
and the local packages are outside of the <code>MIRROR</code> tree, |
| 62 |
specify the local here. |
| 63 |
<li><code>EXCLUDE</code> - specifies a file listing packages that should be omitted from consideration when laying out the CDs |
| 64 |
<li><code>UNEXCLUDE$N</code> - a way to re-add excluded packages back into the set, starting with CD number $N. Using <code>EXCLUDE</code> and <code>UNEXCLUDE</code> allows some finer-grained control of package placement if desired |
| 65 |
<li><code>DOJIGDO</code> - specify what to create: 0 means ISOs only; 1 means ISOs and jigdo files; 2 means jigdo files only |
| 66 |
<li><code>JIGDOFALLBACKPATH</code> - if you're publishing jigdo files, you may specify a location here and debian-cd will create a snapshot tree for you |
| 67 |
<li><code>JIGDOFALLBACKURLS</code> - this is how to specify the URL that the <code>JIGDOFALLBACKPATH</code> corresponds to |
| 68 |
<li><code>UDEB_INCLUDE</code> - a file listing installer udebs that should be pushed into the install system |
| 69 |
<li><code>UDEB_EXCLUDE</code> - opposite of <code>UDEB_INCLUDE</code> |
| 70 |
<li><code>BASE_INCLUDE</code> - a file listing packages that should be installed onto the target system by d-i |
| 71 |
<li><code>BASE_EXCLUDE</code> - packages that should <strong>not</strong> be installed |
| 72 |
<li><code>INSTALLER_CD</code> - use this to specify the type of disc to create: 0 means a normal CD/DVD set; 1 means a "business card", i.e. just d-i and no packages; 2 means a "netinst", i.e. d-i and the base system only |
| 73 |
<li><code>MAXCDS</code> - a way to limit how many CDs will be built; this won't force packages to fit, but will simply cut off the build once the specified number are done |
| 74 |
<li><code>SPLASHPNG</code> - specify the image to be used on the boot splash screen, on architectures where this is supported |
| 75 |
</ul> |
| 76 |
|
| 77 |
<p>If you do tweak some of these options, it may take quite a few |
| 78 |
iterations of testing to get exactly what you're looking for. Be |
| 79 |
warned!</p> |
| 80 |
|
| 81 |
<p>For more information and yet more configuration, please see the |
| 82 |
comments in the shipped CONF.sh file. Or, if in doubt, ask!</p> |
| 83 |
|
| 84 |
<hr> |
| 85 |
(c) Steve McIntyre <[email protected]>, December 2006. GPL v2<br> |
| 86 |
<a href="requirements.html">Prev - debian-cd requirements</a><br> |
| 87 |
<a href="running.html">Next - Running debian-cd to make some disc images</a> |
| 88 |
</body> |
| 89 |
</html> |