{{% toc %}}
The general layout for ApacheDS is fairly simple and consists in two major concepts:
The installation is where are stored all files essential to ApacheDS like the launch script, libraries, eventually a service wrapper (depending on the kind of installer used).
The most common installation, shared by all ApacheDS installers, can be described as follows:
[Installation-Layout] |- bin/ |- apacheds (or 'apacheds.exe' on Windows) |- wrapper (or 'wrapper.exe' on Windows) |- conf/ |- wrapper.conf |- lib/ |- apacheds-service-${version}.jar |- apacheds-wrapper-${version}.jar |- libwrapper.jnilib (or 'libwrapper.so', or 'libwrapper.dll' depending on the platform) |- wrapper-3.2.3.jar |- LICENSE |- NOTICE
ApacheDS is built to be able to run multiple instances of the server at the same time, which means that optionally an instances folder can be found in the installation layout (or elsewhere on disk depending on the platform). In that folder, can be found a single or multiple directories, all sharing the same layout, corresponding to all ApacheDS instance (one directory per instance, named by the id of the instance).
Here's how this instance layout can be described:
[Instance-Layout] |- cache/ |- [...] |- conf/ |- config.ldif |- log4j.properties |- wrapper.conf |- log/ |- apacheds.log |- wrapper.log |- partitions/ |- example/ |- [...] |- schema/ |- [...] |- system/ |- [...]
Depending on the type of distribution used to install ApacheDS, the layout varies to adapt as best as possible to the specificities of each platform.
The Archive distribution consist of a compressed directory containing everything needed to run ApacheDS. It doesn't install on the machine and does not require any extra permission (root user, installer password, etc.). The directory is simply unarchived and ApacheDS is ready to be launched.
The installation layout is a bit simpler for this kind of distribution since no wrapper is distributed, the application being run in a terminal or via the .bat script.
[Installation-Layout] |- bin/ |- apacheds.bat |- apacheds.sh |- cpappend.bat |- instances/ |- lib/ |- apacheds-service-${version}.jar |- LICENSE |- NOTICE
The Windows installer uses the general installation and instances layout.
By default, the installation directory is:
C:\Program Files\ApacheDS
An instances/ directory in the installation layout holds all ApacheDS instances (an instance named default is provided by default).
ApacheDS is registered as a service on Windows. Operations on the service can be achieved in the Services utility which is accessible via Start > Contol Panel > Administration Tools > Services.
The Mac OS X installer uses the general installation and instances layout.
By default, the installation directory is:
/opt/apacheds-${version}
All ApacheDS instances are located in a directory at the following location (an instance named default is provided by default):
/var/lib/apacheds-${version}
The installer also adds a shortcut launch script for the default instance at:
/etc/init.d/apacheds-${version}-default
NOTE: The ApacheDS Linux Binary installer lets the user decide the locations of the installation directory, the instances directory and the default instance launch script. The locations above refer to the default location and need to be adapted to whatever path was chosen during the installation.
The Mac OS X installer uses the general installation and instances layout.
By default, the installation directory is:
/usr/local/apacheds-${version}
An instances/ directory in the installation layout holds all ApacheDS instances (an instance named default is provided by default).
The installer also adds a shortcut to the command in the bin directory called “apacheds”, accessible directly in a terminal and located at:
/usr/bin/apacheds