Sun Java System Portal Server 7 Installation Guide

Constructing a Configuration XML File

If the sample configuration file does not suit your desired setup and if a custom configuration XML file is to be constructed, follow the instructions in this section. In order to set up your custom configuration file, you must:

Begin by constructing the Required Configuration.

This basic configuration is required to make the portal psadmin command useable.
Construct the <ComponentsToConfigure> element depending on which components are to be configured on this host. See Portal Server Configuration for more information.

Construct the following configuration information based on the components to configure on this host:

Basic Portal Configuration

Sample Portal Configuration

Web Container Configuration

Search Server Configuration

Secure Remote Access Configuration

Gateway Configuration

Netlet Proxy Configuration

Rewriter Proxy Configuration

Run the ./psconfig -—config configfile.xml command.

Required Configuration

This section describes the overall Portal Server, header/footer, shared components, and the Access Manager elements in the configuration file. See example2.xml file.

For Solaris on SPARC and x86

<?xml version = "1.0" encoding = "UTF-8"?>
<PortalServerConfiguration xmlns:xsi=
 "http://www.w3.org/2001/XMLSchema-instance"
	xsi:noNamespaceSchemaLocation=
 "file:///opt/SUNWportal/lib/psconfig.xsd" SchemaVersion="1.0">
		<Configure ConfigurationHostName=
      "@HOST.DOMAIN@" SystemUser="root" SystemGroup="other" Validate="true">
			<SharedComponents
				JavaHome="/usr/jdk/entsys-j2se"
				CacaoProdDir="/opt/SUNWcacao"
				CacaoConfigDir="/etc/opt/SUNWcacao"
				SharedLibDir="/usr/share/lib"
				PrivateLibDir="/usr/share/lib"
				JDMKLibDir="/opt/SUNWjdmk/5.1/lib"
				NSSLibDir="/usr/lib/mps/secv1"
				JSSJarDir="/usr/share/lib/mps/secv1"
				WebNFSLibDir="/opt/SUNWebnfs"
				DerbyLibDir="/usr/share/lib/Derby"
				AntLibDir="/usr/sfw/lib/ant"
				AntHomeDir="/usr/sfw"
         RegistryLibDir="/opt/SUNWsoar/lib"
			/>
			<AccessManager>
				<InstallationDirectory
					ProdDir="/opt/SUNWam"
					DataDir="/var/opt/SUNWam"
					ConfigDir="/etc/opt/SUNWam/config"
					ConfigFile="AMConfig.properties"
				/>
				<UserCredentials
					AdministratorUID="amadmin"
					AdministratorUserPassword="@AMADMIN.PASSWORD@"
					LDAPUserId="amldapuser"
					LDAPUserIdPassword="@AMLDAPUSER.PASSWORD@"
					DirectoryManagerDn="cn=Directory Manager"
				DirectoryManagerPassword="@DIRMGR.PASSWORD@"/>
			</AccessManager>
			<PortalConfiguration>
				<InstallationDirectory
					ProdDir="/opt/SUNWportal"
					DataDir="/var/opt/SUNWportal"
				ConfigDir="/etc/opt/SUNWportal"/>
				<ComponentsToConfigure>
					.
					.
					.
				</ComponentsToConfigure>
				.
				.
				.
			</PortalConfiguration>
			.
			.
			.
		</Configure>
</PortalServerConfiguration>

For Linux

<?xml version = "1.0" encoding = "UTF-8"?>
<PortalServerConfiguration xmlns:xsi=
 "http://www.w3.org/2001/XMLSchema-instance"
	xsi:noNamespaceSchemaLocation=
 "file:///opt/sun/portal/lib/psconfig.xsd" SchemaVersion="1.0">
		<Configure  ConfigurationHostName=
      "@HOST.DOMAIN@" SystemUser="root" SystemGroup="other" Validate="true">
			<SharedComponents
				JavaHome="/usr/jdk/entsys-j2se"
				CacaoProdDir="/opt/sun/cacao"
				CacaoConfigDir="/etc/opt/sun/cacao"
				SharedLibDir="/opt/sun/share/lib"
				PrivateLibDir="/opt/sun/private/share/lib"
				JDMKLibDir="/opt/sun/jdmk/5.1/lib"
				NSSLibDir="/opt/sun/private/lib"
				JSSJarDir="/opt/sun/private/share/lib"
				WebNFSLibDir="/opt/sun/webnfs"
				DerbyLibDir="/opt/sun/share/lib/Derby"
				AntHomeDir="/opt/sun/share"
				AntLibDir="/opt/sun/share/lib"
         RegistryLibDir="/opt/sun/SUNWsoar/lib"
			/>
			<AccessManager>
				<InstallationDirectory
					ProdDir="/opt/sun/identity"
					DataDir="/var/opt/sun/identity"
					ConfigDir="/etc/opt/sun/identity/config"
					ConfigFile="AMConfig.properties"
				/>
				<UserCredentials
					AdministratorUID="amadmin"
					AdministratorUserPassword="@AMADMIN.PASSWORD@"
					LDAPUserId="amldapuser"
					LDAPUserIdPassword="@AMLDAPUSER.PASSWORD@"
					DirectoryManagerDn="cn=Directory Manager"
				DirectoryManagerPassword="@DIRMGR.PASSWORD@"/>
			</AccessManager>
			<PortalConfiguration>
				<InstallationDirectory
					ProdDir="/opt/sun/portal"
					DataDir="/var/opt/sun/portal"
				ConfigDir="/etc/opt/sun/portal"/>
				<ComponentsToConfigure>
					.
					.
					.
				</ComponentsToConfigure>
				.
				.
				.
			</PortalConfiguration>
			.
			.
			.
		</Configure>
</PortalServerConfiguration>

Tokens to Replace

@HOST.DOMAIN@: The host and domain name of the machine on which configuration is occurring.
@AMADMIN.PASSWORD@: Administrator's password for the Access Manager instance with which Portal is to be configured.
@AMLDAPUSER.PASSWORD@: Internal LDAP User password for the Access Manager instance with which Portal is to be configured.
@DIRMGR.PASSWORD@: Administrator's password of the Directory Server with which Portal is to be configured.

Values to Modify

PortalServerConfiguration xsi:noNamespaceSchemaLocation: If portal is installed in a non-default location, then this location needs to be changed accordingly.
SharedComponents JCIFSLibDir: JCIFS is an optional 3rd party component that is required only by the Netfile component. Install the JCIFS package and specify the lib location here.
SharedComponents JChardet: JChardet is an optional 3rd party component that is required only by the Netfile component. Install the JChardet package and specify the lib location here.
AccessManager InstallationDirectory ProdDir, DataDir, ConfigDir: Specify the installation location of Access Manager software here if it was not installed in the default location.
PortalConfiguration InstallationDirectory ProdDir, DataDir, ConfigDir: Specify the installation location of Portal Server software here if it was not installed in the default location.

Portal Server Configuration

Different Portal Server components that can be installed and configured across different nodes include the core Portal Server, Secure Remote Access (SRA), Gateway, Netlet Proxy, and Rewriter Proxy. Depending on which components are configured on this host, the <ComponentsToConfigure> element can be constructed.

If all components are to be configured this host, include the following:

<ComponentsToConfigure>
		<component>portalserver</component>
		<component>sracore</component>
		<component>gateway</component>
		<component>netletproxy</component>
		<component>rewriterproxy</component>
</ComponentsToConfigure>

To exclude components, remove the corresponding <component> element.

Basic Portal Configuration

XML Fragment

<PortalConfiguration>
		<PortalServer PortalAccessURL="http://@HOST.DOMAIN@:@PORT@/portal"
			PortalID="portal1"
			PortalWebappURI="/portal"
			SearchServerID="search1">
			<Instance InstanceID="myInstance">
				<WebContainerProperties
					.
					.
					.
				/>
			</Instance>
		</PortalServer>
</PortalConfiguration>

Tokens to Replace

@HOST.DOMAIN@: The host and domain name of the machine on which portal is to be configured.
@PORT@: Web container port at which portal has to be deployed

Values to Modify

PortalConfiguration PortalServer PortalAccessURL (optional): If the DEPLOY URI is non-default, change /portal to the changed URI value.
PortalConfiguration PortalServer PortalWebappURI (optional): If the DEPLOY URI is non-default, change, /portal to the changed URI value. In case of non-default DEPLOY URI, ensure that both PortalAccessURL and PortalWebappURI are specified in the configuration XML file.
PortalConfiguration PortalServer PortalID: Change portal1 to the required portal ID, which should be unique.
PortalConfiguration PortalServer Instance InstanceID: Change myInstance to the required instance ID, which should be unique.
PortalConfiguration PortalServer SearchServerID (optional): Specifies which Search Server this portal samples are configured with. This is needed only if samples are configured.

Sample Portal Configuration

Portal Server software supports three types of sample portals: the Developer Sample, Enterprise Sample, and Community Sample. Each of these samples are created under its own sub-org for ease of management. Configuring any or all of these samples is supported.

<PortalConfiguration>
		<PortalServer 
			.
			.
			.
		>
			<SamplePortal>
				<Sample Name="DeveloperPortal"/>
				<Sample Name="EnterprisePortal"/>
				<Sample Name="CommunityPortal"/>
			</SamplePortal>
			.
			.
			.
		</PortalServer>
</PortalConfiguration>

Web Container Configuration

The Web container configuration varies with the container to be configured. In the configuration XML file, there is one <WebContainerProperties> element specified for the web container under the <PortalServer><Instance> element and one under the <SearchServer> element.

Sun Java System Web Server Configuration

Tip –

See example1.xml, examples 3 to 9, and example13.xml files.

XML Fragment For Solaris on SPARC and x86

<WebContainerProperties
		Host="@HOST.DOMAIN@"
		Port="@PORT@"
		Scheme="http"
		WebContainerInstallDir="/opt/SUNWwbsvr"
		WebContainerInstanceName="@INSTANCENAME@"
		WebContainerInstanceDir="/opt/SUNWwbsvr/https-@INSTANCENAME@"
		WebContainerDocRoot="/opt/SUNWwbsvr/docs"
		WebContainerAdminHost=""
		WebContainerAdminPort="@ADMIN.PORT@"
		WebContainerAdminScheme="http"
		WebContainerAdminUid="admin"
		WebContainerAdminPassword="@PASSWORD@"
		WebContainerCertificateDBPassword=""
		WebContainerType="SJSWS6"
	/>

For Linux

<WebContainerProperties
		Host="@HOST.DOMAIN@"
		Port="@PORT@"
		Scheme="http"
		WebContainerInstallDir="/opt/sun/webserver"
		WebContainerInstanceName="@INSTANCENAME@"
		WebContainerInstanceDir="/opt/sun/webserver/https-@INSTANCENAME@"
		WebContainerDocRoot="/opt/sun/webserver/docs"
		WebContainerAdminHost=""
		WebContainerAdminPort="@ADMIN.PORT@"
		WebContainerAdminScheme="http"
		WebContainerAdminUid="admin"
		WebContainerAdminPassword="@PASSWORD@"
		WebContainerCertificateDBPassword=""
		WebContainerType="SJSWS6"
	/>

Tokens to Replace

@HOST.DOMAIN@: The host and domain name of the machine on which portal instance is to be configured
@PORT@: Web server port
@INSTANCENAME@: Web server instance name
@ADMIN.PORT@: Web server administration port
@PASSWORD@: Web server administrator's password

Values to Modify

WebContainerInstallDir, WebContainerInstanceDir, WebContainerDocRoot: If the web server is installed in a non-default location.
WebContainerAdminScheme, WebContainerCertificateDBPassword: If web server is installed in secure mode (https).

Sun Java System Application Server Configuration

Tip –

See example14.xml file.

XML Fragment For Solaris on SPARC and x86

<WebContainerProperties
		Host="@HOST.DOMAIN@"
		Port="@PORT@"
		Scheme="http"
		WebContainerInstallDir="/opt/SUNWappserver/appserver"
		WebContainerInstanceName="server"
		WebContainerDomainName="domain1"
		WebContainerInstanceDir="/var/opt/SUNWappserver/domains/domain1"
		WebContainerDocRoot="/var/opt/SUNWappserver/domains/domain1/docroot"
		WebContainerAdminHost="@HOST.DOMAIN@"
		WebContainerAdminPort="@ADMIN.PORT@"
		WebContainerAdminScheme="https"
		WebContainerAdminUid="admin"
		WebContainerAdminPassword="@PASSWORD@"
		WebContainerMasterPassword="@MASTER.PASSWORD@"
		WebContainerType="SJSAS81"
	/>

XML Fragment For Linux

<WebContainerProperties
		Host="@HOST.DOMAIN@"
		Port="@PORT@"
		Scheme="http"
		WebContainerInstallDir="/opt/sun/appserver"
		WebContainerInstanceName="server"
		WebContainerDomainName="domain1"
		WebContainerInstanceDir="/var/opt/sun/appserver/domains/domain1"
		WebContainerDocRoot="/var/opt/sun/appserver/domains/domain1/docroot"
		WebContainerAdminHost="@HOST.DOMAIN@"
		WebContainerAdminPort="@ADMIN.PORT@"
		WebContainerAdminScheme="https"
		WebContainerAdminUid="admin"
		WebContainerAdminPassword="@PASSWORD@"
		WebContainerMasterPassword="@MASTER.PASSWORD@"
		WebContainerType="SJSAS81"
	/>

Tokens to Replace

@HOST.DOMAIN@: The host and domain name of the machine on which portal instance is to be configured
@PORT@: Application server port
@ADMIN.PORT@: Application server administration port
@PASSWORD@: Application server administrator's password
@MASTER.PASSWORD@: Application server Master Password if specified

Values to Modify

WebContainerInstallDir: If application server is installed at a non-default location
WebContainerDomainName, WebContainerInstanceDir, WebContainerDocRoot: If deploying to a non-default application server domain
WebContainerInstanceName: Instance name within the Application Server domain. The server is the name of the first instance which is created by default at the same time the Application Server 8.1 domain is created. This can be changed to the name of any other created instance within that domain.

Search Server Configuration

The Search Server is deployed to a specific web container instance which is defined by a <WebContainerProperties> element. Multiple Search servers can be specified by having multiple <SearchServer> elements within a <PortalConfiguration> section, each with a unique ID. A Portal may be associated with a specific search server by specifying the SearchServerID attribute within the <PortalServer> element.

<PortalConfiguration>
		<SearchServer SearchServerID="search1">
			<WebContainerProperties
				.
				.
				.
			/>
		</SearchServer>
		<PortalServer 
			SearchServerID="search1">
				.
				.
				.
		</PortalServer>
</PortalConfiguration>

Secure Remote Access Configuration

The SRA core component can only be installed and configured on the same node as the portal server component. Further the portal server and SRA core components have to be configured at the same time. That is, the SRA core component cannot be configured on a host that already has an existing portal server.

XML Fragment

Secure remote access support can be added to portal be adding the <component>sracore</component> to the <ComponentsToConfigure> section. In addition add the following section to the <PortalConfiguration> section:

<PortalConfiguration>
		.
		.
		.
		<SecureRemoteAccessCore
			GatewayProtocol="https"
			PortalServerDomain="@DOMAIN@" 
			GatewayPort="@GATEWAY.PORT@"
			GatewayProfileName="default"
		LogUserPassword="@SRA.LOGUSER.PASSWORD@"/>
</PortalConfiguration>

Tokens to Replace

@DOMAIN@: Domain name of the machine on which portal is to be configured
@GATEWAY.PORT@: Port on which Gateway is to run
@SRA.LOGUSER.PASSWORD@: SRA log user password

Values to Modify

GatewayProfileName: Change this if the default profile is not to be used

Gateway Configuration

Tip –

See example10.xml file.

XML Fragment

<ComponentsToConfigure>
		<component>gateway</component>
</ComponentsToConfigure>
<PortalServer PortalAccessURL="http://@PSHOST.DOMAIN@:@PORT@/portal">
</PortalServer>
<Gateway Profile="default">
		<SRAInstance
			Protocol="https"
			Host="@HOST.DOMAIN@"
			Port="@GATEWAY.PORT@"
			IPAddress="@IPADDRESS@" 
			LogUserPassword="@SRA.LOGUSER.PASSWORD@" 
		StartInstance="true"/>
</Gateway>
<CertificateInformation
		Organization="Sun Microsystems"
		Division="Software"
		CityOrLocality="Santa Clara"
		StateProvince="CA"
		CountryCode="US"
	CertificateDatabasePassword="@SRA.CERTDB.PASSWORD@"/>

Tokens to Replace

@HOST.DOMAIN@: The host and domain name of the machine on which gateway is to be configured
@GATEWAY.PORT@: Port on which Gateway is to run
@IPADDRESS@: IP address of the machine on which Gateway is run
@PSHOST.DOMAIN@: The host and domain name of the machine on which portal instance is to be configured.
@PORT@: Port on which portal instance is to run
@SRA.LOGUSER.PASSWORD@: SRA log user password
@SRA.CERTDB.PASSWORD@: SRA Certificate database password

Values to Modify

Gateway Profile: Change this if the default profile is not to be used
Gateway SRAInstance StartInstance: Change if start on install is not required
CertificateInformation: Change attributes in this section accordingly

Netlet Proxy Configuration

Tip –

See example11.xml file.

XML Fragment

<ComponentsToConfigure>
		<component>netletproxycomponent>netletproxy>
</ComponentsToConfigure>
<PortalServer PortalAccessURL="http://@PSHOST.DOMAIN@:@PORT@/portal">
</PortalServer>
<NetletProxy Profile="default">
		<SRAInstance
			Protocol="https"
			Host="@HOST.DOMAIN@"
			Port="@NETLET.PROXY.PORT@"
			IPAddress="@IPADDRESS@" 
			LogUserPassword="@SRA.LOGUSER.PASSWORD@" 
		StartInstance="true"/>
</NetletProxy>
<CertificateInformation
		Organization="Sun Microsystems"
		Division="Software"
		CityOrLocality="Santa Clara"
		StateProvince="CA"
		CountryCode="US"
	CertificateDatabasePassword="@SRA.CERTDB.PASSWORD@"/>

Tokens to Replace

@HOST.DOMAIN@: The host and domain name of the machine on which Netlet Proxy is to be configured
@NETLET.PROXY.PORT@: Port on which Netlet Proxy is to run
@IPADDRESS@: IP address of the machine on which Netlet Proxy is to run
@PSHOST.DOMAIN@: The host and domain name of the machine on which portal instance is to be configured.
@PORT@: Port on which portal instance is to run
@SRA.LOGUSER.PASSWORD@: SRA log user password
@SRA.CERTDB.PASSWORD@: SRA Certificate database password

Values to Modify

NetletProxy Profile: Change this if the default profile is not to be used
NetletProxy SRAInstance StartInstance: Change if start on install is not required
CertificateInformation: Change attributes in this section accordingly

Rewriter Proxy Configuration

Tip –

See example12.xml file.

XML Fragment

<ComponentsToConfigure>
		<component>rewriterproxycomponent>rewriterproxy>
</ComponentsToConfigure>
<PortalServer PortalAccessURL="http://@PSHOST.DOMAIN@:@PORT@/portal">
</PortalServer>
<RewriterProxy Profile="default">
		<SRAInstance
			Protocol="https"
			Host="@HOST.DOMAIN@"
			Port="@REWRITER.PROXY.PORT@"
			IPAddress="@IPADDRESS@" 
			LogUserPassword="@SRA.LOGUSER.PASSWORD@" 
		StartInstance="true"/>
</RewriterProxy>
<CertificateInformation
		Organization="Sun Microsystems"
		Division="Software"
		CityOrLocality="Santa Clara"
		StateProvince="CA"
		CountryCode="US"
	CertificateDatabasePassword="@SRA.CERTDB.PASSWORD@"/>

Tokens to Replace

@HOST.DOMAIN@: The host and domain name of the machine on which Rewriter Proxy is to be configured
@REWRITER.PROXY.PORT@: Port on which Rewriter Proxy is to run
@IPADDRESS@: IP address of the machine on which Rewriter Proxy is to run
@PSHOST.DOMAIN@: The host and domain name of the machine on which portal instance is to be configured.
@PORT@: Port on which portal instance runs.
@SRA.LOGUSER.PASSWORD@: SRA log user password.
@SRA.CERTDB.PASSWORD@: SRA Certificate database password.

Values to Modify

RewriterProxy Profile: Change this if the default profile is not to be used
RewriterProxy SRAInstance StartInstance: Change if start on install is not required
CertificateInformation: Change attributes in this section accordingly