README.setup revision 5deb404a3d276c42ef3e4adef5e584211ab1e8dd
af062818b47340eef15700d2f0211576ba3506eevboxsync------------------------------------------------------------------------------
af062818b47340eef15700d2f0211576ba3506eevboxsyncDO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
af062818b47340eef15700d2f0211576ba3506eevboxsyncCopyright (c) 2007 Sun Microsystems Inc. All Rights Reserved
af062818b47340eef15700d2f0211576ba3506eevboxsyncThe contents of this file are subject to the terms
af062818b47340eef15700d2f0211576ba3506eevboxsyncof the Common Development and Distribution License
af062818b47340eef15700d2f0211576ba3506eevboxsync(the License). You may not use this file except in
af062818b47340eef15700d2f0211576ba3506eevboxsynccompliance with the License.
af062818b47340eef15700d2f0211576ba3506eevboxsyncYou can obtain a copy of the License at
af062818b47340eef15700d2f0211576ba3506eevboxsynchttps://opensso.dev.java.net/public/CDDLv1.0.html or
af062818b47340eef15700d2f0211576ba3506eevboxsyncSee the License for the specific language governing
af062818b47340eef15700d2f0211576ba3506eevboxsyncpermission and limitations under the License.
af062818b47340eef15700d2f0211576ba3506eevboxsyncWhen distributing Covered Code, include this CDDL
af062818b47340eef15700d2f0211576ba3506eevboxsyncHeader Notice in each file and include the License file
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncIf applicable, add the following below the CDDL Header,
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncwith the fields enclosed by brackets [] replaced by
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncyour own identifying information:
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync"Portions Copyrighted [year] [name of copyright owner]"
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync$Id: README.setup,v 1.15 2008/10/09 23:48:21 ww203982 Exp $
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync------------------------------------------------------------------------------
af062818b47340eef15700d2f0211576ba3506eevboxsyncPortions Copyrighted 2011 ForgeRock AS
af062818b47340eef15700d2f0211576ba3506eevboxsync------------------------------------------------------------------------------
af062818b47340eef15700d2f0211576ba3506eevboxsync====================================================
af062818b47340eef15700d2f0211576ba3506eevboxsyncThis file contains information on installing and using ssoAdminTools.zip.
af062818b47340eef15700d2f0211576ba3506eevboxsyncIt is assumed that OpenAM Server is available.
af062818b47340eef15700d2f0211576ba3506eevboxsyncTable of contents:
af062818b47340eef15700d2f0211576ba3506eevboxsync-----------------
af062818b47340eef15700d2f0211576ba3506eevboxsync1. Supported versions of Java Runtime
af062818b47340eef15700d2f0211576ba3506eevboxsync3. What does this package contain?
af062818b47340eef15700d2f0211576ba3506eevboxsync1. Supported versions of Java Runtime
af062818b47340eef15700d2f0211576ba3506eevboxsync-------------------------------------
af062818b47340eef15700d2f0211576ba3506eevboxsyncJava Runtime Environment 1.5 or higher.
af062818b47340eef15700d2f0211576ba3506eevboxsync2. What does this package contain?
af062818b47340eef15700d2f0211576ba3506eevboxsync----------------------------------
af062818b47340eef15700d2f0211576ba3506eevboxsync|----README (this file)
af062818b47340eef15700d2f0211576ba3506eevboxsync| |----*.jar (binaries needed for the scripts)
af062818b47340eef15700d2f0211576ba3506eevboxsync| |----*.properties (properties file for binaries)
af062818b47340eef15700d2f0211576ba3506eevboxsync|----setup (setup script for linux and unix)
af062818b47340eef15700d2f0211576ba3506eevboxsync|----setup.bat (setup script for windows)
af062818b47340eef15700d2f0211576ba3506eevboxsync|----template
af062818b47340eef15700d2f0211576ba3506eevboxsync| |----unix/bin/*.template (template of scripts for unix and linux)
af062818b47340eef15700d2f0211576ba3506eevboxsync| |----windows/bin/* (required windows specific libraries)
af062818b47340eef15700d2f0211576ba3506eevboxsync-------------------------------
af062818b47340eef15700d2f0211576ba3506eevboxsyncBefore setting up ssoAdminTools.zip, JAVA_HOME environment variable needs to be
af062818b47340eef15700d2f0211576ba3506eevboxsyncinitialized to a path of a compatible Java Runtime.
af062818b47340eef15700d2f0211576ba3506eevboxsyncSteps involved in installing ssoAdminTools.zip are:
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsyncStep 1: Unzip ssoAdminTools.zip to the desired directory.
af062818b47340eef15700d2f0211576ba3506eevboxsyncStep 2: Go to the directory which has the ssoAdminTools.zip unzipped.
af062818b47340eef15700d2f0211576ba3506eevboxsync Run the setup command as follows:
af062818b47340eef15700d2f0211576ba3506eevboxsync "./setup" or "setup"
af062818b47340eef15700d2f0211576ba3506eevboxsync for Unix and Windows respectively.
af062818b47340eef15700d2f0211576ba3506eevboxsync Enter the configuration directory when prompted.
af062818b47340eef15700d2f0211576ba3506eevboxsync "Path to config files of OpenAM server [~/openam]:"
af062818b47340eef15700d2f0211576ba3506eevboxsync Enter the path to Debug Directory
589fd26cedb2b4ebbed14f2964cad03cc8ebbca2vboxsync "Debug Directory [~/ssoadm/debug]:"
af062818b47340eef15700d2f0211576ba3506eevboxsync Enter the path to the Log Directory
af062818b47340eef15700d2f0211576ba3506eevboxsync "Log Directory [~/ssoadm/log]:"
af062818b47340eef15700d2f0211576ba3506eevboxsyncStep 3: After step 2 is performed, the CLIs can be run under the following
af062818b47340eef15700d2f0211576ba3506eevboxsync <TOOLS_DIR>/<OPENAM_INSTANCE_NAME>/bin
af062818b47340eef15700d2f0211576ba3506eevboxsync where <TOOLS_DIR> is the directory which has ssoAdminTools.zip unzipped
af062818b47340eef15700d2f0211576ba3506eevboxsync (ie: current directory), and <OPENAM_INSTANCE_NAME> is the deployment
af062818b47340eef15700d2f0211576ba3506eevboxsync URI of OpenAM.