README.setup revision 0a99555401a033704f1f171baab6db11fb5528f2
<!--
DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
Copyright (c) 2008 Sun Microsystems Inc. All Rights Reserved
The contents of this file are subject to the terms
of the Common Development and Distribution License
(the License). You may not use this file except in
compliance with the License.
You can obtain a copy of the License at
https://opensso.dev.java.net/public/CDDLv1.0.html or
opensso/legal/CDDLv1.0.txt
See the License for the specific language governing
permission and limitations under the License.
When distributing Covered Code, include this CDDL
Header Notice in each file and include the License file
at opensso/legal/CDDLv1.0.txt.
If applicable, add the following below the CDDL Header,
with the fields enclosed by brackets [] replaced by
your own identifying information:
"Portions Copyrighted [year] [name of copyright owner]"
$Id: README.setup,v 1.1 2008/08/31 06:54:54 hengming Exp $
-->
<!--
Portions Copyrighted 2011 ForgeRock AS
-->
OpenAM: ssoConfiguratorTools.zip
====================================================
This file contains information on installing and using ssoConfiguratorTools.zip.
It is assumed that OpenAM Server has been deployed.
Table of contents:
-----------------
1. Supported versions of Java Runtime
2. Installing ssoConfiguratorTools.zip
3. What does this package contain?
1. Supported versions of Java Runtime
-------------------------
J2SE 1.5 or higher.
2. Installing ssoConfiguratorTools.zip
--------------------------------------
Before setting up ssoConfiguratorTools.zip, JAVA_HOME environment variable
needs to be initialized to a path of a compatible Java Runtime.
Steps involved in installing ssoConfiguratorTools.zip are:
Step 1: Unzip ssoConfiguratorTools.zip to the desired directory.
Step 2: Go to the directory which has the ssoConfiguratorTools.zip unzipped.
Step 3: After step 2 is performed, if you want to setup OpenAM then goto step 4
or if you want to upgrade OpenAM goto step 5.
Step 4: To seutp OpenAM run the following command:
${JAVA_HOME}/bin/java -jar configurator.jar -f <configuration file>
Step 5: If you have already deployed OpenAM and want to upgrade
run the following command:
${JAVA_HOME}/bin/java -jar upgrade.jar -f <upgrade file>
3. What does this package contain?
----------------------------------
<ZIP_ROOT>
|
|----README.setup (this file)
|
|----configurator.jar (binaries needed for the configuration tool)
|
|----upgrade.jar (binaries needed for the upgrade tool)
|
|----license.txt (license file)
|
|----sampleconfiguration (a sample configuration file)
|
|----sampleupgrade (a sample upgrade file)