This chapter contains the following:
The Sun Java System Portal Server 7 software can be installed using the installer in one of the two modes: the config now mode, where installation and configuration take place simultaneously, or the config later mode, which requires you to run the PortalServer7-base/bin/psconfig --config config-xml-file command after installing the software. By default, PortalServer7–base is /opt/SUNWportal.
This chapter describes how to use the sample configuration XML file or construct a configuration XML file for the desired portal set up. A basic understanding of the structure of XML is required to construct a custom configuration file.
The Sun Java System Portal Server software includes twenty sample configuration XML files at:
/opt/SUNWportal/samples/psconfig directory for SPARC and x86 |
/opt/sun/portal/samples/psconfig directory for Linux |
The location of the files depend on the install location. If portal is installed in a non-default location, these locations vary.
The PortalServer7-base/samples/psconfig/ReadMe.txt file describes each example file. By default the PortalServer7–base is /opt/SUNWportal. Read through this file to see which configuration example best suits your set up and replace the @TAGS@ (marked by @...@) after reviewing the default values specified in the example file. Create the required configuration XML file for the desired portal setup by modifying a selected configuration example.
Any of the configuration examples for the Web Server container can be adapted for Sun Java System Application Server by replacing the <WebContainerProperties> element section and the @TAGS@ tokens after reviewing the default values. For example:
Examples 1, 3 to 9, and 13 are common configurations for the Sun Java System Web Server container. |
Example 14 is a configuration for the Sun Java System Application Server 8.1 container |
Multi portal configurations (see example 15) can be customized by:
Including multiples instances of <PortalServer>, <Instance>, and <SearchServer> elements.
Replacing the @TAGS@ tokens after reviewing the default values.
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:
Run the ./psconfig -—config configfile.xml command.
This section describes the overall Portal Server, header/footer, shared components, and the Access Manager elements in the configuration file. See example2.xml file.
<?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>
<?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>
The host and domain name of the machine on which configuration is occurring.
Administrator's password for the Access Manager instance with which Portal is to be configured.
Internal LDAP User password for the Access Manager instance with which Portal is to be configured.
Administrator's password of the Directory Server with which Portal is to be configured.
If portal is installed in a non-default location, then this location needs to be changed accordingly.
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.
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.
Specify the installation location of Access Manager software here if it was not installed in the default location.
Specify the installation location of Portal Server software here if it was not installed in the default location.
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.
<PortalConfiguration> <PortalServer PortalAccessURL="http://@HOST.DOMAIN@:@PORT@/portal" PortalID="portal1" PortalWebappURI="/portal" SearchServerID="search1"> <Instance InstanceID="myInstance"> <WebContainerProperties . . . /> </Instance> </PortalServer> </PortalConfiguration>
The host and domain name of the machine on which portal is to be configured.
Web container port at which portal has to be deployed
If the DEPLOY URI is non-default, change /portal to the changed URI value.
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.
Change portal1 to the required portal ID, which should be unique.
Change myInstance to the required instance ID, which should be unique.
Specifies which Search Server this portal samples are configured with. This is needed only if samples are configured.
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>
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.
See example1.xml, examples 3 to 9, and example13.xml files.
<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" />
<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" />
The host and domain name of the machine on which portal instance is to be configured
Web server port
Web server instance name
Web server administration port
Web server administrator's password
If the web server is installed in a non-default location.
If web server is installed in secure mode (https).
See example14.xml file.
<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" />
<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" />
The host and domain name of the machine on which portal instance is to be configured
Application server port
Application server administration port
Application server administrator's password
Application server Master Password if specified
If application server is installed at a non-default location
If deploying to a non-default application server domain
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.
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>
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.
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>
Domain name of the machine on which portal is to be configured
Port on which Gateway is to run
SRA log user password
Change this if the default profile is not to be used
See example10.xml file.
<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@"/>
The host and domain name of the machine on which gateway is to be configured
Port on which Gateway is to run
IP address of the machine on which Gateway is run
The host and domain name of the machine on which portal instance is to be configured.
Port on which portal instance is to run
SRA log user password
SRA Certificate database password
Change this if the default profile is not to be used
Change if start on install is not required
Change attributes in this section accordingly
See example11.xml file.
<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@"/>
The host and domain name of the machine on which Netlet Proxy is to be configured
Port on which Netlet Proxy is to run
IP address of the machine on which Netlet Proxy is to run
The host and domain name of the machine on which portal instance is to be configured.
Port on which portal instance is to run
SRA log user password
SRA Certificate database password
Change this if the default profile is not to be used
Change if start on install is not required
Change attributes in this section accordingly
See example12.xml file.
<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@"/>
The host and domain name of the machine on which Rewriter Proxy is to be configured
Port on which Rewriter Proxy is to run
IP address of the machine on which Rewriter Proxy is to run
The host and domain name of the machine on which portal instance is to be configured.
Port on which portal instance runs.
SRA log user password.
SRA Certificate database password.
Change this if the default profile is not to be used
Change if start on install is not required
Change attributes in this section accordingly
The following instructions detail how to share a common certificate between two cacao servers.
Navigate to the /opt/SUNWportal/bin directory on the second Portal system.
Copy the example2.xml file from /opt/SUNWportal/samples/psconfig to the current file (/opt/SUNWportal/bin).
Replace the tokens in the file and run the psconfig command.
./psconfig config example2.xml
The cacao server and Derby on the system are installed.
When cacao and Derby are installed, go to the /opt/SUNWcacao/bin directory.
Get the list of certificates available in the default instance of cacao server.
./cacaoadm list-trusted-certs -i default
Extract the certificate from the default system.
./cacaoadm show-trusted-cert -i default cacao_ca
Cut and paste this certificate into a file and name it ps2.cert.
Follow the same procedure for the first portal system and save the file as ps1.cert.
Follow the same procedure for the first portal system and save the file as ps1.cert.
Navigate to the /opt/SUNWcacao/bin directory and execute the command.
./cacaoadm add-trusted-cert -f ps1.cert ps1
Add the certificate to the instance. Perform this step on both the portal servers.
Restart the cacao servers.
./cacaoadm stop
./cacaoadm start
The example files 18-20 under PortalServer7-base/samples/psconfig directory can be used for unconfiguring portalserver and its subcomponents. By default, PortalServer7–base is /opt/SUNWportal.
This section describes the information required in the example file required for psadmin --unconfig to work.
<?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"> <Unconfigure ConfigurationHostName="@HOST.DOMAIN@" Validate="true" UnconfigureAll="false"> <AccessManager> <UserCredentials AdministratorUID="amadmin" AdministratorUserPassword="@AMADMIN.PASSWORD@" LDAPUserId="amldapuser" LDAPUserIdPassword="@AMLDAPUSER.PASSWORD@" DirectoryManagerDn="cn=Directory Manager" DirectoryManagerPassword="@DIRMGR.PASSWORD@"/> </AccessManager> <PortalConfiguration> <ComponentsToConfigure> . . . . . . . . . </ComponentsToConfigure> </PortalConfiguration> </Unconfigure> </PortalServerConfiguration
The host and domain name of the machine on which configuration is occurring.
Administrator's password for the Access Manager instance with which Portal is to be configured.
Internal LDAP User password for the Access Manager instance with which Portal is to be configured.
Administrator's password of the Directory Server with which Portal is to be configured.
If Portal Server is installed in a non-default directory, the file:///opt/SUNWportal/lib/psconfig.xsd must be modified accordingly in the <PortalServerConfiguration ...> tag.
If UnconfigureAll=”false” then the components specified in the <ComponentsToConfigure> . . . </ComponentsToConfigure> is unconfigured.
Specific instances of the components can be unconfigured. For example, the following portion of code removes the SearchServer “search1,” the instance “myInstance” of the portal “MyFirstPortal,” all instances of the portal “MySecondPortal” and the instance “default” of Gateway, Netlet Proxy and Rewriter Proxy.
<PortalConfiguration> <ComponentsToConfigure> <component>portalserver</component> <component>sracore</component> <component>gateway</component> <component>netletproxy</component> <component>rewriterproxy</component> </ComponentsToConfigure> <SearchServer SearchServerID="search1"> </SearchServer> <PortalServer PortalID="MyFirstPortal"> <Instance InstanceID="myInstance"> </Instance> </PortalServer> <PortalServer PortalID="MySecondPortal"> </PortalServer> <Gateway Profile="default"/> <NetletProxy Profile="default"/> <RewriterProxy Profile="default"/> </PortalConfiguration>