drop full-ov, custom-ov, live-rw and home-rw from the helptext
[grml-live.git] / etc / grml / grml-live.conf
1 # Filename:      /etc/grml/grml-live.conf
2 # Purpose:       main configuration file for grml-live
3 # Authors:       grml-team (grml.org), (c) Michael Prokop <mika@grml.org>
4 # Bug-Reports:   see http://grml.org/bugs/
5 # License:       This file is licensed under the GPL v2 or any later version.
6 ################################################################################
7 # !!!!!! IMPORTANT NOTE !!!!!
8 # This file is meant as a reference. Please adjust your local configuration
9 # via /etc/grml/grml-live.local instead as this file is marked as configuration
10 # file in your package management.
11 # !!!!!! IMPORTANT NOTE !!!!!
12 ################################################################################
13
14 # Main output directory
15 # Please notice that you need suid,dev,rw permissions there
16 # OUTPUT="/grml/grml-live"
17 # You have enough RAM? Use shared memory for fast testing-purposes:
18 # OUTPUT="/dev/shm" # mount -o remount,suid,dev,rw /dev/shm
19
20 # Where do want to find the chroot of the buildprocess files?
21 # CHROOT_OUTPUT="$OUTPUT/grml_chroot"
22 # Where do you want to find the compressed chroot, bootstuff,...?
23 # BUILD_OUTPUT="$OUTPUT/grml_cd"
24 # Where do you want to find the final ISO?
25 # ISO_OUTPUT="$OUTPUT/grml_isos"
26 # Where do you want to find the netboot package?
27 # NETBOOT="${OUTPUT}/netboot/"
28
29 # Do you want to preserve the logfile from being cleaned after each execution
30 # of grml-live? By default the logfile is cleaned so the log doesn't fill up.
31 # If you want to store your logs permanently it's recommended to use grml-live-db.
32 # PRESERVE_LOGFILE='1'
33
34 # If package grml-live-db is installed the package selection and grml-live.log
35 # are being logged to to a sqlite database.Defaults to /var/log/grml-live.db
36 # DPKG_DATABASE=/var/log/grml-live.db
37
38 # Use your own database wrapper script for grml-live-db:
39 # DPKG_DBSCRIPT=/usr/share/grml-live-db/scripts/dpkg-to-db
40
41 # Use your own database script cmdline options for grml-live-db:
42 # DPKG_DBOPTIONS="-d $DPKG_DATABASE --logfile $LOGFILE --flavour $GRML_NAME < $DPKG_LIST"
43
44 # Do you want to zero / clean up / remove the previous logfiles of FAI
45 # before executing grml-live? Otherwise keep all the logfiles inside
46 # /var/log/fai/$HOSTNAME/...
47 # Default: unset (so do not remove the logfile(s))
48 # ZERO_FAI_LOGFILE='1'
49
50 # Which Debian suite/release do you want to use?
51 # Supported values are: stable, testing, unstable (or their corresponding release
52 # names like "jessie").
53 # Unless it is set it defaults to "testing".
54 # SUITE="unstable"
55
56 # Which FAI classes do you want to use by default?#
57
58 # Notice: GRMLBASE is recommended in any case unless you *really* know what you
59 # are doing; make sure to also use a GRML_* class (for example GRML_SMALL
60 # or GRML_FULL) to get an according kernel and also select the
61 # architecture (I386 for x86; AMD64 for x86_64)
62 # CLASSES="GRMLBASE,GRML_FULL,I386"
63
64 # HTTP Proxy to use for APT
65 # APT_PROXY="http://localhost:3142/"
66
67 # Which Debian suite and which mirror do you want to use for debootstrapping?
68 # Usage: "<suite> <mirror>"
69 # FAI_DEBOOTSTRAP="jessie http://ftp.debian.org/debian"
70
71 # Do you want to use a local mirror (like NFS)?
72 # If so specify the directory where debian/ is available:
73 # MIRROR_DIRECTORY="/media/mirror"
74 # ... and then set up an according class file in
75 # ${GRML_FAI_CONFIG}/config/files/etc/apt/sources.list.d/
76 # containing something like:
77 # deb file:///media/mirror/debian sid main contrib non-free
78 MIRROR_DIRECTORY="/home/evgeni/local-packages"
79
80 # Version number of ISO:
81 # VERSION="0.0-1"
82
83 # Name of the release:
84 # RELEASENAME="grml-live rocks"
85
86 # Which "grml flavour name" do you want to use?
87 # Common usage examples: grml, grml-small, grml64,...
88 # GRML_NAME="grml"
89
90 # Specify hostname of the live-system:
91 # HOSTNAME=grml
92
93 # Specify user with UID 1000 on live-system:
94 # USERNAME=grml
95
96 # Which bootloader do you want to use? Default: isolinux
97 # Supported values: isolinux, grub, grub2
98 # BOOT_METHOD='isolinux'
99
100 # Directory of configuration files for grml-live's FAI:
101 # GRML_FAI_CONFIG=/etc/grml/fai
102
103 # Do you want to put any local files into the chroot?
104 # If so then point CHROOT_INSTALL to a directory providing the files.
105 # Note: the files are installed under '/' in the chroot -
106 # so you have to create the rootfs structure on your own.
107 # CHROOT_INSTALL="$GRML_FAI_CONFIG/chroot_install"
108
109 # Do you want to pass any additional arguments to FAI?
110 # FAI_ARGS=""
111
112 # Where do you want to store grml-live.log?
113 # LOGDIR="/var/log/fai/$HOSTNAME/last"
114
115 # Which architecture do you want to build?
116 # It defaults to output of 'dpkg --print-architecture'
117 # ARCH="i386"
118
119 # Name of distribution that should be build. By default
120 # it's "grml", if you want to adjust please make sure
121 # your distri name is just one single word so it
122 # works on the boot prompt.
123 # DISTRI_NAME="grml"
124
125 # Short information about the distribution. Default:
126 # DISTRI_INFO="Grml - Live Linux for system administrators   "
127
128 # Bootsplash background image use in isolinux configuration
129 # Note: not relevant if using non-default ISOLINUX_METHOD="console".
130 # DISTRI_SPLASH='grml.png'
131
132 # Do you want to use your own templates? If so set the
133 # template directory but please make sure it looks
134 # likes the default directory [/usr/share/grml-live/templates]
135 # TEMPLATE_DIRECTORY='/usr/share/grml-live/templates'
136
137 # Use custom scripts, for example for bootgrub.mksh?
138 # Useful when running grml-live from git checkout.
139 # If unset defaults to /usr/share/grml-live/scripts
140 # SCRIPTS_DIRECTORY='/usr/share/grml-live/scripts'
141
142 # Do you want to use console based isolinux boot splash
143 # instead of the default graphical menu?
144 # ISOLINUX_METHOD="console"
145
146 # Do you want to skip adding /boot/addons/ (from the template directory)?
147 # NO_ADDONS='1'
148
149 # Do you want to skip adding /boot/addons/bsd4grml/ (from the template directory)?
150 # NO_ADDONS_BSD4GRML='1'
151
152 # By default the ISO is created for hybrid boot, so you can either
153 # boot the CD using normal el torito mode or copy it to USB device
154 # *without* having to run grml2usb (like: 'dd if=grml.iso of=/dev/sdX')
155 # - working both with the same ISO
156 # HYBRID_METHOD='disable'   # do not create a hybrid ISO
157 # HYBRID_METHOD='isohybrid' # use isohybrid from SYSLINUX
158 # HYBRID_METHOD='grub2'     # use manifold with GRUB 2
159 # HYBRID_METHOD='manifold'  # use manifold with ISOLINUX (default)
160
161 # Binary that should be used for creating the squashfs file.
162 # Defaults to the executable matching the kernel version, falls back to mksquashfs.
163 # SQUASHFS_BINARY='mksquashfs'
164
165 # Options that should be used by mksquashfs during build process.
166 # Defaults to '-b 256k' and the according LZMA/XZ option.
167 # SQUASHFS_OPTIONS='-b 256k'
168
169 # exclude files from compressed squashfs file using the
170 # the mksquashfs option -ef:
171 # SQUASHFS_EXCLUDES_FILE="${GRML_FAI_CONFIG}/config/grml/squashfs-excludes"
172
173 # Do you want to exit grml-live if some packages were requested for installation
174 # on fresh installs but are missing on the generated ISO finally?
175 # By default the package list is sent to stdout but grml-live doesn't interrupt.
176 # EXIT_ON_MISSING_PACKAGES=1
177
178 # Do you want to use a special string for identifying the ISO?
179 # By default the grml-name and version string are used as a base for generating
180 # /conf/bootid.txt on the ISO. If you want to use a different value feel free to
181 # adjust it accordingly.
182 # Please notice that space characters inside this variable are not supported.
183 # BOOTID="mybootid"
184
185 # Do you want to skip the /conf/bootid.txt feature?
186 # NO_BOOTID='1'
187
188 # Do you want to add any additional bootoptions that should be used by default?
189 # DEFAULT_BOOTOPTIONS="ssh=secret"
190
191 ## END OF FILE #################################################################