3 This file documents many of the variables used in pc-sysinstall
5 #################################################################
9 Using hostname= will set the specified hostname on the
12 When hostname= is not present, pc-sysinstall will auto-generate
13 a hostname such as freebsd-XXXX or pcbsd-XXXX
15 # installMode=(fresh/upgrade/extract)
17 Set the type of install we are doing.
19 Fresh installs will format and mount the target disks before
20 extracting the install images to the system. Using this mode
21 it is also possible to do a system restore, by specifying a
22 full system backup as the install source.
24 Upgrades will mount the target disk, and extract the system
25 archive to the disk, overwriting files on the disk.
26 The conf/exclude-from-upgrade file can be used to specify
27 additional files to exclude from overwriting during the
30 Extract will skip any disk setup, and perform an installation
31 to the directory specified by "installLocation=". This location
32 should be a directory with your pre-mounted file-systems ready
33 for file extraction. When using the "extract" option, /etc/fstab
34 on the installed system will *not* be automatically configured.
38 Used only when installMode is set to extract.
40 This is set to the location you want to extract your system to,
41 and should already be mounted properly.
43 # installInteractive=(yes or no)
45 Set if the installer is running in interactive mode, and
46 is able to prompt for input from the user, defaults to no
49 ########################################################################
51 ########################################################################
53 # netDev=(AUTO-DHCP or <nic>)
55 netDev specifies what type of networking to enable for the installer
56 Can be set to AUTO-DHCP or to a network interface, such as et0
58 When set to AUTO-DHCP, pc-sysinstall will probe for all network devices
59 and attempt to set DHCP mode on each, until a working network connection
62 If netDev= is set to a network interface such as et0, the following options
63 will need to be set in order to enable the interface
65 # netIP=(IP address such as 192.168.0.100)
67 Set netIP to an address that you wish to have the interface specified in
69 Only used when netDev is not set to AUTO-DHCP
71 # netMask=(Netmask such as 255.255.255.0)
73 Set netMask to the address you with to have the interface specified in
75 Only used when netDev is not set to AUTO-DHCP
78 # netNameServer=(DNS Server such as 192.168.0.1)
80 Set netNameServer to the DNS address you want to use during the install
81 Only used when netDev is not set to AUTO-DHCP
84 # netDefaultRouter=(192.168.0.1)
86 Set netDefaultRouter to the gateway you wish to have the installer use
87 Only used when netDev is not set to AUTO-DHCP
91 # netSaveDev=(AUTO-DHCP or network interface)
93 netSaveDev specifies what networking to enable on the installed system
95 When set to AUTO-DHCP, pc-sysinstall will probe all network interfaces, and
96 set them all to DHCP in the systems /etc/rc.conf file. Wireless devices will also
97 have the corresponding wlan[0-9] device created.
99 When set to a network interface, pc-sysinstall will set the target device with
100 the settings specified by the variables below.
102 # netSaveIP=192.168.0.49
103 # netSaveMask=255.255.255.0
104 # netSaveNameServer=208.67.222.222
105 # netSaveDefaultRouter=192.168.0.1
110 ########################################################################
111 # DISK SLICE SETTINGS
112 ########################################################################
114 The following section specifies the target disk(s) to be used in the
117 # disk0=(disk device, such as ad0)
119 The diskX= variable should be set to the target device for this drive, such
121 The first should begin with disk0=, and additional drives to disk1=, disk2
122 if additional disks are to be setup.
124 When doing an upgrade, the disk0= line should be set to the root device or
125 root zpool of the target system to update. I.E:
130 # partition=(all, free, s1, s1, s3, s4, image)
132 After setting disk[0-9], the partition= variable is used to specify which target
133 partition we will be working with for this device.
135 Setting this to "all" will setup the disk with a single FreeBSD slice as "s1"
137 Setting this to "free" will allow pc-sysinstall to search for the first available
138 primary slice with free space, and create the slice.
140 Setting this to "s1, s2, s3 or s4" will use the specified MBR slice.
142 Setting this to "image" will use an image to configure the disk.
144 (This tag is unused for upgrades)
146 # partscheme=(MBR/GPT)
148 When performing a "full" disk (partition=all), the partscheme= variable is used
149 to determine the partition scheme type gpart will be using on the disk. Valid
150 choices are MBR or GPT.
152 # mirror=(disk device such as ad1)
154 Setting the mirror= variable will setup the target device as a gmirror
155 of the diskX= device. The mirror device must be the same size or larger
156 than the drive being mirrored.
159 # mirrorbal=(load, prefer, round-robin, split)
161 Allows the setting of the mirror balance method to be used, if not
162 specified this defaults to "round-robin"
164 # bootManager=(none, bsd)
166 Setting this option will instruct pc-sysinstall to install the BSD boot Manager,
169 # image=(/path/to/image/file) (/mountpoint)
171 Setting this option will instruct pc-sysinstall to write the image file
172 specified by the path to the disk.
176 This command must be placed at the end of the diskX= section, before starting
177 the listing of any additional diskX= directives.
180 ########################################################################
181 # DISK PARTITION / MOUNT SETTINGS
182 ########################################################################
184 The following settings specify the partitioning / mount points to setup
185 on the target partition
187 # disk0-part=UFS+S 500 / (-n -o time)
188 # disk0-part=SWAP 2000 none
189 # disk0-part=UFS.eli 500 /usr
191 # disk0-part=UFS+J 500 /tmp
192 # disk0-part=ZFS 0 /data,/storage (mirror: ad1)
195 The above values instructs pc-sysinstall which partitions / mounts
196 to create on the target drive / slice, specified by "disk0".
197 (disk0 will resolve to the drive / slice specified in the previous section)
199 The notation is as follows:
200 <File System Type> <Size> <Mountpoint>
202 Available FileSystems:
203 UFS - Standard UFS2 FileSystem
204 UFS+S - UFS2 + Softupdates enabled
205 UFS+SUJ - UFS2 + Soft Updates + Journaling enabled
206 UFS+J - UFS2 + Journaling through gjournal
207 ZFS - Z File System, pools / mounts created automatically
208 SWAP - BSD Swap space partition, mountpoint should be set to "none"
210 Adding the ".eli" extension to any of the above file systems
211 will enable disk encryption via geli
212 (UFS.eli, UFS+S.eli, UFS+SUJ.eli, UFS+J.eli, ZFS.eli, SWAP.eli)
214 If you with to use a passphrase with this encrypted partition, on the next line
215 the flag "encpass=" should be entered:
218 All sizes are expressed in MegaBytes
219 Specifying a size 0 instructs pc-sysinstall to use the rest of the
220 available slice size, and should only be used for the last partition / mount
222 When using "UFS" and its various types, it is possible to specify custom options
223 for newfs using (). For examplei:
224 disk0-part=UFS+SUJ 1000 / (-o time)
225 In this case "-o time" would be passed to newfs when creating the "/" filesystem.
228 When using "ZFS" specifically, it is possible to specify additional disks / partitions
229 to include in the zpool. By using the syntax: (mirror: ad1,ad2) or (raidz: ad1,ad2), it is possible
230 to include the disk "ad1" into the zpool for this partition, using the raidz / mirror methods.
231 If you with to just include the disk into the pool in "basic" mode, then use (ad1,ad2) with no flags
233 ########################################################################
234 # INSTALL OPTIONS / SOURCES
235 ########################################################################
237 The following settings specify the type, locations and sources
238 for this installation
240 # installMedium=(dvd, usb, ftp, rsync, image)
242 Set installMedium= to the source type we will be using for this install.
245 dvd - Search for and mount the DVD which contains the install archive
246 local - Pull files directly from a local directory
247 usb - Search for and mount the USB drive which contains the install archive
248 ftp - The install archive will be fetched from a FTP / HTTP server before install
249 rsync - Pull the system data from a ssh + rsync server, specified with variables below
250 image - Install system from an image
252 # localPath=/usr/freebsd-dist
254 Location of the directory we will be pulling installation files from
256 # installType=(PCBSD, FreeBSD)
258 Set the type of system we are installing, PCBSD or FreeBSD
260 # installFile=fbsd-release.tbz
262 The installer archive, if not using the defaults specified in conf/pc-sysinstall.conf
264 # packageType=(tar, uzip, split, dist)
266 The archive type we are extracting from when using dvd, usb or ftp
268 # distFiles=base src kernel
270 List of dist files to install when packageType=dist
272 # ftpPath=ftp://ftp.pcbsd.org/pub/8.0/netinstall
274 Location of the installer archive when using a installMedium=ftp
276 # rsyncPath=life-preserver/back-2009-11-12T14_53_14
278 The location of the rsync data on the remote server when using installMedium=rsync
280 # rsyncUser=rsyncuser
282 The username to use for the ssh server running rsync
284 # rsyncHost=192.168.0.50
286 The rsync / ssh server we wish to connect to
290 The port to use when connecting to a ssh + rsync server
292 # installComponents=amarok,firefox,ports
294 The specified components to install, view available with "./pc-sysinstall list-components"
297 ########################################################################
299 ########################################################################
301 Options specific to performing an upgrade
303 # upgradeKeepDesktopProfile=(yes/no)
305 This option allows you to specify if you wish to keep your existing users desktop
306 profile data. The default is NO, and your existing profile will be moved to
307 .kde4.preUpgrade automatically.
309 ########################################################################
311 ########################################################################
313 Options for setting up usernames and passwords on the installed system
317 Set the root password of the installed system to the specified plaintext string
319 # rootEncPass=<encryptedstring>
321 Set the root password of the installed system to the specified encrypted string
323 The below variables are used to setup a user on the installed system
324 Be sure to call commitUser after after adding these values, and before
325 starting another user block
328 # userComment=Kris Moore
331 # userEncPass=<encryptedstring>
333 # userHome=/home/kris
334 # userGroups=wheel,operator
337 ########################################################################
339 ########################################################################
341 The following variables can be set to run commands post-installation,
342 allowing the user to further tweak / modify the system
346 Run the specified command within chroot of the installed system
350 runScript will copy the specified script into FSMNT, and run it in chroot of the system
351 Useful when you have a 3rd party script on the DVD / USB, and you want to copy it into
352 the installed system and run
356 runExtCommand is used when you wish to run a command outside the chroot
357 The variable $FSMNT is set to the mount-point of your installed system
360 ########################################################################
361 # PC-BSD SPECIFIC OPTIONS
362 ########################################################################
364 Options for time-zones and NTP on the installed system
368 timeZone can be set to the zone file in /usr/share/zoneinfo/ that is to be used
369 example: America/New_York
371 # enableNTP= (yes / no)
373 set enableNTP to yes or no to enable or disable the NTP service on the system
376 ########################################################################
377 # PC-BSD SPECIFC OPTIONS
378 ########################################################################
380 Options specific to installing PC-BSD, such as localization, and KDE settings
384 localizeLang will set the system console and Desktop to the target language
386 # localizeKeyLayout=en
388 localizeKeyLayout updates the system's xorg config to set the keyboard layout
390 # localizeKeyModel=pc104
392 localizeKeyModel updates the system's xorg config to set the keyboard model
394 # localizeKeyVariant=intl
396 localizeKeyVariant is used to update the xorg config to set the keyboard variant
400 Setting autoLoginUser will enable the specified user to log into the desktop
401 automatically without entering a password