chap-install.xml revision d1a1c16f546ed980d06b400fe4f7a0c050740c52
640b2adac05bb7f5e9fba064434c91852c3a72e6nd<?xml version="1.0" encoding="UTF-8"?>
8e34905974b7a442a55adac3b3fdb196c389e807takashi<!--
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! CCPL HEADER START
640b2adac05bb7f5e9fba064434c91852c3a72e6nd !
8e34905974b7a442a55adac3b3fdb196c389e807takashi ! This work is licensed under the Creative Commons
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! Attribution-NonCommercial-NoDerivs 3.0 Unported License.
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! To view a copy of this license, visit
8e34905974b7a442a55adac3b3fdb196c389e807takashi ! http://creativecommons.org/licenses/by-nc-nd/3.0/
8e34905974b7a442a55adac3b3fdb196c389e807takashi ! or send a letter to Creative Commons, 444 Castro Street,
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! Suite 900, Mountain View, California, 94041, USA.
6e89d4f6c259afc94f8806c74a33a8fe81392499sf !
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! You can also obtain a copy of the license at
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! legal/CC-BY-NC-ND.txt.
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! See the License for the specific language governing permissions
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! and limitations under the License.
640b2adac05bb7f5e9fba064434c91852c3a72e6nd !
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! If applicable, add the following below this CCPL HEADER, with the fields
640b2adac05bb7f5e9fba064434c91852c3a72e6nd ! enclosed by brackets "[]" replaced with your own identifying information:
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive ! Portions Copyright [yyyy] [name of copyright owner]
8e34905974b7a442a55adac3b3fdb196c389e807takashi !
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive ! CCPL HEADER END
ef685e00a47967e27d89709461728a229d762172nd !
ef685e00a47967e27d89709461728a229d762172nd ! Copyright 2011 ForgeRock AS
ef685e00a47967e27d89709461728a229d762172nd !
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive-->
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive<chapter xml:id='chap-install'
51853aa2ebfdf9903a094467e1d02099f143639daaron xmlns='http://docbook.org/ns/docbook'
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive version='5.0' xml:lang='en'
6e89d4f6c259afc94f8806c74a33a8fe81392499sf xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive xsi:schemaLocation='http://docbook.org/ns/docbook http://docbook.org/xml/5.0/xsd/docbook.xsd'
b44815871de48215476ad1d4cc46d3f99da532a5erikabele xmlns:xlink='http://www.w3.org/1999/xlink'
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive xmlns:xinclude='http://www.w3.org/2001/XInclude'>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <title>Installing and Starting OpenIDM Services</title>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <!-- TODO: Any (new) information in this chapter belongs in the installation
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive guide rather than the admin guide. -->
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive
8e34905974b7a442a55adac3b3fdb196c389e807takashi <para>A short description of the install procedure follows below. For a more
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive detailed description including some sample configurations please consult the
ef685e00a47967e27d89709461728a229d762172nd install guide. For exact prerequisites like JVM versions please consult the
ef685e00a47967e27d89709461728a229d762172nd release notes.</para>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <section>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <title>Install OpenIDM</title>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <para>Installing OpenIDM is as simple as to download the openidm.zip file and
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive unzip the archive. The latest build can be fould here: <link
6e89d4f6c259afc94f8806c74a33a8fe81392499sf xlink:href='http://forgerock.org/openidm.html'>download page.</link></para>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive </section>
b44815871de48215476ad1d4cc46d3f99da532a5erikabele <section>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <title>Uninstall OpenIDM</title>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <para>To uninstall OpenIDM simply remove the extracted folder. Eventually drop the
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive database schema "openidm" if using an external jdbc repository. </para>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive </section>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <section>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <title>Start and Stop OpenIDM</title>
dcbfc7bd0f8aaeea6833646813e948324fdc79a0rbowen <section>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <title>Start and Stop OpenIDM in Interactive Mode</title>
17ca00f92106c825382359ebf0a754f8df21e316rbowen <para>The simplest way to start OpenIDM is to execute the start.sh script
dcbfc7bd0f8aaeea6833646813e948324fdc79a0rbowen (or the run.bat on windows). This will start OpenIDM in a mode where it will
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive report all out put to the OSGI console. The console also accepts OSGI commands like
17ca00f92106c825382359ebf0a754f8df21e316rbowen "scr list" in this mode. OpenIDM can simply be started with: </para>
17ca00f92106c825382359ebf0a754f8df21e316rbowen <programlisting>/start</programlisting>
dcbfc7bd0f8aaeea6833646813e948324fdc79a0rbowen <para>To stop OpenIDM in this mode type the following on the OSGI console:</para>
6e89d4f6c259afc94f8806c74a33a8fe81392499sf <programlisting>->shutdown</programlisting>
dcbfc7bd0f8aaeea6833646813e948324fdc79a0rbowen </section>
dcbfc7bd0f8aaeea6833646813e948324fdc79a0rbowen <section>
dcbfc7bd0f8aaeea6833646813e948324fdc79a0rbowen <title>Start OpenIDM in the Background</title>
dcbfc7bd0f8aaeea6833646813e948324fdc79a0rbowen <para>As prerequisite of starting OpenIDM in the background, the ConsoleHandler
dcbfc7bd0f8aaeea6833646813e948324fdc79a0rbowen of OSGI must be disabled. This can be done in one of the following ways:</para>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <itemizedlist>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <listitem><para>In conf/logging.properties set java.util.logging.ConsoleHandler.level = OFF</para></listitem>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <listitem><para>The ConsoleHandler is removed from the list of handlers in the same file.</para></listitem>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive </itemizedlist>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <para>OpenIDM can then be started in the background with: </para>
8e34905974b7a442a55adac3b3fdb196c389e807takashi <programlisting>/start &amp;</programlisting>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <para>Stopping the instanc will now be done with the stop command: </para>
ef685e00a47967e27d89709461728a229d762172nd <programlisting>/stop</programlisting>
ef685e00a47967e27d89709461728a229d762172nd </section>
ef685e00a47967e27d89709461728a229d762172nd </section>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive <section>
222f0f03c2f9ee6343c18f80f0cb6e9aad21bc58slive <title>Use MySQL for the Repository</title>
222f0f03c2f9ee6343c18f80f0cb6e9aad21bc58slive <para>Please see the chapter "Setting up the Repository" on how to connect to a
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive different repository database than the built in OrientDB.</para>
6e89d4f6c259afc94f8806c74a33a8fe81392499sf </section>
a27e9e05958bc51ea09edb8d8d862fe8b125313bslive</chapter>
b44815871de48215476ad1d4cc46d3f99da532a5erikabele