man-opendj.xml revision 73adb2e3dbaa8a9f6448cefccb7933f68c3c7348
<?xml version="1.0" encoding="UTF-8"?>
<!--
! CDDL HEADER START
!
! The contents of this file are subject to the terms of the
! Common Development and Distribution License, Version 1.0 only
! (the "License"). You may not use this file except in compliance
! with the License.
!
! You can obtain a copy of the license at legal-notices/CDDLv1_0.txt
! See the License for the specific language governing permissions
! and limitations under the License.
!
! When distributing Covered Code, include this CDDL HEADER in each
! file and include the License file at legal-notices/CDDLv1_0.txt.
! If applicable, add the following below this CDDL HEADER, with the
! fields enclosed by brackets "[]" replaced with your own identifying
! information:
! Portions Copyright [yyyy] [name of copyright owner]
!
! CDDL HEADER END
!
! Copyright 2011-2015 ForgeRock AS.
!
-->
<refentry xml:id='opendj-5'
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
<info>
<copyright>
<year>2011-2015</year>
<holder>ForgeRock AS.</holder>
</copyright>
</info>
<refmeta>
<refentrytitle>opendj</refentrytitle><manvolnum>5</manvolnum>
<refmiscinfo class="software">OpenDJ</refmiscinfo>
<refmiscinfo class="version">${docTargetVersion}</refmiscinfo>
</refmeta>
<refnamediv>
<refname>OpenDJ</refname>
<refpurpose>a high-performance, highly-extensible, LDAPv3 compliant directory server</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
OpenDJ is a high-performance, highly-extensible, pure Java directory server.
The server is fully compliant with the LDAPv3 standard,
and passes all of the compliance, interoperability and security tests suites.
The directory server implements most of the standard
and experimental LDAP extensions defined in the IETF as RFCs or Internet-Drafts,
ensuring maximum interoperability with LDAP client applications.
</para>
<para>
OpenDJ software includes a rich set of APIs making the directory server easy to extend.
The directory server supports a loosely consistent multi-master replication model
that guarantees high availability of data for all operations, searches or updates.
While theoretically unlimited with regard to the number of masters,
the directory server has been stressed under heavy and durable load with four masters.
</para>
<itemizedlist>
<para>
OpenDJ software includes:
</para>
<listitem>
<para>
A graphical installation tool (<command>QuickSetup</command>) that enables you
to have a server configured, and up and running in less than 3 minutes
</para>
</listitem>
<listitem>
<para>
that displays server status information
and enables you to perform basic directory server administration
</para>
</listitem>
<listitem>
<para>
A rich set of command-line utilities to perform
all online administrative tasks both interactively and with scripts
</para>
</listitem>
<listitem>
<para>
Advanced security and password policies
</para>
</listitem>
<listitem>
<para>
Advanced backup and restore capabilities
</para>
</listitem>
<listitem>
<para>
Extensive user documentation
</para>
</listitem>
</itemizedlist>
</refsect1>
<refsect1>
<title>Usage</title>
<para>
See the <citetitle>Installation Guide</citetitle> for instructions
on getting started with OpenDJ directory server.
</para>
<itemizedlist>
<para>
To install the directory server from IPS packages perform the following steps:
</para>
<listitem>
<para>
As the root user, run the <command>configure</command> command
to create an instance of the directory server in a specific location,
running as a specific user.
</para>
</listitem>
<listitem>
<para>
Run the <command>setup</command> command as this user
to install and configure the directory server instance.
</para>
</listitem>
<listitem>
<para>
For additional configuration of the directory server,
use the <command>control-panel</command> and <command>dsconfig</command> commands.
</para>
</listitem>
</itemizedlist>
</refsect1>
</refentry>