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
| 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)
| 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
| 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
| 127Setting this to "s1, s2, s3 or s4" will use the specified MBR slice.
|
128
| 128
|
| 129Setting this to "image" will use an image to configure the disk.
130
|
129(This tag is unused for upgrades)
130
131# partscheme=(MBR/GPT)
132
133When performing a "full" disk (partition=all), the partscheme= variable is used
134to determine the partition scheme type gpart will be using on the disk. Valid
135choices are MBR or GPT.
136
137# mirror=(disk device such as ad1)
138
139Setting the mirror= variable will setup the target device as a gmirror
140of the diskX= device. The mirror device must be the same size or larger
141than the drive being mirrored.
142
143
144# mirrorbal=(load, prefer, round-robin, split)
145
146Allows the setting of the mirror balance method to be used, if not
147specified this defaults to "round-robin"
148
149# bootManager=(none, bsd)
150
151Setting this option will instruct pc-sysinstall to install the BSD boot Manager,
152or leave it empty
153
| 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
|
154# commitDiskPart
155
156This command must be placed at the end of the diskX= section, before starting
157the listing of any additional diskX= directives.
158
159
160########################################################################
161# DISK PARTITION / MOUNT SETTINGS
162########################################################################
163
164The following settings specify the partitioning / mount points to setup
165on the target partition
166
167# disk0-part=UFS+S 500 /
168# disk0-part=SWAP 2000 none
169# disk0-part=UFS.eli 500 /usr
170# encpass=mypass
171# disk0-part=UFS+J 500 /tmp
172# disk0-part=ZFS 0 /data,/storage (mirror: ad1)
173# commitDiskLabel
174
175The above values instructs pc-sysinstall which partitions / mounts
176to create on the target drive / slice, specified by "disk0".
177(disk0 will resolve to the drive / slice specified in the previous section)
178
179The notation is as follows:
180<File System Type> <Size> <Mountpoint>
181
182Available FileSystems:
183 UFS - Standard UFS2 FileSystem
184UFS+S - UFS2 + Softupdates enabled
185UFS+J - UFS2 + Journaling through gjournal
186 ZFS - Z File System, pools / mounts created automatically
187 SWAP - BSD Swap space partition, mountpoint should be set to "none"
188
189Adding the ".eli" extension to any of the above file systems
190will enable disk encryption via geli
191(UFS.eli, UFS+S.eli, UFS+J.eli, ZFS.eli, SWAP.eli)
192
193If you with to use a passphrase with this encrypted partition, on the next line
194the flag "encpass=" should be entered:
195encpass=mypass
196
197All sizes are expressed in MegaBytes
198Specifying a size 0 instructs pc-sysinstall to use the rest of the
199available slice size, and should only be used for the last partition / mount
200
201When using "ZFS" specifically, it is possible to specify additional disks / partitions
202to include in the zpool. By using the syntax: (mirror: ad1,ad2) or (raidz: ad1,ad2), it is possible
203to include the disk "ad1" into the zpool for this partition, using the raidz / mirror methods.
204If you with to just include the disk into the pool in "basic" mode, then use (ad1,ad2) with no flags
205
206########################################################################
207# INSTALL OPTIONS / SOURCES
208########################################################################
209
210The following settings specify the type, locations and sources
211for this installation
212
213# installMedium=(dvd, usb, ftp, rsync)
214
215Set installMedium= to the source type we will be using for this install.
216
217Available Types:
218 dvd - Search for and mount the DVD which contains the install archive
219 usb - Search for and mount the USB drive which contains the install archive
220 ftp - The install archive will be fetched from a FTP / HTTP server before install
221rsync - Pull the system data from a ssh + rsync server, specified with variables below
222
223# installType=(PCBSD, FreeBSD)
224
225Set the type of system we are installing, PCBSD or FreeBSD
226
227# installFile=fbsd-release.tbz
228
229The installer archive, if not using the defaults specified in conf/pc-sysinstall.conf
230
231# packageType=(tar, uzip, split)
232
233The archive type we are extracting from when using dvd, usb or ftp
234
235# ftpPath=ftp://ftp.pcbsd.org/pub/8.0/netinstall
236
237Location of the installer archive when using a installMedium=ftp
238
239# rsyncPath=life-preserver/back-2009-11-12T14_53_14
240
241The location of the rsync data on the remote server when using installMedium=rsync
242
243# rsyncUser=rsyncuser
244
245The username to use for the ssh server running rsync
246
247# rsyncHost=192.168.0.50
248
249The rsync / ssh server we wish to connect to
250
251# rsyncPort=22
252
253The port to use when connecting to a ssh + rsync server
254
255# installComponents=amarok,firefox,ports
256
257The specified components to install, view available with "./pc-sysinstall list-components"
258
259
260########################################################################
261# UPGRADE OPTIONS
262########################################################################
263
264Options specific to performing an upgrade
265
266# upgradeKeepDesktopProfile=(yes/no)
267
268This option allows you to specify if you wish to keep your existing users desktop
269profile data. The default is NO, and your existing profile will be moved to
270.kde4.preUpgrade automatically.
271
272########################################################################
273# USER OPTIONS
274########################################################################
275
276Options for setting up usernames and passwords on the installed system
277
278# rootPass=root
279
280Set the root password of the installed system to the specified string
281
282The below variables are used to setup a user on the installed system
283Be sure to call commitUser after after adding these values, and before
284starting another user block
285
286# userName=kris
287# userComment=Kris Moore
288# userPass=mypass
289# userShell=/bin/csh
290# userHome=/home/kris
291# userGroups=wheel,operator
292# commitUser
293
294########################################################################
295# RUN COMMANDS
296########################################################################
297
298The following variables can be set to run commands post-installation,
299allowing the user to further tweak / modify the system
300
301# runCommand=
302
303Run the specified command within chroot of the installed system
304
305# runScript=
306
307runScript will copy the specified script into FSMNT, and run it in chroot of the system
308Usefull when you have a 3rd party script on the DVD / USB, and you want to copy it into
309the installed system and run
310
311# runExtCommand=
312
313runExtCommand is used when you wish to run a command outside the chroot
314The variable $FSMNT is set to the mount-point of your installed system
315
316
317########################################################################
318# PC-BSD SPECIFC OPTIONS
319########################################################################
320
321Options for time-zones and NTP on the installed system
322
323# timeZone=
324
325timeZone can be set to the zone file in /usr/share/zoneinfo/ that is to be used
326example: America/New_York
327
328# enableNTP= (yes / no)
329
330set enableNTP to yes or no to enable or disable the NTP service on the system
331
332
333########################################################################
334# PC-BSD SPECIFC OPTIONS
335########################################################################
336
337Options specific to installing PC-BSD, such as localization, and KDE settings
338
339# localizeLang=en
340
341localizeLang will set the system console and Desktop to the target language
342
343# localizeKeyLayout=en
344
345localizeKeyLayout updates the system's xorg config to set the keyboard layout
346
347# localizeKeyModel=pc104
348
349localizeKeyModel updates the system's xorg config to set the keyboard model
350
351# localizeKeyVariant=intl
352
353localizeKeyVariant is used to update the xorg config to set the keyboard variant
354
355# autoLoginUser=kris
356
357Setting autoLoginUser will enable the specified user to log into the desktop
358automatically without entering a password
359
| 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+J - UFS2 + Journaling through gjournal
193 ZFS - Z File System, pools / mounts created automatically
194 SWAP - BSD Swap space partition, mountpoint should be set to "none"
195
196Adding the ".eli" extension to any of the above file systems
197will enable disk encryption via geli
198(UFS.eli, UFS+S.eli, UFS+J.eli, ZFS.eli, SWAP.eli)
199
200If you with to use a passphrase with this encrypted partition, on the next line
201the flag "encpass=" should be entered:
202encpass=mypass
203
204All sizes are expressed in MegaBytes
205Specifying a size 0 instructs pc-sysinstall to use the rest of the
206available slice size, and should only be used for the last partition / mount
207
208When using "ZFS" specifically, it is possible to specify additional disks / partitions
209to include in the zpool. By using the syntax: (mirror: ad1,ad2) or (raidz: ad1,ad2), it is possible
210to include the disk "ad1" into the zpool for this partition, using the raidz / mirror methods.
211If you with to just include the disk into the pool in "basic" mode, then use (ad1,ad2) with no flags
212
213########################################################################
214# INSTALL OPTIONS / SOURCES
215########################################################################
216
217The following settings specify the type, locations and sources
218for this installation
219
220# installMedium=(dvd, usb, ftp, rsync)
221
222Set installMedium= to the source type we will be using for this install.
223
224Available Types:
225 dvd - Search for and mount the DVD which contains the install archive
226 usb - Search for and mount the USB drive which contains the install archive
227 ftp - The install archive will be fetched from a FTP / HTTP server before install
228rsync - Pull the system data from a ssh + rsync server, specified with variables below
229
230# installType=(PCBSD, FreeBSD)
231
232Set the type of system we are installing, PCBSD or FreeBSD
233
234# installFile=fbsd-release.tbz
235
236The installer archive, if not using the defaults specified in conf/pc-sysinstall.conf
237
238# packageType=(tar, uzip, split)
239
240The archive type we are extracting from when using dvd, usb or ftp
241
242# ftpPath=ftp://ftp.pcbsd.org/pub/8.0/netinstall
243
244Location of the installer archive when using a installMedium=ftp
245
246# rsyncPath=life-preserver/back-2009-11-12T14_53_14
247
248The location of the rsync data on the remote server when using installMedium=rsync
249
250# rsyncUser=rsyncuser
251
252The username to use for the ssh server running rsync
253
254# rsyncHost=192.168.0.50
255
256The rsync / ssh server we wish to connect to
257
258# rsyncPort=22
259
260The port to use when connecting to a ssh + rsync server
261
262# installComponents=amarok,firefox,ports
263
264The specified components to install, view available with "./pc-sysinstall list-components"
265
266
267########################################################################
268# UPGRADE OPTIONS
269########################################################################
270
271Options specific to performing an upgrade
272
273# upgradeKeepDesktopProfile=(yes/no)
274
275This option allows you to specify if you wish to keep your existing users desktop
276profile data. The default is NO, and your existing profile will be moved to
277.kde4.preUpgrade automatically.
278
279########################################################################
280# USER OPTIONS
281########################################################################
282
283Options for setting up usernames and passwords on the installed system
284
285# rootPass=root
286
287Set the root password of the installed system to the specified string
288
289The below variables are used to setup a user on the installed system
290Be sure to call commitUser after after adding these values, and before
291starting another user block
292
293# userName=kris
294# userComment=Kris Moore
295# userPass=mypass
296# userShell=/bin/csh
297# userHome=/home/kris
298# userGroups=wheel,operator
299# commitUser
300
301########################################################################
302# RUN COMMANDS
303########################################################################
304
305The following variables can be set to run commands post-installation,
306allowing the user to further tweak / modify the system
307
308# runCommand=
309
310Run the specified command within chroot of the installed system
311
312# runScript=
313
314runScript will copy the specified script into FSMNT, and run it in chroot of the system
315Usefull when you have a 3rd party script on the DVD / USB, and you want to copy it into
316the installed system and run
317
318# runExtCommand=
319
320runExtCommand is used when you wish to run a command outside the chroot
321The variable $FSMNT is set to the mount-point of your installed system
322
323
324########################################################################
325# PC-BSD SPECIFC OPTIONS
326########################################################################
327
328Options for time-zones and NTP on the installed system
329
330# timeZone=
331
332timeZone can be set to the zone file in /usr/share/zoneinfo/ that is to be used
333example: America/New_York
334
335# enableNTP= (yes / no)
336
337set enableNTP to yes or no to enable or disable the NTP service on the system
338
339
340########################################################################
341# PC-BSD SPECIFC OPTIONS
342########################################################################
343
344Options specific to installing PC-BSD, such as localization, and KDE settings
345
346# localizeLang=en
347
348localizeLang will set the system console and Desktop to the target language
349
350# localizeKeyLayout=en
351
352localizeKeyLayout updates the system's xorg config to set the keyboard layout
353
354# localizeKeyModel=pc104
355
356localizeKeyModel updates the system's xorg config to set the keyboard model
357
358# localizeKeyVariant=intl
359
360localizeKeyVariant is used to update the xorg config to set the keyboard variant
361
362# autoLoginUser=kris
363
364Setting autoLoginUser will enable the specified user to log into the desktop
365automatically without entering a password
366
|
360$FreeBSD: head/usr.sbin/pc-sysinstall/examples/README 211490 2010-08-19 06:11:06Z imp $
| 367$FreeBSD: head/usr.sbin/pc-sysinstall/examples/README 212337 2010-09-08 20:10:24Z imp $
|
| |