Difference between revisions of "Creating an Automated Installation with pc-sysinstall/9.2"

From PC-BSD Wiki
Jump to: navigation, search
(Determine Which Variables you Wish to Customize)
(15 intermediate revisions by 2 users not shown)
Line 22: Line 22:
  
 
To create a custom installation, perform the following steps:
 
To create a custom installation, perform the following steps:
 +
 
# [[#Determine which variables you wish to customize|Determine which variables you wish to customize]].<br>
 
# [[#Determine which variables you wish to customize|Determine which variables you wish to customize]].<br>
 
# [[#Create a customized configuration|Create a customized configuration]].<br>
 
# [[#Create a customized configuration|Create a customized configuration]].<br>
# [[#Create a custom installation media|Create a custom installation media or Installation Server]].<br>
+
# [[#Create a custom installation media|Create a custom installation media]].<br>
 +
 
 
These steps are discussed in more detail below.
 
These steps are discussed in more detail below.
  
 
== Determine Which Variables you Wish to Customize ==
 
== Determine Which Variables you Wish to Customize ==
  
A list of possible variables can be found in ''/usr/share/examples/pc-sysinstall/README'' and in Table 5.4a. Note that the Table is meant as a quick reference to determine which variables are available. The ''README'' file contains more complete descriptions for each variable. These are assigned their values by using an equal sign (=).
+
A list of possible variables can be found in ''/usr/share/examples/pc-sysinstall/README'' and in Table 5.5a. Note that the Table is meant as a quick reference to determine which variables are available. The ''README'' file contains more complete descriptions for each variable.  
  
'''Table 5.4a: Available Variables for Customizing a PC-BSD® Installation'''
+
'''Table 5.5a: Available Variables for Customizing a PC-BSD® Installation'''
  
 
{{tbl-init}}
 
{{tbl-init}}
Line 38: Line 40:
 
{{tbl-title|Description}}
 
{{tbl-title|Description}}
 
|-
 
|-
{{tbl-cell|row=1|content=hostname}}
+
{{tbl-cell|row=1|content=hostname=}}
 
{{tbl-cell|row=1|should be unique for the network}}
 
{{tbl-cell|row=1|should be unique for the network}}
 
{{tbl-cell|row=1|optional as installer will auto-generate a hostname if empty}}
 
{{tbl-cell|row=1|optional as installer will auto-generate a hostname if empty}}
 
|-
 
|-
{{tbl-cell|row=2|content=installMode}}
+
{{tbl-cell|row=2|content=installMode=}}
 
{{tbl-cell|row=2|fresh, upgrade, or extract}}
 
{{tbl-cell|row=2|fresh, upgrade, or extract}}
 
{{tbl-cell|row=2|sets the installation type}}
 
{{tbl-cell|row=2|sets the installation type}}
 
|-
 
|-
{{tbl-cell|row=3|content=installLocation}}
+
{{tbl-cell|row=3|content=installLocation=}}
 
{{tbl-cell|row=3|/path/to/location}}
 
{{tbl-cell|row=3|/path/to/location}}
 
{{tbl-cell|row=3|used only when installMode is extract and should point to an already mounted location}}
 
{{tbl-cell|row=3|used only when installMode is extract and should point to an already mounted location}}
 
|-
 
|-
{{tbl-cell|row=4|content=installInteractive}}
+
{{tbl-cell|row=4|content=installInteractive=}}
 
{{tbl-cell|row=4|yes or no}}
 
{{tbl-cell|row=4|yes or no}}
 
{{tbl-cell|row=4|set to no for automated installs without user input}}
 
{{tbl-cell|row=4|set to no for automated installs without user input}}
 
|-
 
|-
{{tbl-cell|row=5|content=netDev}}
+
{{tbl-cell|row=5|content=netDev=}}
 
{{tbl-cell|row=5|AUTO-DHCP or FreeBSD interface name}}
 
{{tbl-cell|row=5|AUTO-DHCP or FreeBSD interface name}}
 
{{tbl-cell|row=5|type of network connection to use during the installation}}
 
{{tbl-cell|row=5|type of network connection to use during the installation}}
 
|-
 
|-
{{tbl-cell|row=6|content=netIP|other=padding-left: 24px;}}
+
{{tbl-cell|row=6|content=netIP=|other=padding-left: 24px;}}
 
{{tbl-cell|row=6|IP address of interface used during installation}}
 
{{tbl-cell|row=6|IP address of interface used during installation}}
 
{{tbl-cell|row=6|content=only use if ''netDev'' is set to an interface name}}
 
{{tbl-cell|row=6|content=only use if ''netDev'' is set to an interface name}}
 
|-
 
|-
{{tbl-cell|row=7|content=netMask|other=padding-left: 24px;}}
+
{{tbl-cell|row=7|content=netMask=|other=padding-left: 24px;}}
 
{{tbl-cell|row=7|subnet mask of interface}}
 
{{tbl-cell|row=7|subnet mask of interface}}
 
{{tbl-cell|row=7|content=only use if netDev is set to an interface name}}
 
{{tbl-cell|row=7|content=only use if netDev is set to an interface name}}
 
|-
 
|-
{{tbl-cell|row=8|content=netNameServer|other=padding-left: 24px;}}
+
{{tbl-cell|row=8|content=netNameServer=|other=padding-left: 24px;}}
 
{{tbl-cell|row=8|IP address of DNS server}}
 
{{tbl-cell|row=8|IP address of DNS server}}
 
{{tbl-cell|row=8|content=only use if netDev is set to an interface name}}
 
{{tbl-cell|row=8|content=only use if netDev is set to an interface name}}
 
|-
 
|-
{{tbl-cell|row=9|content=netDefaultRouter|other=padding-left: 24px;}}
+
{{tbl-cell|row=9|content=netDefaultRouter=|other=padding-left: 24px;}}
 
{{tbl-cell|row=9|IP address of default gateway}}
 
{{tbl-cell|row=9|IP address of default gateway}}
 
{{tbl-cell|row=9|content=only use if netDev is set to an interface name}}
 
{{tbl-cell|row=9|content=only use if netDev is set to an interface name}}
 
|-
 
|-
{{tbl-cell|row=10|content=netSaveDev}}
+
{{tbl-cell|row=10|content=netSaveDev=}}
 
{{tbl-cell|row=10|AUTO-DHCP or FreeBSD interface name(s) (multiple allowed separated by spaces)}}
 
{{tbl-cell|row=10|AUTO-DHCP or FreeBSD interface name(s) (multiple allowed separated by spaces)}}
 
{{tbl-cell|row=10|content=type of network configuration to enable on the installed system; can set multiple interfaces}}
 
{{tbl-cell|row=10|content=type of network configuration to enable on the installed system; can set multiple interfaces}}
 
|-
 
|-
{{tbl-cell|row=11|content=netSaveIP_''interface name''|other=padding-left: 24px;}}
+
{{tbl-cell|row=11|content=netSaveIP=|other=padding-left: 24px;}}
 
{{tbl-cell|row=11|IP address of interface ''<interface_name>'' or DHCP}}
 
{{tbl-cell|row=11|IP address of interface ''<interface_name>'' or DHCP}}
 
{{tbl-cell|row=11|content=only use if netSaveDev is set to an interface name or a list of interface names (repeat for each interface)}}
 
{{tbl-cell|row=11|content=only use if netSaveDev is set to an interface name or a list of interface names (repeat for each interface)}}
 
|-
 
|-
{{tbl-cell|row=12|content=netSaveMask_''<interface_name>''=}}
+
{{tbl-cell|row=12|content=netSaveMask=}}
 
{{tbl-cell|row=12|subnet mask of interface ''<interface_name>''}}
 
{{tbl-cell|row=12|subnet mask of interface ''<interface_name>''}}
 
{{tbl-cell|row=12|content=only use if netSaveDev is set to an interface name or a list of interface names (repeat for each interface)}}
 
{{tbl-cell|row=12|content=only use if netSaveDev is set to an interface name or a list of interface names (repeat for each interface)}}
Line 126: Line 128:
 
{{tbl-cell|row=22|content=this variable is mandatory and must be placed at the end of each diskX= section; create a diskX= section for each disk you wish to configure. }}
 
{{tbl-cell|row=22|content=this variable is mandatory and must be placed at the end of each diskX= section; create a diskX= section for each disk you wish to configure. }}
 
|-
 
|-
{{tbl-cell|row=23|content=commitDiskLabel}}
+
{{tbl-cell|row=23|content=encpass=}}
{{tbl-cell|row=23|content=}}
+
{{tbl-cell|row=23|content=password value}}
{{tbl-cell|row=23|content=this variable is mandatory and must be placed at the end of disk's partitioning settings; see the ''README'' for examples on how to set the <File System Type> <Size> <Mountpoint> entries for each disk}}
+
{{tbl-cell|row=23|content=at boot time, system will prompt for this password in order to mount the associated GELI encrypted partition}}
 
|-
 
|-
{{tbl-cell|row=24|content=installMedium=}}
+
{{tbl-cell|row=24|content=commitDiskLabel}}
{{tbl-cell|row=24|content=dvd, usb, ftp, rsync, image}}
+
{{tbl-cell|row=24|content=}}
{{tbl-cell|row=24|content=source to be used for installation}}
+
{{tbl-cell|row=24|content=this variable is mandatory and must be placed at the end of disk's partitioning settings; see the ''README'' for examples on how to set the <File System Type> <Size> <Mountpoint> entries for each disk}}
 
|-
 
|-
{{tbl-cell|row=25|content=installType=}}
+
{{tbl-cell|row=25|content=installMedium=}}
{{tbl-cell|row=25|content=PCBSD, FreeBSD}}
+
{{tbl-cell|row=25|content=dvd, local, usb, ftp, rsync, image}}
{{tbl-cell|row=25|content=determines whether this is a desktop or a server install}}
+
{{tbl-cell|row=25|content=source to be used for installation}}
 
|-
 
|-
{{tbl-cell|row=26|content=installFile=}}
+
{{tbl-cell|row=26|content=localPath=}}
{{tbl-cell|row=26|content=e.g. fbsd-release.tbz}}
+
{{tbl-cell|row=26|content=e.g. usr/freebsd-dist}}
{{tbl-cell|row=26|content=only set if using a customized installer archive}}
+
{{tbl-cell|row=26|content=location of the directory containing the installation files when using installMedium=local}}
 
|-
 
|-
{{tbl-cell|row=27|content=packageType=}}
+
{{tbl-cell|row=27|content=installType=}}
{{tbl-cell|row=27|content=tar, uzip, split, dist}}
+
{{tbl-cell|row=27|content=PCBSD, FreeBSD}}
{{tbl-cell|row=27|content=the archive type on the installation media}}
+
{{tbl-cell|row=27|content=determines whether this is a desktop or a server install}}
 
|-
 
|-
{{tbl-cell|row=28|content=ftpPath=}}
+
{{tbl-cell|row=28|content=installFile=}}
{{tbl-cell|row=28|content=e.g. <nowiki>ftp://ftp.pcbsd.org/pub/mirror/9.1/amd64/netinstall/</nowiki>}}
+
{{tbl-cell|row=28|content=e.g. fbsd-release.tbz}}
{{tbl-cell|row=28|content=location of the installer archive when using installMedium=ftp}}
+
{{tbl-cell|row=28|content=only set if using a customized installer archive}}
 
|-
 
|-
{{tbl-cell|row=29|content=rsyncPath=}}
+
{{tbl-cell|row=29|content=packageType=}}
{{tbl-cell|row=29|content=e.g. life-preserver/back-2011-09-12T14_53_14}}
+
{{tbl-cell|row=29|content=tar, uzip, split, dist}}
{{tbl-cell|row=29|content=location of the rsync data on the remote server when using installMedium=rsync}}
+
{{tbl-cell|row=29|content=the archive type on the installation media}}
 
|-
 
|-
{{tbl-cell|row=30|content=rsyncUser=}}
+
{{tbl-cell|row=30|content=ftpPath=}}
{{tbl-cell|row=30|content=username}}
+
{{tbl-cell|row=30|content=e.g. <nowiki>ftp://ftp.pcbsd.org/pub/mirror/9.1/amd64/netinstall/</nowiki>}}
{{tbl-cell|row=30|content=set when using installMedium=rsync}}
+
{{tbl-cell|row=30|content=location of the installer archive when using installMedium=ftp}}
 
|-
 
|-
{{tbl-cell|row=31|content=rsyncHost=}}
+
{{tbl-cell|row=31|content=rsyncPath=}}
{{tbl-cell|row=31|content=IP address of rsync server}}
+
{{tbl-cell|row=31|content=e.g. life-preserver/back-2011-09-12T14_53_14}}
{{tbl-cell|row=31|content=set when using installMedium=rsync}}
+
{{tbl-cell|row=31|content=location of the rsync data on the remote server when using installMedium=rsync}}
 
|-
 
|-
{{tbl-cell|row=32|content=rsyncPort=}}
+
{{tbl-cell|row=32|content=rsyncUser=}}
{{tbl-cell|row=32|content=port number}}
+
{{tbl-cell|row=32|content=username}}
 
{{tbl-cell|row=32|content=set when using installMedium=rsync}}
 
{{tbl-cell|row=32|content=set when using installMedium=rsync}}
 
|-
 
|-
{{tbl-cell|row=33|content=installComponents=}}
+
{{tbl-cell|row=33|content=rsyncHost=}}
{{tbl-cell|row=33|content=e.g. amarok,firefox,ports}}
+
{{tbl-cell|row=33|content=IP address of rsync server}}
{{tbl-cell|row=33|content=components must exist in ''/PCBSD/pc-sysinstall/components/''}}
+
{{tbl-cell|row=33|content=set when using installMedium=rsync}}
 
|-
 
|-
{{tbl-cell|row=34|content=upgradeKeepDesktopProfile=}}
+
{{tbl-cell|row=34|content=rsyncPort=}}
{{tbl-cell|row=34|content=yes or no}}
+
{{tbl-cell|row=34|content=port number}}
{{tbl-cell|row=34|content=specify if you wish to keep your existing user's desktop profile data during an upgrade }}
+
{{tbl-cell|row=34|content=set when using installMedium=rsync}}
 
|-
 
|-
{{tbl-cell|row=35|content=rootPass=}}
+
{{tbl-cell|row=35|content=installComponents=}}
{{tbl-cell|row=35|content=password}}
+
{{tbl-cell|row=35|content=e.g. amarok,firefox,ports}}
{{tbl-cell|row=35|content=set the root password of the installed system to the specified string}}
+
{{tbl-cell|row=35|content=components must exist in ''/PCBSD/pc-sysinstall/components/''}}
 
|-
 
|-
{{tbl-cell|row=36|content=rootEncPass=}}
+
{{tbl-cell|row=36|content=upgradeKeepDesktopProfile=}}
{{tbl-cell|row=36|content=encrypted string}}
+
{{tbl-cell|row=36|content=yes or no}}
{{tbl-cell|row=36|content=set root password to specified encrypted string}}
+
{{tbl-cell|row=36|content=specify if you wish to keep your existing user's desktop profile data during an upgrade }}
 
|-
 
|-
{{tbl-cell|row=37|content=userName=}}
+
{{tbl-cell|row=37|content=rootPass=}}
{{tbl-cell|row=37|content=case sensitive value}}
+
{{tbl-cell|row=37|content=password}}
{{tbl-cell|row=37|content=create a separate block of user values for each user you wish to create}}
+
{{tbl-cell|row=37|content=set the root password of the installed system to the specified string}}
 
|-
 
|-
{{tbl-cell|row=38|content=userComment=}}
+
{{tbl-cell|row=38|content=rootEncPass=}}
{{tbl-cell|row=38|content=description}}
+
{{tbl-cell|row=38|content=encrypted string}}
{{tbl-cell|row=38|content=description text can include spaces}}
+
{{tbl-cell|row=38|content=set root password to specified encrypted string}}
 
|-
 
|-
{{tbl-cell|row=39|content=userPass=}}
+
{{tbl-cell|row=39|content=userName=}}
 
{{tbl-cell|row=39|content=case sensitive value}}
 
{{tbl-cell|row=39|content=case sensitive value}}
{{tbl-cell|row=39|content=password of user}}
+
{{tbl-cell|row=39|content=create a separate block of user values for each user you wish to create}}
 
|-
 
|-
{{tbl-cell|row=40|content=userEncPass}}
+
{{tbl-cell|row=40|content=userComment=}}
{{tbl-cell|row=40|content=encrypted string}}
+
{{tbl-cell|row=40|content=description}}
{{tbl-cell|row=40|content=set user password to specified encrypted string}}
+
{{tbl-cell|row=40|content=description text can include spaces}}
 
|-
 
|-
{{tbl-cell|row=41|content=userShell=}}
+
{{tbl-cell|row=41|content=userPass=}}
{{tbl-cell|row=41|content=e.g. ''/bin/csh''}}
+
{{tbl-cell|row=41|content=case sensitive value}}
{{tbl-cell|row=41|content=path to default shell}}
+
{{tbl-cell|row=41|content=password of user}}
 
|-
 
|-
{{tbl-cell|row=42|content=userHome=}}
+
{{tbl-cell|row=42|content=userEncPass}}
{{tbl-cell|row=42|content=e.g. ''/home/username''}}
+
{{tbl-cell|row=42|content=encrypted string}}
{{tbl-cell|row=42|content=path to home directory}}
+
{{tbl-cell|row=42|content=set user password to specified encrypted string}}
 
|-
 
|-
{{tbl-cell|row=43|content=userGroups=}}
+
{{tbl-cell|row=43|content=userShell=}}
{{tbl-cell|row=43|content=e.g. wheel,operator}}
+
{{tbl-cell|row=43|content=e.g. ''/bin/csh''}}
{{tbl-cell|row=43|content=comma separated (no spaces) list of groups}}
+
{{tbl-cell|row=43|content=path to default shell}}
 
|-
 
|-
{{tbl-cell|row=44|content=commitUser}}
+
{{tbl-cell|row=44|content=userHome=}}
{{tbl-cell|row=44|content=}}
+
{{tbl-cell|row=44|content=e.g. ''/home/username''}}
{{tbl-cell|row=44|content=mandatory, must be last line in each user block}}
+
{{tbl-cell|row=44|content=path to home directory}}
 
|-
 
|-
{{tbl-cell|row=45|content=runCommand=}}
+
{{tbl-cell|row=45|content=userGroups=}}
{{tbl-cell|row=45|content=path to command}}
+
{{tbl-cell|row=45|content=e.g. wheel,operator}}
{{tbl-cell|row=45|content=run the specified command within chroot of the installed system, after the installation is complete}}
+
{{tbl-cell|row=45|content=comma separated (no spaces) list of groups}}
 
|-
 
|-
{{tbl-cell|row=46|content=runScript=}}
+
{{tbl-cell|row=46|content=commitUser}}
{{tbl-cell|row=46|content=path to script}}
+
{{tbl-cell|row=46|content=}}
{{tbl-cell|row=46|content=runs specified script within chroot of the installed system, after the installation is complete}}
+
{{tbl-cell|row=46|content=mandatory, must be last line in each user block}}
 
|-
 
|-
{{tbl-cell|row=47|content=runExtCommand=}}
+
{{tbl-cell|row=47|content=runCommand=}}
 
{{tbl-cell|row=47|content=path to command}}
 
{{tbl-cell|row=47|content=path to command}}
{{tbl-cell|row=47|content=runs a command outside the chroot}}
+
{{tbl-cell|row=47|content=run the specified command within chroot of the installed system, after the installation is complete}}
 
|-
 
|-
{{tbl-cell|row=48|content=timeZone=}}
+
{{tbl-cell|row=48|content=runScript=}}
{{tbl-cell|row=48|content=e.g. America/New_York}}
+
{{tbl-cell|row=48|content=path to script}}
{{tbl-cell|row=48|content=location must exist in ''/usr/share/zoneinfo/''}}
+
{{tbl-cell|row=48|content=runs specified script within chroot of the installed system, after the installation is complete}}
 
|-
 
|-
{{tbl-cell|row=49|content=enableNTP=}}
+
{{tbl-cell|row=49|content=runExtCommand=}}
{{tbl-cell|row=49|content=yes or no}}
+
{{tbl-cell|row=49|content=path to command}}
{{tbl-cell|row=49|content=enable/disable NTP}}
+
{{tbl-cell|row=49|content=runs a command outside the chroot}}
 
|-
 
|-
{{tbl-cell|row=50|content=localizeLang=}}
+
{{tbl-cell|row=50|content=timeZone=}}
{{tbl-cell|row=50|content=e.g. en}}
+
{{tbl-cell|row=50|content=e.g. America/New_York}}
{{tbl-cell|row=50|content=sets the system console and Desktop to the target language}}
+
{{tbl-cell|row=50|content=location must exist in ''/usr/share/zoneinfo/''}}
 
|-
 
|-
{{tbl-cell|row=51|content=localizeKeyLayout=}}
+
{{tbl-cell|row=51|content=enableNTP=}}
{{tbl-cell|row=51|content=e.g. en}}
+
{{tbl-cell|row=51|content=yes or no}}
{{tbl-cell|row=51|content=updates the system's Xorg config to set the keyboard layout}}
+
{{tbl-cell|row=51|content=enable/disable NTP}}
 
|-
 
|-
{{tbl-cell|row=52|content=localizeKeyModel=}}
+
{{tbl-cell|row=52|content=localizeLang=}}
{{tbl-cell|row=52|content=e.g. pc104}}
+
{{tbl-cell|row=52|content=e.g. en}}
{{tbl-cell|row=52|content=updates the system's Xorg config to set the keyboard model}}
+
{{tbl-cell|row=52|content=sets the system console and Desktop to the target language}}
 
|-
 
|-
{{tbl-cell|row=53|content=localizeKeyVariant=}}
+
{{tbl-cell|row=53|content=localizeKeyLayout=}}
{{tbl-cell|row=53|content=e.g. intl}}
+
{{tbl-cell|row=53|content=e.g. en}}
{{tbl-cell|row=53|content=updates the Xorg config to set the keyboard variant}}
+
{{tbl-cell|row=53|content=updates the system's Xorg config to set the keyboard layout}}
 
|-
 
|-
{{tbl-cell|row=54|content=autoLoginUser=}}
+
{{tbl-cell|row=54|content=localizeKeyModel=}}
{{tbl-cell|row=54|content=username}}
+
{{tbl-cell|row=54|content=e.g. pc104}}
{{tbl-cell|row=54|content=user will be logged in automatically without entering a password}}
+
{{tbl-cell|row=54|content=updates the system's Xorg config to set the keyboard model}}
 +
|-
 +
{{tbl-cell|row=55|content=localizeKeyVariant=}}
 +
{{tbl-cell|row=55|content=e.g. intl}}
 +
{{tbl-cell|row=55|content=updates the Xorg config to set the keyboard variant}}
 +
|-
 +
{{tbl-cell|row=56|content=autoLoginUser=}}
 +
{{tbl-cell|row=56|content=username}}
 +
{{tbl-cell|row=56|content=user will be logged in automatically without entering a password}}
 
|}
 
|}
  
Line 396: Line 406:
 
|}
 
|}
  
Here is a ample ''pc-autoinstall.conf'' file:
+
Here is a sample ''pc-autoinstall.conf'' file:
  
 
  <nowiki>
 
  <nowiki>
Line 477: Line 487:
 
  '''cp -R /mnt/* /tmp/custominstall/'''
 
  '''cp -R /mnt/* /tmp/custominstall/'''
 
  '''umount /mnt'''
 
  '''umount /mnt'''
 
'''NOTE:''' if you are using an HTTP, FTP, or SSH server as the installation media, untar or copy the files to a directory on the server that is accessible to users. Be sure to configure the server so that the installation files are accessible to the systems that you wish to install.
 
  
 
If you are creating an automated installation, copy your customized ''pc-autoinstall.conf'' to ''/tmp/custominstall/boot/''.
 
If you are creating an automated installation, copy your customized ''pc-autoinstall.conf'' to ''/tmp/custominstall/boot/''.
Line 507: Line 515:
 
To begin a fully automated installation, insert the installation media and reboot.
 
To begin a fully automated installation, insert the installation media and reboot.
  
In a PXE boot environment, '''cp''' your ''pc-sysinstall.conf'' file to ''/boot/'' on the [[Thin_Client#Creating_a_PXE_Boot_Install_Server | PXE Boot Install Server]]. Then, setup a call in ''/etc/rc.local'' that runs this command:
+
If you are using an HTTP, FTP, or SSH server as the installation media, untar or copy the required files to a directory on the server that is accessible to users. Be sure to configure the server so that the installation files are accessible to the systems that you wish to install. If you are using a PXE Boot Install server, follow the instructions at [[Thin_Client#Connecting_to_and_Customizing_the_PXE_Boot_Install_Server|Connecting to and Customizing the PXE Boot Install Server]].
+
'''pc-sysinstall start-autoinstall /boot/pc-autoinstall.conf'''
+
+
That will start the installation process, fetch your main configuration file, and perform the actual installation.
+
  
 
<noinclude>{{refheading}}</noinclude>
 
<noinclude>{{refheading}}</noinclude>

Revision as of 09:00, 4 December 2012

(Sorry for the inconvenience)

Contents

PC-BSD® provides a set of Bourne shell scripts that allow advanced users to create automatic or customized PC-BSD® installations. pc-sysinstall is the name of the master script; it reads a customizable configuration file and uses dozens of backend scripts to perform the installation. You can read more about this utility by typing man pc-sysinstall.

Here is a quick overview of the components used by pc-sysinstall:

  • /usr/share/pc-sysinstall/backend/ contains the scripts used by the PC-BSD® installer. Scripts have been divided by function, such as functions-bsdlabel.sh and functions-installcomponents.sh. If you have ever wondered how the PC-BSD® installer works, read through these scripts. This directory also contains the parseconfig.sh and startautoinstall.sh scripts which pc-sysinstall uses to parse the configuration file and begin the installation.
  • /usr/share/pc-sysinstall/backend-partmanager/ contains the scripts which are used by the installer to create and delete partitions.
  • /usr/share/pc-sysinstall/backend-query/ contains the scripts which are used by the installer to detect (e.g. detect-nics.sh) and configure (e.g. enable-net.sh) hardware.
  • /usr/share/pc-sysinstall/components/ contains FreeBSD ports and src and the PBIs for chromium, firefox, opera, and thunderbird.
  • /usr/share/pc-sysinstall/conf/ contains the configuration file pc-sysinstall.conf. It also contains a file indicating which localizations are available (avail-langs), a list of files which are not touched during an upgrade (exclude-from-upgrade), and a license/ subdirectory containing text files of applicable licenses (e.g. bsd-en.txt and nvidia-en.txt).
  • /usr/share/pc-sysinstall/doc/ contains the help text that is seen if you run pc-sysinstall without any arguments.
  • /usr/share/examples/pc-sysinstall/ contains several example configuration files for different scenarios (e.g. upgrade, fbsd-netinstall). The README file in this directory should be considered as mandatory reading before using pc-sysinstall.
  • /usr/sbin/pc-sysinstall this is the script that is used to perform a customized installation.

To create a custom installation, perform the following steps:

  1. Determine which variables you wish to customize.
  2. Create a customized configuration.
  3. Create a custom installation media.

These steps are discussed in more detail below.

Determine Which Variables you Wish to Customize

A list of possible variables can be found in /usr/share/examples/pc-sysinstall/README and in Table 5.5a. Note that the Table is meant as a quick reference to determine which variables are available. The README file contains more complete descriptions for each variable.

Table 5.5a: Available Variables for Customizing a PC-BSD® Installation

Variable Options Description
hostname=


should be unique for the network


optional as installer will auto-generate a hostname if empty
installMode=


fresh, upgrade, or extract


sets the installation type
installLocation=


/path/to/location


used only when installMode is extract and should point to an already mounted location
installInteractive=


yes or no


set to no for automated installs without user input
netDev=


AUTO-DHCP or FreeBSD interface name


type of network connection to use during the installation
netIP=


IP address of interface used during installation


only use if netDev is set to an interface name
netMask=


subnet mask of interface


only use if netDev is set to an interface name
netNameServer=


IP address of DNS server


only use if netDev is set to an interface name
netDefaultRouter=


IP address of default gateway


only use if netDev is set to an interface name
netSaveDev=


AUTO-DHCP or FreeBSD interface name(s) (multiple allowed separated by spaces)


type of network configuration to enable on the installed system; can set multiple interfaces
netSaveIP=


IP address of interface <interface_name> or DHCP


only use if netSaveDev is set to an interface name or a list of interface names (repeat for each interface)
netSaveMask=


subnet mask of interface <interface_name>


only use if netSaveDev is set to an interface name or a list of interface names (repeat for each interface)
netSaveNameServer=


IP address of DNS server (multiple allowed separated by spaces)


only use if netSaveDev= is set to an interface name or a list of interface names (do not repeat for each interface)
netSaveDefaultRouter=


IP address of default gateway


only use if netSaveDev= is set to an interface name or a list of interface names (do not repeat for each interface)
disk0=


FreeBSD disk device Name, (e.g. ad0)


see README for examples
partition=


all, free, s1, s2, s3, s4, image


see README for examples
partscheme=


MBR or GPT


partition scheme type
mirror=


FreeBSD disk device name (e.g. ad1)


sets the target disk for the mirror (i.e. the second disk)
mirrorbal=


load, prefer, round-robin, split


defaults to round-robin if the mirror balance method is not specified
bootManager=


none, bsd


whether or not to install the FreeBSD boot manager
image=


/path/to/image


will write specified image file
commitDiskPart



this variable is mandatory and must be placed at the end of each diskX= section; create a diskX= section for each disk you wish to configure.
encpass=


password value


at boot time, system will prompt for this password in order to mount the associated GELI encrypted partition
commitDiskLabel



this variable is mandatory and must be placed at the end of disk's partitioning settings; see the README for examples on how to set the <File System Type> <Size> <Mountpoint> entries for each disk
installMedium=


dvd, local, usb, ftp, rsync, image


source to be used for installation
localPath=


e.g. usr/freebsd-dist


location of the directory containing the installation files when using installMedium=local
installType=


PCBSD, FreeBSD


determines whether this is a desktop or a server install
installFile=


e.g. fbsd-release.tbz


only set if using a customized installer archive
packageType=


tar, uzip, split, dist


the archive type on the installation media
ftpPath=


e.g. ftp://ftp.pcbsd.org/pub/mirror/9.1/amd64/netinstall/


location of the installer archive when using installMedium=ftp
rsyncPath=


e.g. life-preserver/back-2011-09-12T14_53_14


location of the rsync data on the remote server when using installMedium=rsync
rsyncUser=


username


set when using installMedium=rsync
rsyncHost=


IP address of rsync server


set when using installMedium=rsync
rsyncPort=


port number


set when using installMedium=rsync
installComponents=


e.g. amarok,firefox,ports


components must exist in /PCBSD/pc-sysinstall/components/
upgradeKeepDesktopProfile=


yes or no


specify if you wish to keep your existing user's desktop profile data during an upgrade
rootPass=


password


set the root password of the installed system to the specified string
rootEncPass=


encrypted string


set root password to specified encrypted string
userName=


case sensitive value


create a separate block of user values for each user you wish to create
userComment=


description


description text can include spaces
userPass=


case sensitive value


password of user
userEncPass


encrypted string


set user password to specified encrypted string
userShell=


e.g. /bin/csh


path to default shell
userHome=


e.g. /home/username


path to home directory
userGroups=


e.g. wheel,operator


comma separated (no spaces) list of groups
commitUser



mandatory, must be last line in each user block
runCommand=


path to command


run the specified command within chroot of the installed system, after the installation is complete
runScript=


path to script


runs specified script within chroot of the installed system, after the installation is complete
runExtCommand=


path to command


runs a command outside the chroot
timeZone=


e.g. America/New_York


location must exist in /usr/share/zoneinfo/
enableNTP=


yes or no


enable/disable NTP
localizeLang=


e.g. en


sets the system console and Desktop to the target language
localizeKeyLayout=


e.g. en


updates the system's Xorg config to set the keyboard layout
localizeKeyModel=


e.g. pc104


updates the system's Xorg config to set the keyboard model
localizeKeyVariant=


e.g. intl


updates the Xorg config to set the keyboard variant
autoLoginUser=


username


user will be logged in automatically without entering a password

Create a Customized Configuration

One way to create this file is to read through the configuration examples in /usr/share/examples/pc-sysinstall/ to find the one that most closely matches your needs. Copy that file (to any location) and customize it so that it includes the variables and values you would like to use in your installation.

An alternate way to create this file is to perform an installation of the version that you wish to customize. The installer will automatically create a file containing the settings you selected during the installation to /root/pc-sysinstall.cfg. You can use that configuration file as-is, or customize it to meet an installation's needs. This method may prove easier to use if you are performing complex disk layouts.

Here is a sample configuration:

# Sample configuration file for an installation using pc-sysinstall

installMode=fresh
installInteractive=no
hostname=myhost.mydomain.com

# Set the disk parameters - 1st disk
disk0=da0
partition=all
bootManager=none
commitDiskPart

# Set the disk parameters - 2nd disk
disk1=da1
partition=all
bootManager=none
commitDiskPart

# Setup the disk label - 1st disk
# All sizes are expressed in MB
# Avail FS Types, UFS, UFS+S, UFS+J, ZFS, SWAP
disk0-part=UFS+S 1024 / 
disk0-part=SWAP.eli 2048 none
disk0-part=UFS+S 1024 /tmp
disk0-part=UFS+S 1024 /var
disk0-part=UFS+S 0 /usr
# Size 0 means use the rest of the slice size
# Do it now!
commitDiskLabel

# Setup the disk label - 2nd disk
# All sizes are expressed in MB
# Avail FS Types, UFS, UFS+S, UFS+J, ZFS, SWAP
disk1-part=UFS+S 1024 /usr/src 
disk1-part=UFS+S 4096 /usr/local
disk1-part=UFS+S 0 /usr/ports
# Size 0 means use the rest of the slice size
# Do it now!
commitDiskLabel

netDev=em1
netIP=172.16.80.250
netMask=255.255.240.0
netNameServer=172.16.80.1
netDefaultRouter=172.16.80.1
netSaveDev=em0 em1 
netSaveIP_em0=192.168.101.42
netSaveIP_em1=172.16.80.156
netSaveMask_em0=255.255.252.0
netSaveMask_em1=255.255.240.0
netSaveNameServer=172.16.80.1
netSaveDefaultRouter=192.168.100.1

# Set if we are installing via optical, USB, or FTP
installType=FreeBSD
installMedium=ftp
ftpPath=http://pkgbuilder.mydomain.com/images/freebsd/8.2/
packageType=tar

# List our components to install
#installComponents=ports,src

# Set the root pass
rootPass=root

# Setup our users
userName=demo
userComment=Demo User
userPass=demo
userShell=/bin/sh
userHome=/home/demo
commitUser

# Set up date/time
runCommand=cp /usr/share/zoneinfo/EST5EDT /etc/localtime
runCommand=touch /etc/wall_cmos_clock
runCommand=adjkerntz -a

# Install packages required for VMware Tools installation/configuration
runCommand=pkg_add -r compat6x-amd64
runCommand=pkg_add -r perl
runCommand=pkg_add -r pcre
runCommand=pkg_add -r puppet
runCommand=pkg_add -r sysrc

# Fetch/install VMware Tools
runCommand=fetch -o /tmp/vmtools.tar.gz http://pkgbuilder.mydomain.com/images/freebsd/vmware-freebsd-tools.tar.gz
runCommand=zcat /tmp/vmtools.tar.gz | tar -C /tmp -xvf -
runCommand=/tmp/vmware-tools-distrib/vmware-install.pl -d
runCommand=rm -rf /tmp/vmware-tools-distrib
runCommand=/usr/local/sbin/sysrc puppet_enable=YES
# Generate the certificate to be signed by the master
runCommand=/usr/local/bin/puppet agent -t
 

If you wish to perform a fully-automated installation that does not prompt for any user input, you will also need to review /usr/share/examples/pc-sysinstall/pc-autoinstall.conf and place a customized copy of that file into /boot/pc-autoinstall.conf on your installation media.

Table 5.5b summarizes the additional variables that are available for fully automatic installations. More detailed descriptions can be found in the /usr/share/examples/pc-sysinstall/pc-autoinstall.conf file. Note that the variables in this file use a different syntax than those in Table 5.5a, in that the values follow a colon and a space rather than an equal sign.

Table 5.5b.: Additional Variables for Automated Installations

Variable Options Description
pc_config URL or /path/to/file location of customized pc-sysinstall.conf
confirm_install yes or no should be set to yes, otherwise booting the wrong disk will result in a system wipe
shutdown_cmd e.g. shutdown -p now good idea to run a shutdown, but can be any command/script you wish to execute post-install
nic_config dhcp-all or <interface name> <IP address> <subnet mask> will attempt dhcp on all found NICs until the installation file can be fetched or will setup specified interface
nic_dns IP address DNS server to use
nic_gateway IP address default gateway to use

Here is a sample pc-autoinstall.conf file:

# pc-autoinstall.conf example
#
# Usage: Modify these variables, and copy the file to
# /boot/pc-autoinstall.conf on your PC-BSD installation medium
#
# The conf will then be read at bootup, and your automated
# install will take place
##################################################################

# Where the pc-sysinstall main config is located
# Can be either a file on the booted CD / DVD / USB media,
# or a remote file on http / ftp
#
# The value %%NIC_MAC%% is special, and will be substituted with
# the macaddress of the enabled NIC from DHCP or manually set
# with 'nic_config:'
##################################################################

# Examples:
# pc_config: ftp://192.168.0.2/cust-install.cfg
# pc_config: http://192.168.0.2/cust-install.cfg
# pc_config: http://192.168.0.2/%%NIC_MAC%%.cfg
# pc_config: /boot/cust-install.cfg
pc_config:
http://pkgbuilder.mydomain.com/images/freebsd/pc-sysinstall.cfg

# Set this to yes if we should confirm before doing an install
# This should normally be set to yes, otherwise booting the wrong
# disk will result in a system wipe
confirm_install: no

# Set the command to run post-install, usually best to run shutdown
# but this can be replaced with any other command / script you wish
# to execute post-install
shutdown_cmd: shutdown -r now

# Options for the network setup, should the cfg need to be fetched
# from a remote location, only necessary when using ftp or http
##################################################################

# Special option, will attempt dhcp on all found NICs
# until the file can be fetched, or we run out of interfaces
# nic_config: dhcp-all

# Line to be passed to the "ifconfig" command to bring up an interface
nic_config: em1 172.16.80.250 255.255.240.0

# DNS server to use
nic_dns: 172.16.80.1

# Default router / gateway
nic_gateway: 172.16.80.1
 

Create a Custom Installation Media or Installation Server

pc-sysinstall supports the following installation methods:

  • from a CD, DVD, or USB media
  • from an installation directory on an HTTP, FTP, SSH+rsync, or a PXE Boot Install server

The easiest way to create a custom installation media is to modify an existing installation image. For example, if you have downloaded an ISO for the PC-BSD® version that you wish to customize, the superuser can access the contents of the ISO as follows:

mdconfig -a -t vnode -f PCBSD9.0-x86-DVD.iso -u 1
mount -t cd9660 /dev/md1 /mnt

Make sure you have cd 'd into a directory where you would like to copy the contents of the ISO. In the following examples, /tmp/custominstall/ was created for this purpose:

cd /tmp/custominstall
tar -C /mnt -cf - . | tar -xvf -
umount /mnt

Alternately, if you have inserted an installation CD or DVD, you can mount the media and copy its contents to your desired directory:

mount -t cd9660 /dev/cd0 /mnt
cp -R /mnt/* /tmp/custominstall/
umount /mnt

If you are creating an automated installation, copy your customized pc-autoinstall.conf to /tmp/custominstall/boot/.

Copy your customized configuration file to /tmp/custominstall/. Double-check that the "installMedium=" variable in your customized configuration file is set to the type of media that you will be installing from.

You may also need to add some extra files if you set the following variables in your custom configuration file:

  • installComponents= make sure that any extra components you wish to install exist in extras/PBI/ (if they end in the .pbi extension) or extras/components/ (if they end in .tbz)
  • runCommand= make sure the command exists in the specified path
  • runScript= make sure the script exists in the specified path
  • runExtCommand= make sure the command exists in the specified path

If the installation media is a CD or DVD, you will need to create a bootable media that contains the files in your directory. To create a bootable ISO:

cd /tmp/custominstall
mkisofs -V mycustominstall -J -R -b boot/cdboot -no-emul-boot -o myinstall.iso

You can then use your favorite burning utility to burn the ISO to the media.

To begin an installation that requires user interaction:

pc-sysinstall -c /path_to_your_config_file

To begin a fully automated installation, insert the installation media and reboot.

If you are using an HTTP, FTP, or SSH server as the installation media, untar or copy the required files to a directory on the server that is accessible to users. Be sure to configure the server so that the installation files are accessible to the systems that you wish to install. If you are using a PXE Boot Install server, follow the instructions at Connecting to and Customizing the PXE Boot Install Server.

References