source: src-sh/pc-sysinstall/examples/README

Last change on this file was 6963fbe, checked in by Kris Moore <kris@…>, 12 months ago

Update pc-sysinstall README with more details about new flags

  • Property mode set to 100644
File size: 13.8 KB
Line 
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/upgrade/extract/zfsrestore)
16
17Set the type of install we are doing.
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
30Extract will skip any disk setup, and perform an installation
31to the directory specified by "installLocation=". This location
32should be a directory with your pre-mounted file-systems ready
33for file extraction. When using the "extract" option, /etc/fstab
34on the installed system will *not* be automatically configured.
35
36'zfsrestore' will use zfs send / recv to replicate a remote ZFS
37dataset to your local install. It requires several other flags
38documented below in the ZFS RESTORE section.
39
40# installLocation=
41
42Used only when installMode is set to extract.
43
44This is set to the location you want to extract your system to,
45and should already be mounted properly.
46
47# installInteractive=(yes or no)
48
49Set if the installer is running in interactive mode, and
50is able to prompt for input from the user, defaults to no
51
52
53########################################################################
54# NETWORK SETTINGS
55########################################################################
56
57# netDev=(AUTO-DHCP or <nic>)
58
59netDev specifies what type of networking to enable for the installer
60Can be set to AUTO-DHCP or to a network interface, such as et0
61
62When set to AUTO-DHCP, pc-sysinstall will probe for all network devices
63and attempt to set DHCP mode on each, until a working network connection
64is established
65
66If netDev= is set to a network interface such as et0, the following options
67will need to be set in order to enable the interface
68
69# netIP=(IP address such as 192.168.0.100)
70
71 Set netIP to an address that you wish to have the interface specified in
72 netDev set to
73 Only used when netDev is not set to AUTO-DHCP
74
75# netMask=(Netmask such as 255.255.255.0)
76
77Set netMask to the address you with to have the interface specified in
78netDev set to
79Only used when netDev is not set to AUTO-DHCP
80
81 
82# netNameServer=(DNS Server such as 192.168.0.1)
83
84Set netNameServer to the DNS address you want to use during the install
85Only used when netDev is not set to AUTO-DHCP
86
87
88# netDefaultRouter=(192.168.0.1)
89
90Set netDefaultRouter to the gateway you wish to have the installer use
91Only used when netDev is not set to AUTO-DHCP
92
93
94
95# netSaveDev=(AUTO-DHCP or network interface)
96
97netSaveDev specifies what networking to enable on the installed system
98
99When set to AUTO-DHCP, pc-sysinstall will probe all network interfaces, and
100set them all to DHCP in the systems /etc/rc.conf file. Wireless devices will also
101have the corresponding wlan[0-9] device created.
102
103When set to a network interface, pc-sysinstall will set the target device with
104the settings specified by the variables below.
105
106# netSaveIP=192.168.0.49
107# netSaveMask=255.255.255.0
108# netSaveNameServer=208.67.222.222
109# netSaveDefaultRouter=192.168.0.1
110
111
112
113
114########################################################################
115# DISK SLICE SETTINGS
116########################################################################
117
118The following section specifies the target disk(s) to be used in the
119install or upgrade.
120
121# disk0=(disk device, such as ad0)
122
123The diskX= variable should be set to the target device for this drive, such
124as ad0, da0
125The first should begin with disk0=, and additional drives to disk1=, disk2
126if additional disks are to be setup.
127
128When doing an upgrade, the disk0= line should be set to the root device or
129root zpool of the target system to update. I.E:
130 # disk0=tank0
131 # disk0=ada0s1a
132
133
134# partition=(all, free, s1, s1, s3, s4, image)
135
136After setting disk[0-9], the partition= variable is used to specify which target
137partition we will be working with for this device.
138
139Setting this to "all" will setup the disk with a single FreeBSD slice as "s1"
140
141Setting this to "free" will allow pc-sysinstall to search for the first available
142primary slice with free space, and create the slice.
143
144Setting this to "s1, s2, s3 or s4" will use the specified MBR slice.
145
146Setting this to "image" will use an image to configure the disk.
147
148(This tag is unused for upgrades)
149
150# partscheme=(MBR/GPT)
151
152When performing a "full" disk (partition=all), the partscheme= variable is used
153to determine the partition scheme type gpart will be using on the disk. Valid
154choices are MBR or GPT.
155
156# mirror=(disk device such as ad1)
157
158Setting the mirror= variable will setup the target device as a gmirror
159of the diskX= device. The mirror device must be the same size or larger
160than the drive being mirrored.
161 
162
163# mirrorbal=(load, prefer, round-robin, split)
164
165Allows the setting of the mirror balance method to be used, if not
166specified this defaults to "round-robin"
167
168# bootManager=(none, bsd, GRUB)
169
170Setting this option will instruct pc-sysinstall to install the BSD boot Manager,
171GRUB boot-manager, or leave it empty
172
173# image=(/path/to/image/file) (/mountpoint)
174
175Setting this option will instruct pc-sysinstall to write the image file
176specified by the path to the disk.
177
178# commitDiskPart
179
180This command must be placed at the end of the diskX= section, before starting
181the listing of any additional diskX= directives.
182
183
184########################################################################
185# DISK PARTITION / MOUNT SETTINGS
186########################################################################
187
188The following settings specify the partitioning / mount points to setup
189on the target partition
190
191# disk0-part=UFS+S 500 / (-n -o time)
192# disk0-part=SWAP 2000 none
193# disk0-part=UFS.eli 500 /usr
194# encpass=mypass
195# disk0-part=UFS+J 500 /tmp
196# disk0-part=ZFS 0 /data,/storage (mirror: ad1)
197# commitDiskLabel
198
199The above values instructs pc-sysinstall which partitions / mounts
200to create on the target drive / slice, specified by "disk0".
201(disk0 will resolve to the drive / slice specified in the previous section)
202
203The notation is as follows:
204<File System Type> <Size> <Mountpoint>
205
206Available FileSystems:
207  UFS - Standard UFS2 FileSystem
208UFS+S - UFS2 + Softupdates enabled
209UFS+SUJ - UFS2 + Soft Updates + Journaling enabled
210UFS+J - UFS2 + Journaling through gjournal
211  ZFS - Z File System, pools / mounts created automatically
212 SWAP - BSD Swap space partition, mountpoint should be set to "none"
213
214Adding the ".eli" extension to any of the above file systems
215will enable disk encryption via geli
216(UFS.eli, UFS+S.eli, UFS+SUJ.eli, UFS+J.eli, ZFS.eli, SWAP.eli)
217
218If you with to use a passphrase with this encrypted partition, on the next line
219the flag "encpass=" should be entered:
220encpass=mypass
221
222All sizes are expressed in MegaBytes
223Specifying a size 0 instructs pc-sysinstall to use the rest of the
224available slice size, and should only be used for the last partition / mount
225
226When using "UFS" and its various types, it is possible to specify custom options
227for newfs using (). For examplei:
228disk0-part=UFS+SUJ 1000 / (-o time)
229In this case "-o time" would be passed to newfs when creating the "/" filesystem.
230
231
232When using "ZFS" specifically, it is possible to specify additional disks / partitions
233to include in the zpool. By using the syntax: (mirror: ad1,ad2) or (raidz: ad1,ad2), it is possible
234to include the disk "ad1" into the zpool for this partition, using the raidz / mirror methods.
235If you with to just include the disk into the pool in "basic" mode, then use (ad1,ad2) with no flags
236
237########################################################################
238# INSTALL OPTIONS / SOURCES
239########################################################################
240
241The following settings specify the type, locations and sources
242for this installation
243
244# installMedium=(dvd, usb, ftp, rsync, image)
245
246Set installMedium= to the source type we will be using for this install.
247
248Available Types:
249  dvd - Search for and mount the DVD which contains the install archive
250local - Pull files directly from a local directory
251  usb - Search for and mount the USB drive which contains the install archive
252  ftp - The install archive will be fetched from a FTP / HTTP server before install
253rsync - Pull the system data from a ssh + rsync server, specified with variables below
254image - Install system from an image
255
256# localPath=/usr/freebsd-dist
257
258Location of the directory we will be pulling installation files from
259
260# installType=(PCBSD, FreeBSD)
261
262Set the type of system we are installing, PCBSD or FreeBSD
263
264# installFile=fbsd-release.tbz
265
266The installer archive, if not using the defaults specified in conf/pc-sysinstall.conf
267
268# packageType=(tar, uzip, split, dist)
269
270The archive type we are extracting from when using dvd, usb or ftp
271
272# distFiles=base src kernel
273
274List of dist files to install when packageType=dist
275
276# ftpPath=ftp://ftp.pcbsd.org/pub/8.0/netinstall
277
278Location of the installer archive when using a installMedium=ftp
279
280# rsyncPath=life-preserver/back-2009-11-12T14_53_14
281
282The location of the rsync data on the remote server when using installMedium=rsync
283
284# rsyncUser=rsyncuser
285
286The username to use for the ssh server running rsync
287
288# rsyncHost=192.168.0.50
289
290The rsync / ssh server we wish to connect to
291
292# rsyncPort=22
293
294The port to use when connecting to a ssh + rsync server
295
296# installComponents=amarok,firefox,ports
297
298The specified components to install, view available with "./pc-sysinstall list-components"
299
300# installPackages=xorg cabextract
301
302List of packages to install, can be either pkgng or old style packages
303
304# pkgExt=.txz
305
306Set the file-extension uses for packages, usually .txz or .tbz
307
308########################################################################
309# UPGRADE OPTIONS
310########################################################################
311
312Options specific to performing an upgrade
313
314# upgradeKeepDesktopProfile=(yes/no)
315
316This option allows you to specify if you wish to keep your existing users desktop
317profile data. The default is NO, and your existing profile will be moved to
318.kde4.preUpgrade automatically.
319
320########################################################################
321# USER OPTIONS
322########################################################################
323
324Options for setting up usernames and passwords on the installed system
325
326# rootPass=root
327
328Set the root password of the installed system to the specified plaintext string
329
330# rootEncPass=<encryptedstring>
331
332Set the root password of the installed system to the specified encrypted string
333
334The below variables are used to setup a user on the installed system
335Be sure to call commitUser after after adding these values, and before
336starting another user block
337
338# userName=kris
339# userComment=Kris Moore
340# userPass=mypass
341or
342# userEncPass=<encryptedstring>
343# userShell=/bin/csh
344# userHome=/home/kris
345# userGroups=wheel,operator
346# commitUser
347
348########################################################################
349# RUN COMMANDS
350########################################################################
351
352The following variables can be set to run commands post-installation,
353allowing the user to further tweak / modify the system
354
355# runCommand=
356
357Run the specified command within chroot of the installed system
358
359# runScript=
360
361runScript will copy the specified script into FSMNT, and run it in chroot of the system
362Useful when you have a 3rd party script on the DVD / USB, and you want to copy it into
363the installed system and run
364
365# runExtCommand=
366
367runExtCommand is used when you wish to run a command outside the chroot
368The variable $FSMNT is set to the mount-point of your installed system
369
370
371########################################################################
372# PC-BSD SPECIFIC OPTIONS
373########################################################################
374
375Options for time-zones and NTP on the installed system
376
377# timeZone=
378
379timeZone can be set to the zone file in /usr/share/zoneinfo/ that is to be used
380example: America/New_York
381
382# enableNTP= (yes / no)
383
384set enableNTP to yes or no to enable or disable the NTP service on the system
385
386
387########################################################################
388# PC-BSD SPECIFC OPTIONS
389########################################################################
390
391Options specific to installing PC-BSD, such as localization, and KDE settings
392
393# localizeLang=en
394
395localizeLang will set the system console and Desktop to the target language
396
397# localizeKeyLayout=en
398
399localizeKeyLayout updates the system's xorg config to set the keyboard layout
400
401# localizeKeyModel=pc104
402
403localizeKeyModel updates the system's xorg config to set the keyboard model
404
405# localizeKeyVariant=intl
406
407localizeKeyVariant is used to update the xorg config to set the keyboard variant
408
409# autoLoginUser=kris
410
411Setting autoLoginUser will enable the specified user to log into the desktop
412automatically without entering a password
413
414########################################################################
415# ZFS RESTORE
416########################################################################
417
418When setting installMode=zfsrestore, the following options are also required
419
420# sshHost=mybackupserver
421
422Hostname or IP address of the machine to pull data via SSH from
423
424# sshPort=22
425
426Port to use for SSH
427
428# sshUser=kdeskbackup
429
430Username to log into SSH with
431
432# sshKey=/root/id_rsa
433
434SSH key file to use with auth into the remote server
435
436# zfsProps=.lp-props-tank1#backups#krisbackup
437
438Location of dataset properties file, usually created by "Life-Preserver" during replication
439
440# zfsRemoteDataset=tank1/backups/krisbackup
441
442Location of remote dataset we will be restoring from
443
Note: See TracBrowser for help on using the repository browser.