= OpenDS Installation =

**Summary**: This post describes the installation and configuration of the OpenDS 2.2.0 directory server on AIX.. \\
**Date**: Around 2012 \\
**Refactor**: 8 March 2025: Checked links and formatting. \\
[{{tag>opends ldap}}]

== Installation ==

^ LDAP Listener Port | 389 |
^ Administration Connector Port | 4444 |
^ LDAP Secure Access | disabled |
^ Root User DN | cn=manager |
^ Directory Data | Create New Base DN o=company.local |
^ Base DN Data | Only Create Base Entry (o=company.local) |

* Download OpenDS 2.2.0 from the [[http://www.opends.org/promoted-builds/2.2.0/OpenDS-2.2.0.zip |OpenDS website]] - This does not exist anymore
* Unpack (as root, like [[aixunzip|this]]) under /opt and start setup

<code bash>
export OPENDS_JAVA_HOME=/usr/java5
cd /opt/OpenDS-2.2.0/bin
./setup
</code>

The installer will start in console mode:

<code>
What would you like to use as the initial root user DN for the Directory Server? [cn=Directory Manager]:
cn=manager

Please provide the password to use for the initial root user:

Please re-enter the password for confirmation:

On which port would you like the Directory Server to accept connections from
LDAP clients? [389]:

On which port would you like the Administration Connector to accept
connections? [4444]:

What do you wish to use as the base DN for the directory data?
[dc=example,dc=com]: o=company.local

Options for populating the database:

    1)  Only create the base entry
    2)  Leave the database empty
    3)  Import data from an LDIF file
    4)  Load automatically-generated sample data

Enter choice [1]: 1

Do you want to enable SSL? (yes / no) [no]:

Do you want to enable Start TLS? (yes / no) [no]:

Do you want to start the server when the configuration is completed? (yes /no) [yes]:
</code>

Verify the logfile under /tmp/opends-setup-*.log for errors during setup

== Configuration ==

This section describes the configuration settings for filesystems:

Stop the directory server

<code bash>
/opt/OpenDS-2.2.0/bin/stop-ds -D cn=manager -w <secret>
</code>
and continue with the steps listed below.

=== Filesystem Settings ===

Create the data, log and dump directories for the directory server

<code bash>
mkdir -p /var/data/opends /var/backup/opends /var/log/opends /var/dump/opends
</code>

=== Link Directories ===

Move data and link the log, dump and data directories

<code bash>
cd /opt/OpenDS-2.2.0

mv db/* /var/data/opends
rmdir db
ln -sf /var/data/opends db

mv logs/* /var/log/opends
rmdir logs/
ln -sf /var/log/opends/ logs

mv bak/* /var/backup/opends
rmdir bak
ln -sf /var/backup/opends/ bak
</code>

After linking the directories, your OpenDS-2.2.0 base directory should contain the following (linked) contents:
<code teraterm>
lrwxrwxrwx   1 root     system           19 Sep 20 14:01 bak -> /var/backup/opends/
lrwxrwxrwx   1 root     system           16 Sep 20 14:00 db -> /var/data/opends
lrwxrwxrwx   1 root     system           16 Sep 20 14:00 logs -> /var/log/opends/
</code>

== Runtime Operations ==

This section explains how to start, stop, backup, restore and request status information from the directory server.

=== Server Status ===

* To see basic server configuration status and configuration you can launch

<code bash>
/opt/OpenDS-2.2.0/bin/status
</code>

=== Start the Server ===

As root, run the command

<code bash>
/opt/OpenDS-2.2.0/bin/start-ds
</code>

After startup, verify the following log entries (printed to the console)
<code teraterm>
[20/Sep/2010:16:04:37 +0200] category=CORE severity=NOTICE msgID=458891 msg=The Directory Server has sent an alert notification generated by class org.opends.server.core.DirectoryServer (alert type org.opends.server.DirectoryServerStarted, alert ID 458887):  The Directory Server has started successfully
</code>

=== Stop the Server ===

Run the command
<code bash>
/opt/OpenDS-2.2.0/bin/-D cn=manager -w <secret>
</code>

== Backup and Restore Operations ==

=== Backup LDAP ===

As root:
<code bash>
/opt/OpenDS-2.2.0/bin/backup --backupAll --backupDirectory /var/backup/opends -D cn=Manager -w <secret>
</code> This will create a backup of all backends (schema, admin & userRoot).

=== List Available Backups ===

To list available backups for a backend to resolve the backupID, run the command
<code bash>
/opt/OpenDS-2.2.0/bin/restore --listBackups --backupDirectory /var/backup/opends/userRoot
</code>
which will generate the output
<code teraterm>
Backup ID:          20100920153005Z
Backup Date:        20/Sep/2010:17:30:05 +0200
Is Incremental:     false
Is Compressed:      false
Is Encrypted:       false
Has Unsigned Hash:  false
Has Signed Hash:    false
Dependent Upon:     none
</code>

=== Restore Specific Backend ===

To restore a specific backend use the backupID in the step above and run
<code bash>
/opt/OpenDS-2.2.0/bin/restore --backupDirectory /var/backup/opends/userRoot --backupID 20100920153005Z
</code>

=== Create a LDIF Backup ===

See [[opendsldifexport]]

=== Restore an External LDIF Dump ===

See [[opendsrestore]]