1pc-sysinstall README
2
3This file documents many of the variables used in pc-sysinstall
4config scripts
5#################################################################
6
7# hostname=
8
9Using hostname= will set the specified hostname on the
10installed system
11
12When hostname= is not present, pc-sysinstall will auto-generate
13a hostname such as freebsd-XXXX or pcbsd-XXXX
14
15# installMode=(fresh or upgrade)
16
17Set the type of install we are doing, fresh or upgrade.
18
19Fresh installs will format and mount the target disks before
20extracting the install images to the system. Using this mode
21it is also possible to do a system restore, by specifying a
22full system backup as the install source.
23
24Upgrades will mount the target disk, and extract the system
25archive to the disk, overwriting files on the disk.
26The conf/exclude-from-upgrade file can be used to specify
27additional files to exclude from overwriting during the
28install process.
29
30# installInteractive=(yes or no)
31
32Set if the installer is running in interactive mode, and
33is able to prompt for input from the user, defaults to no
34
35
36########################################################################
37# NETWORK SETTINGS
38########################################################################
39
40# netDev=(AUTO-DHCP or <nic>)
41
42netDev specifies what type of networking to enable for the installer
43Can be set to AUTO-DHCP or to a network interface, such as et0
44
45When set to AUTO-DHCP, pc-sysinstall will probe for all network devices
46and attempt to set DHCP mode on each, until a working network connection
47is established
48
49If netDev= is set to a network interface such as et0, the following options
50will need to be set in order to enable the interface
51
52# netIP=(IP address such as 192.168.0.100)
53
54 Set netIP to an address that you wish to have the interface specified in
55 netDev set to
56 Only used when netDev is not set to AUTO-DHCP
57
58# netMask=(Netmask such as 255.255.255.0)
59
60Set netMask to the address you with to have the interface specified in
61netDev set to
62Only used when netDev is not set to AUTO-DHCP
63
64
65# netNameServer=(DNS Server such as 192.168.0.1)
66
67Set netNameServer to the DNS address you want to use during the install
68Only used when netDev is not set to AUTO-DHCP
69
70
71# netDefaultRouter=(192.168.0.1)
72
73Set netDefaultRouter to the gateway you wish to have the installer use
74Only used when netDev is not set to AUTO-DHCP
75
76
77
78# netSaveDev=(AUTO-DHCP or network interface)
79
80netSaveDev specifies what networking to enable on the installed system
81
82When set to AUTO-DHCP, pc-sysinstall will probe all network interfaces, and
83set them all to DHCP in the systems /etc/rc.conf file. Wireless devices will also
84have the corresponding wlan[0-9] device created.
85
86When set to a network interface, pc-sysinstall will set the target device with
87the settings specified by the variables below.
88
89# netSaveIP=192.168.0.49
90# netSaveMask=255.255.255.0
91# netSaveNameServer=208.67.222.222
92# netSaveDefaultRouter=192.168.0.1
93
94
95
96
97########################################################################
98# DISK SLICE SETTINGS
99########################################################################
100
101The following section specifies the target disk(s) to be used in the
102install or upgrade.
103
104# disk0=(disk device, such as ad0)
105
106The diskX= variable should be set to the target device for this drive, such
107as ad0, da0
108The first should begin with disk0=, and additional drives to disk1=, disk2
109if additional disks are to be setup.
110
111When doing an upgrade, the disk0= line should be set to the root device or
112root zpool of the target system to update. I.E:
113 # disk0=tank0
114 # disk0=ada0s1a
115
116
117# partition=(all, free, s1, s1, s3, s4, image)
118
119After setting disk[0-9], the partition= variable is used to specify which target
120partition we will be working with for this device.
121
122Setting this to "all" will setup the disk with a single FreeBSD slice as "s1"
123
124Setting this to "free" will allow pc-sysinstall to search for the first available
125primary slice with free space, and create the slice.
126
127Setting this to "s1, s2, s3 or s4" will use the specified MBR slice.
128
129Setting this to "image" will use an image to configure the disk.
130
131(This tag is unused for upgrades)
132
133# partscheme=(MBR/GPT)
134
135When performing a "full" disk (partition=all), the partscheme= variable is used
136to determine the partition scheme type gpart will be using on the disk. Valid
137choices are MBR or GPT.
138
139# mirror=(disk device such as ad1)
140
141Setting the mirror= variable will setup the target device as a gmirror
142of the diskX= device. The mirror device must be the same size or larger
143than the drive being mirrored.
144
145
146# mirrorbal=(load, prefer, round-robin, split)
147
148Allows the setting of the mirror balance method to be used, if not
149specified this defaults to "round-robin"
150
151# bootManager=(none, bsd)
152
153Setting this option will instruct pc-sysinstall to install the BSD boot Manager,
154or leave it empty
155
156# image=(/path/to/image/file)
157
158Setting this option will instruct pc-sysinstall to write the image file
159specified by the path to the disk.
160
161# commitDiskPart
162
163This command must be placed at the end of the diskX= section, before starting
164the listing of any additional diskX= directives.
165
166
167########################################################################
168# DISK PARTITION / MOUNT SETTINGS
169########################################################################
170
171The following settings specify the partitioning / mount points to setup
172on the target partition
173
174# disk0-part=UFS+S 500 /
175# disk0-part=SWAP 2000 none
176# disk0-part=UFS.eli 500 /usr
177# encpass=mypass
178# disk0-part=UFS+J 500 /tmp
179# disk0-part=ZFS 0 /data,/storage (mirror: ad1)
180# commitDiskLabel
181
182The above values instructs pc-sysinstall which partitions / mounts
183to create on the target drive / slice, specified by "disk0".
184(disk0 will resolve to the drive / slice specified in the previous section)
185
186The notation is as follows:
187<File System Type> <Size> <Mountpoint>
188
189Available FileSystems:
190  UFS - Standard UFS2 FileSystem
191UFS+S - UFS2 + Softupdates enabled
192UFS+SUJ - UFS2 + Soft Updates + Journaling enabled
193UFS+J - UFS2 + Journaling through gjournal
194  ZFS - Z File System, pools / mounts created automatically
195 SWAP - BSD Swap space partition, mountpoint should be set to "none"
196
197Adding the ".eli" extension to any of the above file systems
198will enable disk encryption via geli
199(UFS.eli, UFS+S.eli, UFS+SUJ.eli, UFS+J.eli, ZFS.eli, SWAP.eli)
200
201If you with to use a passphrase with this encrypted partition, on the next line
202the flag "encpass=" should be entered:
203encpass=mypass
204
205All sizes are expressed in MegaBytes
206Specifying a size 0 instructs pc-sysinstall to use the rest of the
207available slice size, and should only be used for the last partition / mount
208
209When using "ZFS" specifically, it is possible to specify additional disks / partitions
210to include in the zpool. By using the syntax: (mirror: ad1,ad2) or (raidz: ad1,ad2), it is possible
211to include the disk "ad1" into the zpool for this partition, using the raidz / mirror methods.
212If you with to just include the disk into the pool in "basic" mode, then use (ad1,ad2) with no flags
213
214########################################################################
215# INSTALL OPTIONS / SOURCES
216########################################################################
217
218The following settings specify the type, locations and sources
219for this installation
220
221# installMedium=(dvd, usb, ftp, rsync)
222
223Set installMedium= to the source type we will be using for this install.
224
225Available Types:
226  dvd - Search for and mount the DVD which contains the install archive
227  usb - Search for and mount the USB drive which contains the install archive
228  ftp - The install archive will be fetched from a FTP / HTTP server before install
229rsync - Pull the system data from a ssh + rsync server, specified with variables below
230
231# installType=(PCBSD, FreeBSD)
232
233Set the type of system we are installing, PCBSD or FreeBSD
234
235# installFile=fbsd-release.tbz
236
237The installer archive, if not using the defaults specified in conf/pc-sysinstall.conf
238
239# packageType=(tar, uzip, split)
240
241The archive type we are extracting from when using dvd, usb or ftp
242
243# ftpPath=ftp://ftp.pcbsd.org/pub/8.0/netinstall
244
245Location of the installer archive when using a installMedium=ftp
246
247# rsyncPath=life-preserver/back-2009-11-12T14_53_14
248
249The location of the rsync data on the remote server when using installMedium=rsync
250
251# rsyncUser=rsyncuser
252
253The username to use for the ssh server running rsync
254
255# rsyncHost=192.168.0.50
256
257The rsync / ssh server we wish to connect to
258
259# rsyncPort=22
260
261The port to use when connecting to a ssh + rsync server
262
263# installComponents=amarok,firefox,ports
264
265The specified components to install, view available with "./pc-sysinstall list-components"
266
267
268########################################################################
269# UPGRADE OPTIONS
270########################################################################
271
272Options specific to performing an upgrade
273
274# upgradeKeepDesktopProfile=(yes/no)
275
276This option allows you to specify if you wish to keep your existing users desktop
277profile data. The default is NO, and your existing profile will be moved to
278.kde4.preUpgrade automatically.
279
280########################################################################
281# USER OPTIONS
282########################################################################
283
284Options for setting up usernames and passwords on the installed system
285
286# rootPass=root
287
288Set the root password of the installed system to the specified string
289
290The below variables are used to setup a user on the installed system
291Be sure to call commitUser after after adding these values, and before
292starting another user block
293
294# userName=kris
295# userComment=Kris Moore
296# userPass=mypass
297# userShell=/bin/csh
298# userHome=/home/kris
299# userGroups=wheel,operator
300# commitUser
301
302########################################################################
303# RUN COMMANDS
304########################################################################
305
306The following variables can be set to run commands post-installation,
307allowing the user to further tweak / modify the system
308
309# runCommand=
310
311Run the specified command within chroot of the installed system
312
313# runScript=
314
315runScript will copy the specified script into FSMNT, and run it in chroot of the system
316Usefull when you have a 3rd party script on the DVD / USB, and you want to copy it into
317the installed system and run
318
319# runExtCommand=
320
321runExtCommand is used when you wish to run a command outside the chroot
322The variable $FSMNT is set to the mount-point of your installed system
323
324
325########################################################################
326# PC-BSD SPECIFC OPTIONS
327########################################################################
328
329Options for time-zones and NTP on the installed system
330
331# timeZone=
332
333timeZone can be set to the zone file in /usr/share/zoneinfo/ that is to be used
334example: America/New_York
335
336# enableNTP= (yes / no)
337
338set enableNTP to yes or no to enable or disable the NTP service on the system
339
340
341########################################################################
342# PC-BSD SPECIFC OPTIONS
343########################################################################
344
345Options specific to installing PC-BSD, such as localization, and KDE settings
346
347# localizeLang=en
348
349localizeLang will set the system console and Desktop to the target language
350
351# localizeKeyLayout=en
352
353localizeKeyLayout updates the system's xorg config to set the keyboard layout
354
355# localizeKeyModel=pc104
356
357localizeKeyModel updates the system's xorg config to set the keyboard model
358
359# localizeKeyVariant=intl
360
361localizeKeyVariant is used to update the xorg config to set the keyboard variant
362
363# autoLoginUser=kris
364
365Setting autoLoginUser will enable the specified user to log into the desktop
366automatically without entering a password
367
368$FreeBSD$
369