blob: cf4a4ed2c15361b4f4945b78241944e1f60aacb9 [file] [log] [blame]
<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "../../../docbook-xml/docbookx.dtd"[]>
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
<book>
<bookinfo>
<title>Apache Directory LDAP Studio</title>
<subtitle>Apache DS Configuration User's Guide</subtitle>
<releaseinfo>Version 0.8.0</releaseinfo>
<copyright>
<year>2007</year>
<holder>Apache Software Foundation</holder>
</copyright>
<legalnotice>
<literallayout class="monospaced">
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
<ulink url="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</ulink>
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
</literallayout>
</legalnotice>
</bookinfo>
<!-- GETTING STARTED CHAPTER -->
<chapter id="gettingstarted">
<title>Getting started</title>
<para>
This part of the guide provides you a sum up of the basic concepts of the Schemas Editor Plugin.
</para>
<!-- DOWNLOAD AND INSTALLATION SECTION -->
<section id="download_install">
<title>Download and installation</title>
<para>
Beside the integration in LDAP Studio the LDAP Studio Apache DS Configuration can also be installed
as a plug-in into a regular Eclipse installation. This section describes this
alternative.
</para>
<para>
Using the Eclipse Install/Update Manager is the easiest way to
install the LDAP Studio Apache DS Configuration plug-in.
From workbench menu choose
<emphasis role="strong">
<menuchoice>
<guimenu>Help</guimenu>
<guisubmenu>Software Updates</guisubmenu>
<guimenuitem>Find and Install...</guimenuitem>
</menuchoice>
</emphasis>
.
</para>
<para>
In the opened wizard choose
<emphasis role="strong">Search for new features to install</emphasis>
and click <emphasis role="strong">Next</emphasis>.
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/install_1.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
Next please specify the LDAP Studio update site. Click the <emphasis role="strong">New Remote Site...</emphasis> button.
In the dialog input the following and press <emphasis role="strong">OK</emphasis>:
<itemizedlist>
<listitem>Name: LDAP Studio Update Site</listitem>
<listitem>URL: http://directory.apache.org/ldapstudio/update/</listitem>
</itemizedlist>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/install_2.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
Make sure the new update site is checked an press
<emphasis role="strong">Finish</emphasis>.
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/install_3.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
Now the install manager checks the update site and presents the search results. Select the
feature you want to install - of course the LDAP Studio Apache DS Configuration - and click
<emphasis role="strong">Next</emphasis>.
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/install_4.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
Accept the license agreement, the LDAP Studio Apache DS Configuration is distributed under the
Apache License, Version 2.0.
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/install_5.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
In the next dialog ensure that the LDAP Studio Apache DS feature is selected and
click to <emphasis role="strong">Finish</emphasis>.
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/install_6.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
Now the install manager loads the necessary files. When download is finished
you have to verify the installation, please click to
<emphasis role="strong">Install</emphasis>.
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/install_7.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
<para>
After installation it is recommended to restart the Eclipse workbench.
</para>
</section>
<!-- OPEN SERVER CONFIGURATION SECTION -->
<section id="open_server_configuration">
<title>Open a Server Configuration</title>
<para>
To open a Server Configuration, locate the <emphasis role="strong">Apache DS</emphasis>
menu and select "<emphasis role="strong">Apache DS > Open Configuration File...</emphasis>".
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/open_configuration.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
</section>
<!-- CREATE A NEW SERVER CONFIGURATION SECTION -->
<section id="new_server_configuration">
<title>Create a new Server Configuration</title>
<para>
To create a new Server Configuration, locate the <emphasis role="strong">Apache DS</emphasis>
menu and select "<emphasis role="strong">Apache DS > New Configuration File</emphasis>".
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/new_configuration.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
</para>
</section>
<!-- CONFIGURATION EDITOR SECTION -->
<section id="configuration_editor">
<title>Configuration Editor</title>
<para>
The Configuration Editor for Apache DS consists in a 4 pages Editor:
<itemizedlist spacing="normal" mark="bullet">
<listitem>
The <emphasis><link linkend="configuration_editor_general">General</link></emphasis>
page allows you to set "general" settings about the server such as the server port,
administrator DN, password, etc...
</listitem>
<listitem>
The <emphasis><link linkend="configuration_editor_partitions">Partitions</link></emphasis>
page allows you to manage your server partitions.
</listitem>
<listitem>
The <emphasis><link linkend="configuration_editor_interceptors">Interceptors</link>
</emphasis> page allows you to manage your server interceptors.
</listitem>
<listitem>
The <emphasis><link linkend="configuration_editor_extended_operations">Extended Operations</link>
</emphasis> page allows you to manage your server extended operations handlers.
</listitem>
</itemizedlist>
</para>
<!-- CONFIGURATION EDITOR GENERAL PAGE SECTION -->
<section id="configuration_editor_general">
<title>General Page</title>
<para>
The <emphasis role="strong">General Page</emphasis> of the Configuration Editor allows you
to edit the server settings.
</para>
<para>
It contains four sections : <emphasis role="strong">Settings</emphasis>,
<emphasis role="strong">Binary Attribute</emphasis>, <emphasis role="strong">Limits</emphasis>
and <emphasis role="strong">Options</emphasis>.
</para>
<simplesect id="general_settings">
<title>Settings</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/general_page_settings.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>A <emphasis role="strong">Port</emphasis> is mandatory and must be an integer between
1 to 65535.</para>
<para>An <emphasis role="strong">Authentication</emphasis> method is mandatory and is at the
moment not editable and set to '<emphasis>Simple</emphasis></para>
<para>A <emphasis role="strong">Principal</emphasis> is mandatory and represents the DN of
the Administrator of the server.</para>
<para>A <emphasis role="strong">Password</emphasis> is mandatory and represents the password
of the Administrator of the server.</para>
<para>Check the <emphasis role="strong">Show Password</emphasis> checkbox to display the
password in a unhidden form.</para>
<para>Check the <emphasis role="strong">Allow Anymous Access</emphasis> checkbox to allow
anymous access on the server.</para>
</simplesect>
<simplesect id="general_binary_attributes">
<title>Binary Attributes</title>
<para>This section allows you to specify to the server the attribute types that you want to be handled as binary content.</para>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/general_page_binary_attributes.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>Use the <emphasis role="strong">Add...</emphasis>, <emphasis role="strong">Edit...</emphasis>
and <emphasis role="strong">Delete</emphasis> buttons to set your Binary Attributes.</para>
</simplesect>
<simplesect id="general_binary_attributes">
<title>Limits</title>
<para>This section allows you to specify the Limits of the server.</para>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/general_page_limits.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para><emphasis role="strong">Max. Time Limit</emphasis> lets you choose the maximum time that
should last a request (in milliseconds).</para>
<para><emphasis role="strong">Max. Size Limit</emphasis> lets you choose the maximum number
of entries that should be returned.</para>
<para><emphasis role="strong">Synchronization Period</emphasis> lets you choose the number of
milliseconds between two synchronizations.</para>
<para><emphasis role="strong">Max. Threads</emphasis> lets you choose the number of threads
that should be used by the server in its execution.</para>
</simplesect>
<simplesect id="general_options">
<title>Options</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/general_page_options.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>Check the <emphasis role="strong">Enable Access Control</emphasis> to enable Access Control
on the server.</para>
<para>Check the <emphasis role="strong">Enable NTP</emphasis> to enable NTP on the server.</para>
<para>Check the <emphasis role="strong">Enable Kerberos</emphasis> to enable Kerberos on the server.
</para>
<para>Check the <emphasis role="strong">Enable Change Password</emphasis> to enable Change Password
service on the server.</para>
<para>Check the <emphasis role="strong">Denormalize Operational Attributes</emphasis> to use a
more human readable form ('uid=admin,ou=system' instead of '0.9.2342.19200300.100.1.1=admin,2.5.4.11=system')
for Operational Attributes on the server.</para>
</simplesect>
</section>
<!-- CONFIGURATION EDITOR PARTITIONS PAGE SECTION -->
<section id="configuration_editor_partitions">
<title>Partitions Page</title>
<para>
The <emphasis role="strong">Partitions Page</emphasis> of the Configuration Editor allows you
to edit the server partitions.
</para>
<para>
The page is divided vertically in two parts.
</para>
<para>
You can choose the orientation of the page by clicking on the appropriate button ("Horizontal
Orientation"
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/horizontal_orientation.gif" format="GIF" />
</imageobject>
or "Vertical Orientation"
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/vertical_orientation.gif" format="GIF" />
</imageobject>) at the right of the page.
</para>
<para>
The left side of the page shows the partitions defined on the server. This is where you
can add or delete a partition.
</para>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/partitions_page_partitions_list.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>
The right side of the page display and lets you edit the details of the selected
partition in the left side.
</para>
<simplesect id="partitions_partition_details">
<title>Partition details</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/partitions_page_partition_details.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>A <emphasis role="strong">Name</emphasis> is mandatory for the partition.</para>
<para>A <emphasis role="strong">Cache Size</emphasis> is mandatory for the partition.</para>
<para>Check the <emphasis role="strong">Enable Optimizer</emphasis> checkbox to enable the
optimizer for the partition.</para>
<para>Check the <emphasis role="strong">Synchronization On Write</emphasis> checkbox to
enable the synchronization on write for the partition.</para>
</simplesect>
<simplesect id="partitions_context_entry">
<title>Context Entry</title>
<para>This section allows you to specify to the server the attribute/value pairs that will
be used for the Context Entry of the partition.</para>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/partitions_page_context_entry.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>Use the <emphasis role="strong">Add...</emphasis>, <emphasis role="strong">Edit...</emphasis>
and <emphasis role="strong">Delete</emphasis> buttons to set your values.</para>
</simplesect>
<simplesect id="partitions_indexed_attributes">
<title>Indexed Attributes</title>
<para>This section allows you to specify to the server the attributes that should be
indexed and the their cache size.</para>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/partitions_page_indexed_attributes.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>Use the <emphasis role="strong">Add...</emphasis>, <emphasis role="strong">Edit...</emphasis>
and <emphasis role="strong">Delete</emphasis> buttons to set the indexed attributes.</para>
</simplesect>
<para>
</para>
<para>
The following icons can appear in the Partitions Page.
</para>
<para>
<informaltable>
<tgroup cols="2">
<colspec colname="Icon" colwidth="1* "/>
<colspec colname="Description" colwidth="3*" />
<thead>
<row>
<entry>Icon</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center">
<mediaobject>
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/partition.gif" format="GIF" />
</imageobject>
</mediaobject>
</entry>
<entry>Standard Partition</entry>
</row>
<row>
<entry align="center">
<mediaobject>
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/partition_system.gif" format="GIF" />
</imageobject>
</mediaobject>
</entry>
<entry>System Partition</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
<!-- CONFIGURATION EDITOR INTERCEPTORS PAGE SECTION -->
<section id="configuration_editor_interceptors">
<title>Interceptors Page</title>
<para>
The <emphasis role="strong">Interceptors Page</emphasis> of the Configuration Editor allows you
to edit the server interceptors.
</para>
<para>
The page is divided vertically in two parts.
</para>
<para>
You can choose the orientation of the page by clicking on the appropriate button ("Horizontal
Orientation"
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/horizontal_orientation.gif" format="GIF" />
</imageobject>
or "Vertical Orientation"
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/vertical_orientation.gif" format="GIF" />
</imageobject>) at the right of the page.
</para>
<para>
The left side of the page shows the interceptors defined on the server. This is where you
can add or delete an interceptor.
</para>
<para>
You can also choose the order of the interceptors in the interceptors' chain using the "Up" and "Down" buttons.
</para>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/interceptors_page_interceptors_list.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>
The right side of the page display and lets you edit the details of the selected
partition in the left side.
</para>
<simplesect id="interceptors_interceptor_details">
<title>Interceptor details</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/interceptors_page_interceptor_details.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>A <emphasis role="strong">Name</emphasis> is mandatory for the interceptor.</para>
<para>The <emphasis role="strong">Class</emphasis> of the interceptor is mandatory.</para>
</simplesect>
<para>
</para>
<para>
The following icons can appear in the Interceptors Page.
</para>
<para>
<informaltable>
<tgroup cols="2">
<colspec colname="Icon" colwidth="1* "/>
<colspec colname="Description" colwidth="3*" />
<thead>
<row>
<entry>Icon</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center">
<mediaobject>
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/interceptor.gif" format="GIF" />
</imageobject>
</mediaobject>
</entry>
<entry>Interceptor</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
<!-- CONFIGURATION EDITOR EXTENDED OPERATIONS PAGE SECTION -->
<section id="configuration_editor_extended_operations">
<title>Extended Operations Page</title>
<para>
The <emphasis role="strong">Extended Operations Page</emphasis> of the Configuration Editor allows you
to edit the server extended operations.
</para>
<para>
The page is divided vertically in two parts.
</para>
<para>
You can choose the orientation of the page by clicking on the appropriate button ("Horizontal
Orientation"
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/horizontal_orientation.gif" format="GIF" />
</imageobject>
or "Vertical Orientation"
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/vertical_orientation.gif" format="GIF" />
</imageobject>) at the right of the page.
</para>
<para>
The left side of the page shows the extended operations defined on the server. This is where you
can add or delete an extended operation.
</para>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/extended_operations_page_extended_operations_list.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>
The right side of the page display and lets you edit the details of the selected
partition in the left side.
</para>
<simplesect id="extended_operations_extended_operation_details">
<title>Extended Operation details</title>
<screenshot>
<mediaobject>
<imageobject>
<imagedata scale="50"
fileref="images/gettingstarted/extended_operations_page_extended_operation_details.png" format="PNG" />
</imageobject>
</mediaobject>
</screenshot>
<para>The <emphasis role="strong">Class</emphasis> of the extended operation is mandatory.</para>
</simplesect>
<para>
</para>
<para>
The following icons can appear in the Extended Operations Page.
</para>
<para>
<informaltable>
<tgroup cols="2">
<colspec colname="Icon" colwidth="1* "/>
<colspec colname="Description" colwidth="3*" />
<thead>
<row>
<entry>Icon</entry>
<entry>Description</entry>
</row>
</thead>
<tbody>
<row>
<entry align="center">
<mediaobject>
<imageobject>
<imagedata contentdepth="1em" fileref="images/gettingstarted/extended_operation.gif" format="GIF" />
</imageobject>
</mediaobject>
</entry>
<entry>Extended Operation</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</section>
</section>
</chapter>
<!-- REFERENCE CHAPTER -->
<chapter id="reference">
<title>Reference</title>
<!-- RELEASE NOTES SECTION -->
<section id="release_notes">
<title>Release notes</title>
<para><emphasis role="strong">LDAP Studio 0.8.0</emphasis> (may 2007) : initial release</para>
</section>
</chapter>
</book>