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