docs: How to use your own local repository

[grml-live.git] / docs / grml-live.txt

diff --git a/docs/grml-live.txt b/docs/grml-live.txt
index 3524115..7e56bbd 100644 (file)
--- a/docs/grml-live.txt
+++ b/docs/grml-live.txt
@@ -285,7 +285,7 @@ The main and base class provided by grml-live is named GRMLBASE. It's strongly
 recommended to **always** use the class GRMLBASE when building an ISO using
 grml-live, as well as the architecture dependent class which provides the kernel
 (being 'I386' for x86_32 and 'AMD64' for x86_64) and a GRML_* class (like
-GRML_SMALL, GRML_MEDIUM or GRML_FULL). The following files and directories are
+GRML_SMALL or GRML_FULL). The following files and directories are
 relevant for class GRMLBASE by default:
 
   ${GRML_FAI_CONFIG}/config/scripts/GRMLBASE/
@@ -329,17 +329,11 @@ this class as well, so unless you have a really good reason you should always
 use this class.
 
 * GRML_FULL: full featured Grml, also known as the "normal", full grml as
-introduced in December 2011 (~350MB ISO size).
+introduced in December 2011 (~460MB ISO size).
 
-* GRML_MEDIUM: medium sized Grml version, used to be known as grml-medium
-until December 2011 (~220MB ISO size).
-
-* GRML_SMALL: minimum sized Grml version, known as grml-small (~110MB ISO
+* GRML_SMALL: minimum sized Grml version, known as grml-small (~230MB ISO
 size).
 
-* GRML_XL: large size Grml version, used to be known as "full grml" until
-December 2011 (~700MB ISO size).
-
 * LATEX: LaTeX(-related) packages like auctex, texlive,...
 (which used to be shipped by grml before the LaTeX removal)
 
@@ -724,6 +718,30 @@ And finally place the generated tarball in /etc/grml/fai/config/basefiles/ (note
 that it needs to be uppercase letters matching the class names, so: AMD64.tar.gz
 for amd64 and I386.tar.gz for i386).
 
+[[localrepos]]
+How to use your own local repository
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Let's assume you have Debian package(s) in your filesystem inside
+`/home/foobar/local-packages` and want to include that in your grml-live build.
+Make sure to create an according sources.list configuration file, e.g. using
+your own class name `CUSTOM`:
+
+  # cat > /etc/grml/fai/config/files/etc/apt/sources.list.d/local-packages.list/CUSTOM << EOF
+  deb file:///home/foobar/local-packages ./
+  EOF
+
+Add the according MIRROR_DIRECTORY configuration to your grml-live configuration:
+
+  # echo "MIRROR_DIRECTORY='/home/foobar/packages'" >> /etc/grml/grml-live.local
+
+Make sure the local directory looks like a mirror:
+
+  % cd /home/foobar/packages && /usr/bin/dpkg-scanpackages . /dev/null > ./Packages
+
+Finally invoke grml-live with your class name (`CUSTOM` in this example) added
+to the list of classes (see grml-live option `-c`).
+
 [[download]]
 Download / install grml-live as a Debian package
 ------------------------------------------------