You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@directory.apache.org by el...@apache.org on 2015/01/02 11:00:03 UTC

svn commit: r1648988 - /directory/site/trunk/content/apacheds/advanced-ug/2.2.5-generic-instance-layout.mdtext

Author: elecharny
Date: Fri Jan  2 10:00:03 2015
New Revision: 1648988

URL: http://svn.apache.org/r1648988
Log:
Added the Archive installation documentation

Modified:
    directory/site/trunk/content/apacheds/advanced-ug/2.2.5-generic-instance-layout.mdtext

Modified: directory/site/trunk/content/apacheds/advanced-ug/2.2.5-generic-instance-layout.mdtext
URL: http://svn.apache.org/viewvc/directory/site/trunk/content/apacheds/advanced-ug/2.2.5-generic-instance-layout.mdtext?rev=1648988&r1=1648987&r2=1648988&view=diff
==============================================================================
--- directory/site/trunk/content/apacheds/advanced-ug/2.2.5-generic-instance-layout.mdtext (original)
+++ directory/site/trunk/content/apacheds/advanced-ug/2.2.5-generic-instance-layout.mdtext Fri Jan  2 10:00:03 2015
@@ -23,4 +23,106 @@ Notice: Licensed to the Apache Software
     under the License.
 
 # 2.2.5 - Generic Instance Layout
-TODO...
+This installer just contain everything needed to start *ApacheDS* but it will not create a daemon not a Windows Service. Would one like to start *ApacheDS*, it will have to start the <em>apacheds.sh</em> or <em>apacheds.bat</bat> script shell.
+
+The installer is just a raeball that needs to be oepend and deflated at the selected position  :
+
+    tar xzpf apacheds-<version>.tar.gz
+
+or
+
+    gunzip apacheds-<version>.zip
+
+
+The layout is quite simple :
+
+<PRE>
+ apacheds-<version>
+      |
+      +-- lib/
+      |    |
+      |    +-- apacheds-service-<version>.jar
+      |
+      +-- instances/
+      |    |
+      |    +-- default/
+      |         |    
+      |         +-- run/
+      |         |    
+      |         +-- partitions/
+      |         |    
+      |         +-- log/
+      |         |    
+      |         +-- conf/
+      |         |    |
+      |         |    +-- log4j.properties
+      |         |    |
+      |         |    +-- config.ldif
+      |         |
+      |         +-- cache/
+      |
+      +-- bin/
+      |    |
+      |    +-- apacheds.bat
+      |    |
+      |    +-- apacheds.sh
+      |    |
+      |    +-- cpappend.bat
+      |    
+      +-- NOTICE
+      |
+      +-- LICENSE
+</PRE>
+
+In order to start the server, you will have to make the shell script executable (it is not by default):
+
+    $ chmod u+x apacheds-<version>/bin/apacheds.sh
+
+## Starting the server
+
+Starting the server is as simple as starting the script :
+
+    $ ./apacheds-<version>/bin/apacheds.sh start
+    Using ADS_HOME:    .../apacheds-<version>
+    Using JAVA_HOME:   /Library/Java/JavaVirtualMachines/jdk1.7.0_55.jdk/Contents/Home/
+
+    Starting ApacheDS instance 'default'...
+    $
+
+## Stopping the server
+
+The server is now started. To stop it, you have to execute this command :
+
+    $ ./apacheds-<version>/bin/apacheds.sh stop
+    Using ADS_HOME:    .../apacheds-<version>
+    Using JAVA_HOME:   /Library/Java/JavaVirtualMachines/jdk1.7.0_55.jdk/Contents/Home/
+
+    Stoping ApacheDS instance 'default' running as 23080
+    ApacheDS instance 'default' stopped successfully
+
+## Selection a different instance
+
+You can start many instances of the server, assuming you have duplicated the content of teh <em>instances/default</em> directory, and modified the <em>instances/default/conf/config.ldif</em> file (cahnge the transports so that there is no collision between servers)
+
+## Logs
+
+You can check what's going on in the <em>apacheds-<version>/instances/<instance-name>/log/apacheds.log</em> file, which is created using the configuration set in <em>apacheds-<version>/instances/<instance-name>/conf/log4j.properties</em>.
+
+Typically, when you start the server, you will get such log :
+
+    $ more apacheds.log
+    [10:53:05] WARN [org.apache.directory.server.core.DefaultDirectoryService] - You didn't change the admin password of directory service instance 'default'.  Please update the admin password as soon as possible to prevent a possible security breach.
+
+and from the <em>apacheds-<version>/instances/<instance-name>/log/apacheds.out</em> file, which contains everything the server writes on the console, you will read :
+
+    $ more apacheds.out 
+    [10:53:05] WARN [org.apache.directory.server.core.DefaultDirectoryService] - You didn't change the admin password of directory service instance 'default'.  Please update the admin password as soon as possible to prevent a possible security breach.
+               _                     _          ____  ____   
+              / \   _ __    ___  ___| |__   ___|  _ \/ ___|  
+             / _ \ | '_ \ / _` |/ __| '_ \ / _ \ | | \___ \  
+            / ___ \| |_) | (_| | (__| | | |  __/ |_| |___) | 
+           /_/   \_\ .__/ \__,_|\___|_| |_|\___|____/|____/  
+                   |_|                                       
+
+
+