Installing This chapter covers installation of OpenDJ server software. This chapter includes the following procedures. Make sure you have a required Java environment installed as described in the Release Notes section, Java Environment. If your default Java environment is not appropriate, set OPENDJ_JAVA_HOME to the path to the correct Java environment, or set OPENDJ_JAVA_BIN to the absolute path of the java command. The OPENDJ_JAVA_BIN environment variable is useful if you have both 32-bit and 64-bit versions of the Java environment installed, and want to make sure you use the 64-bit version. Prevent anti-virus and intrusion detection systems from interfering with OpenDJ directory server. Downloading OpenDJ The following OpenDJ server software is available. OpenDJ-${docTargetVersion}.zip Cross-platform OpenDJ directory server installation files. OpenDJ-${docTargetVersion}.msi Microsoft Windows native installer for OpenDJ directory server. opendj_${docTargetVersion}-1_all.deb OpenDJ directory server native package for Debian and related Linux distributions. opendj-${docTargetVersion}-1.noarch.rpm OpenDJ directory server native package for Red Hat and related Linux distributions. OpenDJ-${docTargetVersion}-DSML.war Cross-platform OpenDJ DSML gateway web archive. opendj-rest2ldap-servlet-${docTargetVersion}-servlet.war Cross-platform OpenDJ REST LDAP gateway web archive. DSML gateway REST LDAP gateway If you plan to install OpenDJ DSML gateway or OpenDJ REST LDAP gateway, make sure you have an appropriate application server installed. For a list of supported application servers, see the Release Notes section, Application Servers. If you plan to configure SSL or TLS to secure network communications between the server and client applications, get a properly signed digital certificate that your client applications recognize, such as one that fits with your organization's PKI or one provided by a recognized certificate authority. To use the certificate during installation, the certificate must be located in a key store provided with Java (JKS, JCEKS, PKCS#12), or on a PKCS#11 token. To import a signed certificate into a key store, use the Java keytool command. For details see the Administration Guide section, Preparing For Secure Communications. Graphical user interface installation The OpenDJ setup command launches a wizard that lets you install OpenDJ directory server through a graphical user interface. If your environment picks up an old installation of Java, installation can fail. You might see an application error due to an old Java version. After completing the steps in , follow these steps: Unzip OpenDJ-${docTargetVersion}.zip, and then run the setup command. Find the setup command in the following locations: (UNIX|Linux) opendj/setup (Windows) opendj\setup.bat Follow the instructions in the wizard. The wizard presents the following screens: Welcome: summarizes the setup process and indicates the minimum required Java version License: presents the license agreement to accept before installing OpenDJ software Server Settings: prompts for basic server settings including installation path, host name, port numbers, secure connections, and credentials for the directory superuser (default bind DN: cn=Directory Manager) Topology Options: prompts for data replication options including whether this server is part of a replication topology, and if so the port number and security settings for this server, as well as the connection settings for a remote replica if available Directory Data: allows you to import or to generate LDAP directory data as part of the setup process This screen also allows you to select the backend type for data storage. Runtime Options: allows you to adjust JVM settings as part of the setup process, for example to allow OpenDJ to use more memory if necessary Review: presents current selections so that you can check everything is correct before running setup, with the option to start OpenDJ directory server after setup completes Finished: summarizes how setup completed, with the option to launch the OpenDJ Control Panel shows the top-level window with status information. OpenDJ Control Panel helps to manage directory data, LDAP schema, indexes, monitoring, and JVM runtime options through a graphical user interface.

OpenDJ Control Panel offers basic administration capabilities.

Command-line installation The OpenDJ setup --cli command launches a command-line installation that is interactive by default. After completing the steps in , follow these steps: Unzip OpenDJ-${docTargetVersion}.zip in the file system directory where you want to install the server. The setup command uses the directory where you unzipped the files as the installation directory, and does not ask you where to install OpenDJ. Therefore, if you want to install elsewhere on the file system, unzip the files in that location. Run the setup --cli command found in the /path/to/opendj directory. This command starts the setup program in interactive mode on the command line, prompting you for each option. Alternatively, use additional setup options to specify values for the options you choose during interactive mode, thus scripting the installation process. See setup --help and the notes below. Silent installation To perform a non-interactive, silent installation, provide all the options to configure OpenDJ, and then also use the -n or --no-prompt option. The setup command without the --cli option runs the graphical user interface installer. The following example shows interactive installation of OpenDJ directory server. $ /path/to/opendj/setup --cli READ THIS SOFTWARE LICENSE AGREEMENT CAREFULLY. BY DOWNLOADING OR INSTALLING THE FORGEROCK SOFTWARE, YOU, ON BEHALF OF YOURSELF AND YOUR COMPANY, AGREE TO BE BOUND BY THIS SOFTWARE LICENSE AGREEMENT. IF YOU DO NOT AGREE TO THESE TERMS, DO NOT DOWNLOAD OR INSTALL THE FORGEROCK SOFTWARE. ... Please read the License Agreement above. You must accept the terms of the agreement before continuing with the installation. Accept the license (Yes/No) [No]:Yes What would you like to use as the initial root user DN for the Directory Server? [cn=Directory Manager]: Please provide the password to use for the initial root user: Please re-enter the password for confirmation: Provide the fully-qualified directory server host name that will be used when generating self-signed certificates for LDAP SSL/StartTLS, the administration connector, and replication [opendj.example.com]: On which port would you like the Directory Server to accept connections from LDAP clients? [1389]: On which port would you like the Administration Connector to accept connections? [4444]: Do you want to create base DNs in the server? (yes / no) [yes]: Provide the backend type: 1) local-db 2) pdb Enter choice [1]: 2 Provide the base DN for the directory data: [dc=example,dc=com]: 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]: 3 Please specify the path to the LDIF file containing the data to import: /path/to/Example.ldif 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]: Setup Summary ============= LDAP Listener Port: 1389 Administration Connector Port: 4444 JMX Listener Port: LDAP Secure Access: disabled Root User DN: cn=Directory Manager Directory Data: Create New Base DN dc=example,dc=com. Base DN Data: Import Data from LDIF File (/path/to/Example.ldif) Start Server when the configuration is completed What would you like to do? 1) Set up the server with the parameters above 2) Provide the setup parameters again 3) Print equivalent non-interactive command-line 4) Cancel and exit Enter choice [1]: See /var/.../opendj-setup...log for a detailed log of this operation. Configuring Directory Server ..... Done. Importing LDIF file /path/to/Example.ldif ........... Done. Starting Directory Server ........... Done. To see basic server configuration status and configuration you can launch \ /path/to/opendj/bin/status Notes on the options follow. Initial root user DN The root user Distinguished Name identifies a user who can perform all operations allowed for the server, called root user due to the similarity to the UNIX root user. The default, cn=Directory Manager, is a well-known name. For additional protection, use a different name. Initial root user password The root user will use simple, password-based authentication. Later you can limit clear text access to avoid snooping, but for now use a strong password here unless this is a throwaway server. Fully-qualified directory server host name OpenDJ uses fully-qualified host name in self-signed certificates and for identification when you use replication. If you are installing a single server temporarily for evaluation, and are not concerned about replication and whether self-signed certificates can be trusted, then you can use an FQDN such as localhost.localdomain. Otherwise, use an FQDN that other hosts can resolve to reach your server. LDAP port The default for LDAP is 389. If you are working as a user who cannot open port 389, setup suggests 1389 by default. Administration port The default is 4444. This is the service port used to configure the server and to run tasks. Create base DNs You need a base Distinguished Name, such as dc=example,dc=com, to add directory data. If you already have LDIF, the base DN you want is the distinguished name suffix common to all entries in your LDIF. When you choose to create a base DN, the setup command also prompts you for a backend type, which identifies the implementation of the repository that holds your data. Later you can add more base DNs if your data belongs in more than one suffix. Import LDIF LDAP data interchange format (LDIF) is the standard text format for expressing LDAP data. If you have LDIF already, one reason you might not want to import the data at the same time you install is because your data uses attributes not defined in the default schema, and so you will wait to add schema definitions before you import. If you have a large data set to import, also increase the import cache size, which you can do by passing a Java properties file. You might also prefer to perform data import offline. Enable SSL and TLS Enabling Secure Sockets Layer or Transport Layer Security lets you protect the network traffic between directory clients and your server. SSL SSL requires its own, separate port for LDAPS traffic. The default port for LDAPS is 636. If you are working as a user who cannot open port 636, setup suggests 1636 by default. TLS TLS lets you use StartTLS to negotiate a secure connection between a client and server, starting from the same server port you configured for LDAP. X.509 certificates The digital certificate you need for SSL and TLS can be self-signed and created on the fly. Trouble is, client applications view self-signed certificates like fake IDs, and so do not trust them. Self-signed certificates for externally facing ports facilitate testing, but are not intended for production use. Start the server If you do not start the server during installation, you can use the /path/to/opendj/bin/start-ds command later. Run the status command to make sure your OpenDJ server is working as expected as shown in the following example. $ /path/to/opendj/bin/status >>>> Specify OpenDJ LDAP connection parameters Administrator user bind DN [cn=Directory Manager]: Password for user 'cn=Directory Manager': --- Server Status --- Server Run Status: Started Open Connections: 1 --- Server Details --- Host Name: opendj.example.com Administrative Users: cn=Directory Manager Installation Path: /path/to/opendj Version: OpenDJ ${docTargetVersion} Java Version: version Administration Connector: Port 4444 (LDAPS) --- Connection Handlers --- Address:Port : Protocol : State -------------:----------:--------- -- : LDIF : Disabled 0.0.0.0:161 : SNMP : Disabled 0.0.0.0:636 : LDAPS : Disabled 0.0.0.0:1389 : LDAP : Enabled 0.0.0.0:1689 : JMX : Disabled --- Data Sources --- Base DN: dc=example,dc=com Backend ID: userRoot Entries: 160 Replication: Disabled You can install OpenDJ in unattended and silent fashion, too. See the procedure, . You might close OpenDJ Control Panel, or decide to start it later after closing the setup wizard. To launch OpenDJ Control Panel, run the control-panel command. Depending on your host system, this command is one of the following. (Linux|UNIX) /path/to/opendj/bin/control-panel (Windows) C:\path\to\opendj\bat\control-panel.bat Windows installer (.msi) package You can install OpenDJ directory server on Windows systems by using the Windows installer package, OpenDJ-${docTargetVersion}.msi. Installing OpenDJ directory server from the Windows installer package is a two-stage process. First, you install the files by using the Windows installer package wizard. Second, you configure OpenDJ by using the setup command. Prevent anti-virus and intrusion detection systems from interfering with OpenDJ directory server. Install OpenDJ files in one of the following ways. Double-click the Windows installer package, OpenDJ-${docTargetVersion}.msi, to start the install wizard. In the Destination Folder screen, set the folder where the wizard installs OpenDJ directory server files. The default location is under Program Files on the system drive. For example if the system drive is C:, the default location is C:\Program Files (x86)\OpenDJ\, as the native executable is a 32-bit application, though you can run OpenDJ directory server with a 64-bit Java environment. Use the Microsoft msiexec.exe command to install the files. The following example installs OpenDJ directory server files under C:\OpenDJ-${docTargetVersion}, writing an installation log file, install.log, in the current folder. C:\>msiexec /i OpenDJ-${docTargetVersion}.msi /l* install.log /q OPENDJ=C:\OpenDJ-${docTargetVersion} Start the installation. When installation is finished, OpenDJ directory server files are found in the location you specified as Destination Folder. You must still run the setup command before you can use OpenDJ directory server. Browse to the Destination Folder, and double-click the setup command to start the OpenDJ setup wizard, and then follow the instructions on screen as described in . Debian (.deb) package On Debian and related Linux distributions such as Ubuntu, you can install OpenDJ directory server from the Debian package. Before you install OpenDJ, install a Java runtime environment if none is installed yet. $ sudo apt-get install default-jre Install the OpenDJ directory server package. $ sudo dpkg -i opendj_${docTargetVersion}-1_all.deb Selecting previously unselected package opendj. (Reading database ... 185569 files and directories currently installed.) Unpacking opendj (from opendj_${docTargetVersion}-1_all.deb) ... Setting up opendj (${docTargetVersion}) ... Adding system startup for /etc/init.d/opendj ... /etc/rc0.d/K20opendj -> ../init.d/opendj /etc/rc1.d/K20opendj -> ../init.d/opendj /etc/rc6.d/K20opendj -> ../init.d/opendj /etc/rc2.d/S20opendj -> ../init.d/opendj /etc/rc3.d/S20opendj -> ../init.d/opendj /etc/rc4.d/S20opendj -> ../init.d/opendj /etc/rc5.d/S20opendj -> ../init.d/opendj Processing triggers for ureadahead ... ureadahead will be reprofiled on next reboot The Debian package installs OpenDJ directory server in the /opt/opendj directory, generates service management scripts, adds documentation files under /usr/share/doc/opendj, and adds man pages under /opt/opendj/share/man. The files are owned by root by default, making it easier to have OpenDJ listen on ports 389 and 636. Configure OpenDJ directory server by using the command sudo /opt/opendj/setup. $ sudo /opt/opendj/setup --cli ... To see basic server configuration status and configuration you can launch /opt/opendj/bin/status Check OpenDJ directory server status. $ service opendj status $opendj status: > Running. $ sudo /opt/opendj/bin/status >>>> Specify OpenDJ LDAP connection parameters Administrator user bind DN [cn=Directory Manager]: Password for user 'cn=Directory Manager': --- Server Status --- Server Run Status: Started Open Connections: 1 --- Server Details --- Host Name: ubuntu.example.com Administrative Users: cn=Directory Manager Installation Path: /opt/opendj Version: OpenDJ ${docTargetVersion} Java Version: version Administration Connector: Port 4444 (LDAPS) --- Connection Handlers --- Address:Port : Protocol : State -------------:------------------------:--------- -- : LDIF : Disabled 0.0.0.0:161 : SNMP : Disabled 0.0.0.0:389 : LDAP (allows StartTLS) : Enabled 0.0.0.0:636 : LDAPS : Enabled 0.0.0.0:1689 : JMX : Disabled 0.0.0.0:8080 : HTTP : Disabled --- Data Sources --- Base DN: dc=example,dc=com Backend ID: userRoot Entries: 2002 Replication: Red Hat (.rpm) package On Red Hat and related Linux distributions such as Fedora and CentOS, you can install OpenDJ directory server from the RPM package. Log in as superuser to install the software. $ su Password: # Before you install OpenDJ, install a Java runtime environment if none is installed yet. You might need to download an RPM to install the Java runtime environment, and then install the RPM by using the rpm command. # rpm -ivh jre-*.rpm Install the OpenDJ directory server package. # rpm -i opendj-${docTargetVersion}-1.noarch.rpm Pre Install - initial install Post Install - initial install # The RPM package installs OpenDJ directory server in the /opt/opendj directory, generates service management scripts, and adds man pages under /opt/opendj/share/man. The files are owned by root by default, making it easier to have OpenDJ listen on ports 389 and 636. Configure OpenDJ directory server by using the command /opt/opendj/setup. # /opt/opendj/setup --cli ... To see basic server configuration status and configuration you can launch /opt/opendj/bin/status Check OpenDJ directory server status. # service opendj status opendj status: > Running. # /opt/opendj/bin/status >>>> Specify OpenDJ LDAP connection parameters Administrator user bind DN [cn=Directory Manager]: Password for user 'cn=Directory Manager': --- Server Status --- Server Run Status: Started Open Connections: 1 --- Server Details --- Host Name: fedora.example.com Administrative Users: cn=Directory Manager Installation Path: /opt/opendj Version: OpenDJ ${docTargetVersion} Java Version: version Administration Connector: Port 4444 (LDAPS) --- Connection Handlers --- Address:Port : Protocol : State -------------:------------------------:--------- -- : LDIF : Disabled 0.0.0.0:161 : SNMP : Disabled 0.0.0.0:389 : LDAP (allows StartTLS) : Enabled 0.0.0.0:636 : LDAPS : Enabled 0.0.0.0:1689 : JMX : Disabled 0.0.0.0:8080 : HTTP : Disabled --- Data Sources --- Base DN: dc=example,dc=com Backend ID: userRoot Entries: 2002 Replication: By default OpenDJ starts in run levels 2, 3, 4, and 5. # chkconfig --list | grep opendj ... opendj 0:off 1:off 2:on 3:on 4:on 5:on 6:off Silent installation You can install OpenDJ directory server by using the setup command with a properties file. Property names correspond to the option names, but without leading dashes. Options that take no arguments become boolean properties as in the following example: enableStartTLS=true If you use a properties file with multiple tools, prefix the property name with the tool name followed by a dot (.), in the following example: setup.rootUserPasswordFile=/tmp/pwd.txt The following steps demonstrate use of a properties file as part of a scripted installation process. Prepare your properties file. This procedure uses the following example properties file. # # Sample properties file to set up OpenDJ directory server # hostname =opendj.example.com ldapPort =1389 generateSelfSignedCertificate =true enableStartTLS =true ldapsPort =1636 jmxPort =1689 adminConnectorPort =4444 rootUserDN =cn=Directory Manager rootUserPassword =password baseDN =dc=example,dc=com ldifFile =/net/install/dj/Example.ldif #sampleData =2000 If you have multiple servers to install, consider scripting creation of the properties files. Prepare an installation script. $ cat /net/install/dj/1/setup.sh #!/bin/sh unzip -d /path/to /net/install/dj/OpenDJ-${docTargetVersion}.zip && cd /path/to/opendj ./setup --cli --propertiesFilePath /net/install/dj/1/setup.props \ --acceptLicense --no-prompt The properties file contains only installation options, and does not fully configure OpenDJ directory server. If you also want your script to configure OpenDJ directory server, follow a successful run of the setup command with dsconfig commands to configure the server. To run a series of configuration commands as a batch using the dsconfig command, use either the --batchFilePath file option, where file contains the configuration commands, or the --batch option to read from standard input as in the following example that creates a backend and sets up indexes. /path/to/opendj/bin/dsconfig \ --port 4444 \ --hostname opendj.example.com \ --bindDN "cn=Directory Manager" \ --bindPassword password \ --no-prompt \ --trustAll \ --batch <<END_OF_COMMAND_INPUT create-backend --backend-name newBackend \ --type pdb \ --set base-dn:"dc=example,dc=org" \ --set db-cache-percent:20 \ --set enabled:true create-backend-index --backend-name newBackend \ --type generic \ --set index-type:equality \ --set index-type:substring \ --index-name cn create-backend-index --backend-name newBackend \ --type generic \ --set index-type:equality \ --set index-type:substring \ --index-name sn create-backend-index --backend-name newBackend \ --type generic \ --set index-type:equality \ --index-name uid create-backend-index --backend-name newBackend \ --type generic \ --set index-type:equality \ --set index-type:substring \ --index-name mail END_OF_COMMAND_INPUT Run your installation script. $ /net/install/dj/1/setup.sh Archive: /net/install/dj/OpenDJ-${docTargetVersion}.zip creating: /path/to/opendj ... inflating: /path/to/opendj/setup inflating: /path/to/opendj/uninstall inflating: /path/to/opendj/upgrade READ THIS SOFTWARE LICENSE AGREEMENT CAREFULLY. BY DOWNLOADING OR INSTALLING THE FORGEROCK SOFTWARE, YOU, ON BEHALF OF YOURSELF AND YOUR COMPANY, AGREE TO BE BOUND BY THIS SOFTWARE LICENSE AGREEMENT. IF YOU DO NOT AGREE TO THESE TERMS, DO NOT DOWNLOAD OR INSTALL THE FORGEROCK SOFTWARE. ... Do you accept the License Agreement?yes See /var/folders/.../opendj-setup-....log for a detailed log of this operation. Configuring Directory Server ..... Done. Configuring Certificates ..... Done. Importing LDIF file /net/install/dj/Example.ldif ....... Done. Starting Directory Server ....... Done. To see basic server configuration status and configuration you can launch /path/to/opendj/bin/status At this point you can use OpenDJ directory server, or you can perform additional configuration. REST LDAP gateway The OpenDJ REST LDAP gateway functions as a web application in a web application container, running independently of OpenDJ. Alternatively, you can use the HTTP connection handler in OpenDJ directory server. For instructions see the Administration Guide procedure, To Set Up REST Access to OpenDJ Directory Server. You configure the gateway to access your directory service by editing the configuration file opendj-rest2ldap-servlet.json in the deployed OpenDJ REST LDAP gateway web application. Deploy opendj-rest2ldap-servlet-${sdkDocTargetVersion}-servlet.war according to the instructions for your application server. Edit opendj-rest2ldap-servlet.json where you deployed the gateway web application. The default JSON resource for the configuration includes both connection and authentication information, and also mappings. The mappings describe how the gateway translates between JSON and LDAP representations of directory data. The default mappings are built to work with generated example data and also the sample content in Example.ldif. At minimum adjust the following gateway configuration settings: primaryLDAPServers: Set to the correct directory server host names and port numbers. authentication: Set to the correct simple bind credentials. mappings: Make sure these match the directory data. For details on the configuration see the Reference topic, REST LDAP Configuration. When connecting to directory servers over LDAPS or LDAP and StartTLS, you can configure the trust manager to use a file-based trust store for server certificates that the gateway should trust. This allows the gateway to validate server certificates signed for example by a Certificate Authority not recognized by the Java environment when setting up LDAPS or StartTLS connections. See the Administration Guide section, Preparing For Secure Communications for an example showing how to use the Java keytool command to import a server certificate into a trust store file. Restart the REST LDAP gateway or the application server to make sure the configuration changes are taken into account. Make sure that your directory server is running, and then check that the gateway is connecting correctly. The following command reads Babs Jensen's entry through the gateway to a directory server holding data from Example.ldif. $ curl http://bjensen:hifalutin@opendj.example.com:8080/rest2ldap/users/bjensen { "_rev" : "000000002ee3b764", "schemas" : [ "urn:scim:schemas:core:1.0" ], "contactInformation" : { "telephoneNumber" : "+1 408 555 1862", "emailAddress" : "bjensen@example.com" }, "_id" : "bjensen", "name" : { "familyName" : "Jensen", "givenName" : "Barbara" }, "userName" : "bjensen@example.com", "displayName" : "Barbara Jensen", "manager" : [ { "_id" : "trigden", "displayName" : "Torrey Rigden" } ] } If you generated example data, Babs Jensen's entry is not included. Instead, try a URL such as http://user.0:password@opendj.example.com:8080/rest2ldap/users/user.0. DSML gateway The OpenDJ DSML gateway functions as a web application in a web application container. The DSML gateway runs independently of OpenDJ directory server. You configure the gateway to access your directory service by editing the ldap.host and ldap.port parameters in the gateway WEB-INF/web.xml configuration file. Deploy OpenDJ-${docTargetVersion}-DSML.war according to the instructions for your application server. Edit WEB-INF/web.xml to ensure the values for ldap.host and ldap.port are correct. Restart the web application container according to the instructions for your application server.