You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by sz...@apache.org on 2010/09/05 18:20:06 UTC

svn commit: r992814 - in /directory/apacheds-manuals/trunk/src/basic-user-guide: ./ images/

Author: szoerner
Date: Sun Sep  5 16:20:05 2010
New Revision: 992814

URL: http://svn.apache.org/viewvc?rev=992814&view=rev
Log:
Added content for connection with Apache Directory Studio

Added:
    directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_1.png   (with props)
    directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_2.png   (with props)
    directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_3.png   (with props)
    directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_4.png   (with props)
    directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_1.png   (with props)
    directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_2.png   (with props)
    directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_3.png   (with props)
Modified:
    directory/apacheds-manuals/trunk/src/basic-user-guide/handling-of-data-1-connecting.xml

Modified: directory/apacheds-manuals/trunk/src/basic-user-guide/handling-of-data-1-connecting.xml
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/handling-of-data-1-connecting.xml?rev=992814&r1=992813&r2=992814&view=diff
==============================================================================
--- directory/apacheds-manuals/trunk/src/basic-user-guide/handling-of-data-1-connecting.xml (original)
+++ directory/apacheds-manuals/trunk/src/basic-user-guide/handling-of-data-1-connecting.xml Sun Sep  5 16:20:05 2010
@@ -29,8 +29,151 @@ under the License.
 
   <title>Connecting to a server</title>
   
+  <para>
+  This section describes how to connect to a running ApacheDS server remotely with various clients
+  in order to browse and manipulate your directory data. In fact there are many options. 
+  Basically, you can also use any standard compliant LDAP client (free or commercial) to explore your directory.
+  </para>
+  
   <section id="Connecting to a server Studio">
      <title>Apache Directory Studio</title>
+     
+     <para>
+     Apache Directory Studio is a modern, Eclipse RCP based LDAP Client Application.
+     Development happens within a subproject of Apache Directory.
+     You can download it from it's homepage http://directory.apache.org/studio/, which contains documentation as well.
+     This section only shows how to connect to our sample directory, and import the LDIF data shipped with this guide. 
+     </para>
+     
+     <section>
+       <title>Connect to ApacheDS</title>
+       
+       <para>
+       After starting up Apache Directory Studio open the LDAP Browser perspective.
+       </para>
+       
+       <para>
+       In order to connect to our sample directory server, open the New Connection wizard. 
+       This can be done by invoking the corresponding action in the Connections view (see screen below).
+       </para>
+       
+       <figure>
+          <title>Apache Directory Studio: New Connection ...</title>
+          <mediaobject>
+            <imageobject>
+              <imagedata
+                fileref="images/studio_conn_1.png" />
+            </imageobject>
+          </mediaobject>
+       </figure>
+        
+       <para>
+       A wizard appears (screenshot below). 
+       It provides input fields for a connection name, hostname and port. Enter the values (adjust them your needs), and 
+       click Next to continue.
+       </para>
+       
+       <figure>
+          <title>Apache Directory Studio: New Connection Wizard</title>
+          <mediaobject>
+            <imageobject>
+              <imagedata
+                fileref="images/studio_conn_2.png" />
+            </imageobject>
+          </mediaobject>
+       </figure>
+       
+       <para>
+       On the authentication page (screenshot below) you provide credentials for the user to connect.
+       Because currently no user is imported to your directory, you have to use the administrator to authenticate. 
+       Enter the DN of this user "uid=admin,ou=system" and the corresponding password. Click Next to continue.
+       </para>
+       
+       <figure>
+          <title>Apache Directory Studio: Authentication</title>
+          <mediaobject>
+            <imageobject>
+              <imagedata
+                fileref="images/studio_conn_3.png" />
+            </imageobject>
+          </mediaobject>
+       </figure>
+       
+       <important>
+       <title>Warning:</title>
+       <para>
+         Using this configuration with a so called "simple bind" causes Apache Directory Studio 
+         to send the credentials (User DN, password) unencrypted to the server.
+       </para>
+       </important>
+       
+       <figure>
+          <title>Apache Directory Studio: Browser Options</title>
+          <mediaobject>
+            <imageobject>
+              <imagedata
+                fileref="images/studio_conn_4.png" />
+            </imageobject>
+          </mediaobject>
+       </figure>
+       
+       <para>
+       On the options page (screenshot above) please enter the base DN for the "o=sevenSeas" partition. 
+       Pressing the Finish button causes to connect to the server.
+       </para>
+     </section>
+     
+     <section>
+       <title>Import sample data</title>
+       
+       <para>
+       In order to load the sample data to ApacheDS with Apache Directory Studio, you have to connect to the server first. 
+       Use uid=admin,ou=system to connect (you need write access) as depicted in the section above. 
+       After you successfully connected to your server, 
+       use the context menu in the LDAP Browser view and select Import | LDIF Import... to start the import wizard.
+       </para>
+       
+       <figure>
+          <title>Apache Directory Studio: Import LDIF data</title>
+          <mediaobject>
+            <imageobject>
+              <imagedata
+                fileref="images/studio_import_1.png" />
+            </imageobject>
+          </mediaobject>
+       </figure>
+       
+       <para>
+       The wizard appears (screenshot below). Use the Browse... button to open a file dialog and select the file with the sample data. 
+       Press the Finish button. Apache Directory Studio reads the LDIF file and performs some LDAP add operations against your server 
+       in order to create the entries within the sample partition. 
+       </para>
+       
+      <figure>
+          <title>Apache Directory Studio: Import LDIF Wizard</title>
+          <mediaobject>
+            <imageobject>
+              <imagedata
+                fileref="images/studio_import_2.png" />
+            </imageobject>
+          </mediaobject>
+       </figure>
+       
+       <para>
+       After a successful import, you can immediately browse the directory and see the imported entries:
+       </para>
+       
+       <figure>
+          <title>Apache Directory Studio: Browsing after successful import</title>
+          <mediaobject>
+            <imageobject>
+              <imagedata
+                fileref="images/studio_import_3.png" />
+            </imageobject>
+          </mediaobject>
+       </figure>
+      
+     </section>
   
   </section>
   
@@ -223,10 +366,18 @@ $
   <section id="Connecting to a server Resources">
      <title>Resources</title>
      <itemizedlist>
+     
+        <listitem>
+            Apache Directory Studio
+            <link xlink:href="http://directory.apache.org/studio/users-guide.html">User's Guides</link>
+        </listitem>
+     
+     
         <listitem>
             <link xlink:href="http://www.sun.com/download/products.xml?id=3ec28dbd">Download</link>
             Sun ONE Directory SDK for C, which contains the command line tools as well, for various platforms
         </listitem>
+        
        </itemizedlist>   
   </section>
   

Added: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_1.png
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_1.png?rev=992814&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_1.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_2.png
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_2.png?rev=992814&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_2.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_3.png
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_3.png?rev=992814&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_3.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_4.png
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_4.png?rev=992814&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_conn_4.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_1.png
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_1.png?rev=992814&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_1.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_2.png
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_2.png?rev=992814&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_2.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream

Added: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_3.png
URL: http://svn.apache.org/viewvc/directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_3.png?rev=992814&view=auto
==============================================================================
Binary file - no diff available.

Propchange: directory/apacheds-manuals/trunk/src/basic-user-guide/images/studio_import_3.png
------------------------------------------------------------------------------
    svn:mime-type = application/octet-stream