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