Introduction
This document is written to meet the requirements of information technology (IT) professionals who will be responsible for the installation of Office SharePoint Server. This document will cover the procedures and recommendations for installing MOSS via the command line. This will include describing how to install the product by running Setup.exe from the command line and passing in a Config.xml file that can be customized further based on the installation options required. As well as how to use the admin tools PSConfig.exe and STSADM.exe to perform actions via the command line such as configuration and site creation.
Before you begin deployment
This section provides information about actions that you must perform before you begin deployment.
· Plan for security roles (Office SharePoint Server) gives an overview of the three-tier security model.
· Plan for administrative and service accounts (Office SharePoint Server) gives detailed information.
· Office SharePoint Server Security Account Requirements is a planning tool that lists accounts to use in various scenarios, including three flavors of least-privilege administration (domain user accounts, SQL authentication, and domain user accounts connecting to pre-created databases).
Overview of the deployment process
The deployment process consists of two phases: installing and configuring the server, and creating the Shared Services Provider and Site Collections.
Phase 1: Installing and configuring the server
1. Install MOSS by running Setup.exe with the appropriate Config.xml file.
2. Configure it and create the administration Web application by running PSConfig.exe with the appropriate options.
Phase2: Creating and configuring the shared services providers and site collections
3. Create a Shared Services Provider by running STSADM.exe operation (for farm installation).
4. Create a site collection by running STSADM.exe operation (for farm installation).
For a Standalone install only the above first two steps are required and after running psconfig.exe installation will be complete with the Standalone config. For a Farm install, additional command line options will be required when running psconfig.exe and additional steps using stsadm.exe will be needed to complete the Farm installation.
Prerequisites
1. Windows Server 2003 SP1
2. Configure IIS with ASP.Net enabled
3. .NET Framework 2.0 with Web Service Extensions enabled
4. Windows Workflow Foundations installed
5. SQL Server 2000 SP3 or SQL Server 2005 SP1 (for Farm configuration)
Permissions
To perform installation the user account running setup will need to be a member of the local Administrators group and have rights on the SQL server for the following actions:
· Creating new databases
· Read and write permissions
This translates into the dbcreator and securityadmin SQL server roles for the user account.
For more information about the SQL Server rights required refer to this document: http://technet2.microsoft.com/Office/en-us/library/f07768d4-ca37-447a-a056-1a67d93ef5401033.mspx?mfr=true
Setup.exe and Config.xml for Installation
Running setup can either be done in full UI mode by double-clicking on the setup.exe file or in silent mode by running the setup.exe via the command line and passing in a Config.xml file. Within the product DVD are contained examples of Config.xml files that can be used. The Config.xml file along with Setup.exe can be used for the controlling how Microsoft Office SharePoint Server will be installed.
The product DVD contains examples of Config.xml files that you can use as starting points for customizing your installation. The example files are stored under the \Files folder at the root of the DVD, in folders that correspond to different scenarios. The folders are:
|
• |
Setup - Contains a config.xml file for use in setting up a clean installation for a single server (stand-alone, with SQL Express). |
|
• |
SetupFarm - Contains a config.xml file for use in setting up a clean installation for a server farm. |
|
• |
SetupFarmSidebySide - Contains a config.xml file for use in upgrading an existing server farm gradually. |
|
• |
SetupFarmSilent - Contains a config.xml file for use in setting up a server farm in silent mode. |
|
• |
SetupFarmUpgrade - Contains a config.xml file for use in upgrading an existing server farm in place. |
|
• |
SetupSilent - Contains a config.xml file for use in setting up a clean installation for a single server (stand-alone, with SQL Express) in silent mode. |
|
• |
SetupSingleUpgrade - Contains a config.xml file for use in upgrading an existing single server (stand-alone) in place. |
To see more info about the Config.xml:
http://technet2.microsoft.com/Office/en-us/library/003e5316-1018-4949-ac54-42fa12c5e51e1033.mspx
We will examine using the SetupSilent\Config.xml to set up a clean installation for a single standalone server in silent mode and the SetupFarmSilent\Config.xml to set up a server farm in silent mode.
To run setup in silent mode via the command line you will run:
(for a Standalone install)
setup.exe /config Files\SetupSilent\config.xml
OR
(for a Farm install)
setup.exe /config Files\SetupFarmSilent\config.xml
Here is an example of the Config.xml file:
<Configuration>
<Package Id="sts">
<Setting Id="LAUNCHEDFROMSETUPSTS" Value="Yes"/>
<Setting Id="REBOOT" Value="ReallySuppress"/>
<Setting Id="SETUPTYPE" Value="CLEAN_INSTALL"/>
</Package>
<Package Id="spswfe">
<Setting Id="SETUPCALLED" Value="1"/>
<Setting Id="REBOOT" Value="ReallySuppress"/>
<Setting Id="OFFICESERVERPREMIUM" Value="1" />
</Package>
<Logging Type="verbose" Path="%temp%" Template="Office Server Setup(*).log"/>
<Display Level="none" CompletionNotice="no" />
<PIDKEY Value="Enter PID Key Here" />
<Setting Id="SERVERROLE" Value="SINGLESERVER"/>
<Setting Id="USINGUIINSTALLMODE" Value="0"/>
</Configuration>
Note that you will need to bypass the prompt for the product key by providing it in the config.xml value:
<PIDKEY Value="Enter PID Key Here" />
Also note the logging path for the log file to view if you encounter a failed installation:
<Logging Type="verbose" Path="%temp%" Template="Office Server Setup(*).log"/>
To see the complete list of options for Setup.exe:
http://technet2.microsoft.com/Office/en-us/library/7e45c7b1-de7f-4f8f-81cd-7070ce483a821033.mspx
PSConfig.exe for Configuration
The PSConfig.exe command line tool is used to configure the product after setup has completed. The default location of the tool: c:\program files\common files\microsoft shared\web server extensions\12\bin.
After setup has completed, you can run PSConfig to perform the configuration setup based on installation mode. If SharePoint is installed in Standalone mode then the Standalone configuration will be performed by running the setup command. If SharePoint is installed in Farm mode there are a series of PSConfig.exe commands that will need to be run to complete configuration.
Standalone Install:
Running PSConfig.exe with the setup command will complete installation on a Standalone install. The Standalone install will be complete with web applications and site collections for a SharePoint Server install.
PSConfig.exe –cmd setup
The output will be displayed on the command window and when finished will result in a completed Standalone installation.
Farm Install:
To create a new server farm or connect to an existing server farm the following steps will need to be run in the following order:
1. Create the ConfigDB:
PSConfig.exe -cmd configdb -create -server <Server_name> -database <Database_name>
-dbuser <DOMAIN\username> -dbpassword <password>
-user <DOMAIN\username> -password <password>
-addomain <domain_name> -adorgunit <org_unit>
-admincontentdatabase <Database_name>
Note that if you wish to connect to an existing configuration database and join the server to an existing server farm you will need to perform the ConfigDB command with the -connect parameter
Sample Output:
Performing configuration task 1 of 3
Initializing SharePoint Products and Technologies configuration...
Successfully initialized the SharePoint Products and Technologies configuration.
Performing configuration task 2 of 3
Creating the configuration database...
Successfully created the configuration database.
Performing configuration task 3 of 3
Finalizing the SharePoint Products and Technologies configuration...
Successfully completed the SharePoint Products and Technologies configuration.
Total number of configuration settings run: 3
Total number of successful configuration settings: 3
Total number of unsuccessful configuration settings: 0
Successfully stopped the configuration of SharePoint Products and Technologies.
Configuration of the SharePoint Products and Technologies has succeeded.
2. Install all HelpCollections
psconfig.exe -cmd helpcollections installall
Sample Output:
Performing configuration task 1 of 3
Initializing SharePoint Products and Technologies configuration...
Successfully initialized the SharePoint Products and Technologies configuration
Performing configuration task 2 of 3
Installing help collections...
Successfully installed help collections.
Performing configuration task 3 of 3
Finalizing the SharePoint Products and Technologies configuration...
Successfully completed the SharePoint Products and Technologies configuration.
Total number of configuration settings run: 3
Total number of successful configuration settings: 3
Total number of unsuccessful configuration settings: 0
Successfully stopped the configuration of SharePoint Products and Technologies.
Configuration of the SharePoint Products and Technologies has succeeded.
3. Perform resource security enforcement
psconfig.exe -cmd secureresources
Sample Output:
Performing configuration task 1 of 3
Initializing SharePoint Products and Technologies configuration...
Successfully initialized the SharePoint Products and Technologies configuration.
Performing configuration task 2 of 3
Securing the SharePoint resources...
Successfully secured resource 'HKEY_LOCAL_MACHINE\Software\Microsoft\Office Serv
er\12.0\LoadBalancerSettings' of type 'RegKey' by granting security group 'Local
Service' 'Read' permissions .
Successfully secured resource 'D:\Program Files\Microsoft Office Servers\12.0\We
bServices\Root' of type 'Directory' by granting security group 'Users' 'Read, Ex
ecute' permissions .
…
Successfully secured the SharePoint resources.
Performing configuration task 3 of 3
Finalizing the SharePoint Products and Technologies configuration...
Successfully completed the SharePoint Products and Technologies configuration.
Total number of configuration settings run: 3
Total number of successful configuration settings: 3
Total number of unsuccessful configuration settings: 0
Successfully stopped the configuration of SharePoint Products and Technologies.
Configuration of the SharePoint Products and Technologies has succeeded.
4. Register the services in the server farm
psconfig.exe -cmd services -install
Sample Output:
Performing configuration task 1 of 3
Initializing SharePoint Products and Technologies configuration...
Successfully initialized the SharePoint Products and Technologies configuration.
Performing configuration task 2 of 3
Registering SharePoint services...
Successfully installed service: Excel Calculation Services.
Successfully installed service instance: Excel Calculation Services.
Successfully installed service: Forms Service.
Successfully installed service: Office SharePoint Usage Analytics Service.
Successfully installed service instance: Office SharePoint Usage Analytics Service.
Successfully installed service: Business Data Catalog.
Successfully installed service instance: Business Data Catalog.
Successfully installed service: Office SharePoint Server Diagnostics Service.
Successfully installed service: Shared Services Timer.
Successfully installed service instance: Shared Services Timer.
Successfully installed service: SSP Job Control Service.
Successfully installed service instance: SSP Job Control Service.
Successfully installed service: Session State Service.
Successfully installed service instance: Session State.
Successfully installed service: User Profile Service.
Successfully installed service: Document Conversions Launcher Service.
Successfully installed service instance: Document Conversions Launcher Service.
Successfully installed service: Document Conversions Load Balancer Service.
Successfully installed service instance: Document Conversions Load Balancer Service.
Successfully installed service: Office SharePoint Server Search Admin Web Service.
Successfully installed service instance: Office SharePoint Server Search Admin Web Service.
Successfully installed service: Office SharePoint Server Search.
Successfully installed service instance: Office SharePoint Server Search.
Successfully installed service instance: Office SharePoint Server Search.
Successfully installed service: Windows SharePoint Diagnostics Service.
Successfully installed service: Portal Service.
Successfully installed service instance: Portal Service.
Successfully installed service: Single Sign-on Service.
Successfully installed service instance: Single Sign-on Service.
Successfully installed service: Windows SharePoint Services Help Search.
Successfully installed service instance: Windows SharePoint Services Help Search
Successfully installed service instance: Windows SharePoint Services Search.
Successfully registered SharePoint services.
Performing configuration task 3 of 3
Finalizing the SharePoint Products and Technologies configuration...
Successfully completed the SharePoint Products and Technologies configuration.
Total number of configuration settings run: 3
Total number of successful configuration settings: 3
Total number of unsuccessful configuration settings: 0
Successfully stopped the configuration of SharePoint Products and Technologies.
Configuration of the SharePoint Products and Technologies has succeeded.
Note that before you can provision we will need to start and configure the Search service via the STSADM.exe command (more information about STSADM.exe later on):
Start the Windows SharePoint Services Search:
stsadm -o spsearch -action start -farmserviceaccount Redmond\user -farmservicepassword MyPassword
Start the Office SharePoint Server Search service:
stsadm -o osearch -action start -role IndexQuery -farmserviceaccount Redmond\user -farmservicepassword MyPassword -farmcontactemail user@ms.com
psconfig.exe -cmd services –provision
5. Register all features
psconfig.exe -cmd installfeatures
Sample Output:
Performing configuration task 1 of 3
Initializing SharePoint Products and Technologies configuration...
Successfully initialized the SharePoint Products and Technologies configuration.
Performing configuration task 2 of 3
Registering SharePoint features...
Successfully installed feature D:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\Template\Features\FeaturePushdown\Feature.xml.
Successfully installed feature D:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\Template\Features\FeaturePushdownTask\Feature.xml.
Successfully installed feature D:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\Template\Features\GlobalWebParts\Feature.xml.
Successfully installed feature D:\Program Files\Common Files\Microsoft Shared\Web Server Extensions\12\Template\Features\GradualUpgrade\Feature.xml.
…
Successfully registered SharePoint features.
Performing configuration task 3 of 3
Finalizing the SharePoint Products and Technologies configuration...
Successfully completed the SharePoint Products and Technologies configuration.
Total number of configuration settings run: 3
Total number of successful configuration settings: 3
Total number of unsuccessful configuration settings: 0
Successfully stopped the configuration of SharePoint Products and Technologies.
Configuration of the SharePoint Products and Technologies has succeeded.
6. Provision the SharePoint Central Administration Web application
psconfig.exe -cmd adminvs -provision -port <port> -windowsauthprovider onlyusentlm
Sample Output:
Performing configuration task 1 of 3
Initializing SharePoint Products and Technologies configuration...
Successfully initialized the SharePoint Products and Technologies configuration.
Performing configuration task 2 of 3
Provisioning the SharePoint Central Administration Web Application...
The SharePoint Central Administration Web Application has been provisioned at http://<SERVER>:<PORT>
Successfully provisioned the SharePoint Central Administration Web Application.
Performing configuration task 3 of 3
Finalizing the SharePoint Products and Technologies configuration...
Successfully completed the SharePoint Products and Technologies configuration.
Total number of configuration settings run: 3
Total number of successful configuration settings: 3
Total number of unsuccessful configuration settings: 0
Successfully stopped the configuration of SharePoint Products and Technologies.
Configuration of the SharePoint Products and Technologies has succeeded.
7. Install shared application data
psconfig.exe -cmd applicationcontent –install
Sample Output:
Performing configuration task 1 of 3
Initializing SharePoint Products and Technologies configuration...
Successfully initialized the SharePoint Products and Technologies configuration.
Performing configuration task 2 of 3
Installing the application content files...
Installing the SharePoint Central Administration Web Application content files..
Installing the SharePoint Web Application content files...
Successfully installed the application content files.
Performing configuration task 3 of 3
Finalizing the SharePoint Products and Technologies configuration...
Successfully completed the SharePoint Products and Technologies configuration.
Total number of configuration settings run: 3
Total number of successful configuration settings: 3
Total number of unsuccessful configuration settings: 0
Successfully stopped the configuration of SharePoint Products and Technologies.
Configuration of the SharePoint Products and Technologies has succeeded.
For more information about the PSConfig.exe command:
http://technet2.microsoft.com/Office/en-us/library/a59c4e8f-9b7f-4127-8199-1b9ab76991501033.mspx
At this point you will have successfully created the Central Administration site. If you have set up as Standalone, you now have a working MOSS installation.
If you have installed as a Farm install, we will use the STSADM.exe command line tool to complete creation of the Shared Services Provider (SSP) and site collection.
STSADM.exe Command Line Tool
The STSADM.exe admin tool is available in the default location on the same drive as where the SharePoint Products and Technologies are installed under %Common Program Files%\microsoft shared\web server extensions\12\bin. To see what actions are available with the tool you can run STSADM.exe –help which will output the operations that can be performed and STSADM.exe –help <operation name> to get more detailed documentation about a particular operation.
For more information about the STSADM.exe command:
http://technet2.microsoft.com/Office/en-us/library/188f006d-aa66-4784-a65b-a31822aa13f71033.mspx
More details about STSADM.exe command-line operations and parameters:
http://www.microsoft.com/resources/documentation/wss/2/all/adminguide/en-us/stsk02.mspx?mfr=true
Shared Services Provider (SSP) Creation
The recommended procedure for creating an SSP is to create a web application for the MySite host and a separate web application for the SSP. To create a new web application for both the MySite host and SSP run this STSADM.exe command for each new web application:
stsadm.exe -o extendvs -url <URL> -ownerlogin <domain/username> -owneremail <emailed> -exclusivelyusentlm -databaseserver <DBservername> -databasename <NewcontentDBname> -donotcreatesite -apcreatenew -apidname <Apppoolname> -apidtype configurableid -apidlogin <domain/username> -apidpwd <Password>
The extendvs operation is used to create the web application and the donotcreatesite parameter is used since we do not want to create a site when we extend the virtual server for the SSP and MySite web applications being created.
The apidtype parameter is used to set the identity type to use for the application pool:
[-apidtype <configurableid/NetworkService/LocalService/LocalSystem>]
For example:
stsadm.exe -o extendvs -url http://intranet:8080 -ownerlogin Redmond\username -owneremail user@ms.com -exclusivelyusentlm -databaseserver SQLServer -databasename SSPContentDB -donotcreatesite -apcreatenew -apidname SSPAppPool -apidtype configurableid -apidlogin Redmond\username -apidpwd MyPassword
creates a web application with the URL http://intranet:8080 that can be used to host the SSP. Similarly, you can create another web application to host the MySite sites:
stsadm.exe -o extendvs -url http://intranet:8090 -ownerlogin Redmond\username -owneremail user@ms.com -exclusivelyusentlm -databaseserver SQLServer -databasename MySiteContentDB -donotcreatesite -apcreatenew -apidname MySiteAppPool -apidtype configurableid -apidlogin Redmond\username -apidpwd MyPassword
At this point, you can create the SSP by running this STSADM.exe command and providing the SSP Web Application URL and MySite web application URL:
stsadm.exe –o createssp –title <SSP name> -url <Web application url> -mysiteurl <MySite Web application url> -ssplogin <username> -ssppassword <password> -sspdatabaseserver <SSP database server> -sspdatabasename <SSP database name> -indexserver <index server> -indexlocation <index file path>
For example:
STSADM.EXE -o createssp -title MySSP1 -url http://intranet:8080 -mysiteurl http://intranet:8090 -ssplogin Redmond\username -ssppassword MyPassword -sspdatabaseserver SQLServer -sspdatabasename MySSP1_db –indexserver MyServer -indexlocation "D:\Program Files\Microsoft Office Servers\12.0\Data\Office Server\Applications"
Portal Site Creation
The creation of the top-level site is accomplished by again extending the virtual server but this time we will create the site using the appropriate site template. This is done via the STSADM.exe with the extendvs operation.
For example:
STSADM.EXE -o extendvs -url http://intranet -ownerlogin Redmond\user –owneremail user@ms.com -exclusivelyusentlm -sitetemplate SPSPORTAL -apidname "SharePoint AppPool" -apidtype configurableid -apidlogin Redmond\user -apidpwd MyPassword
If you do not specify the template to use, the owner can choose the template when he or she first browses to the site.
From: http://blogs.msdn.com/dwinter/archive/2006/07/07/659613.aspx:
0 - GLOBAL (SetupPath=global) - "Global template"
1 - STS - "windows SharePoint Services Site", "Team Site", "Blank Site", "Document Workspace"
2 - MPS - "Basic Meeting Workspace", "Blank Meeting Workspace", "Decision Meeting Workspace", "Social Meeting Workspace", "Multipage Meeting Workspace"
3 - CENTRALADMIN - "Central Admin Site"
4 - WIKI - "Wiki Site"
7 - BDR - "Document Center"
9 - BLOG - "Blog"
20 - SPS (OBSOLETE) - "SharePoint Portal Server Site"
21 - SPSPERS - "SharePoint Portal Server Personal Space"
22 - SPSMSITE - "Personalization Site"
30 - SPSTOC (OBSOLETE) - "Contents area Template"
31 - SPSTOPIC (OBSOLETE) - "Topic area template"
32 - SPSNEWS (OBSOLETE) - "News area template"
33 - SPSNHOME (SubWebOnly) - "News Home template"
34 - SPSSITES - "Site Directory area template"
36 - SPSCOMMU (OBSOLETE) - "Community area template"
38 - SPSREPORTCENTER - "Report Center Site"
39 - CMSPUBLISHING (SetupPath=SiteTemplates\PUBLISHING) - "Publishing and Team Collaboration Site"
40 - OSRV (SetupPath=SiteTemplates\OSRV) - "Shared Services Administration Site"
47 - SPSPORTAL - "Corporate Intranet Site"
50 - SRCHCEN - "Search Center"
51 - PROFILES - "Profiles"
52 - BLANKINTERNETCONTAINER - "Internet Presence Web Site"
53 - BLANKINTERNET - "Publishing Site", "Press Releases Site", "Publishing Site"
54 - SPSMSITEHOST - "My Site Host"
90 - SRCHCENTERLITE (SetupPath=SiteTemplates\SRCHCENTERLITE) - "Search Center Lite"
6221 - PWA (SetupPath=SiteTemplates\PWA) - "Project Web Access Site"
6215 - PWS (SetupPath=SiteTemplates\PWS) - "Project Workspace"
14483 - OFFILE - "Records Repository", "Records Repository"
Note that the extendvs operation also allows for specifying the language of the new site collection with the locale ID (lcid) parameter. If you do not specify a locale ID, the language of the server is used for the default top-level web site.
List of Locale ID (LCID) Values: http://www.microsoft.com/globaldev/reference/lcid-all.mspx