setup
Prev | Directory Server Tools | Next

## Name

setup — install OpenDJ directory server

## Synopsis

`setup`

## Description

This utility can be used to setup the Directory Server.

## Options

The setup command takes the following options:

Command options:

`-a | --addBaseEntry`

  Indicates whether to create the base entry in the Directory Server database.

  Default: false

`--acceptLicense`

  Automatically accepts the product license (if present).

  Default: false

`--adminConnectorPort {port}`

  Port on which the Administration Connector should listen for communication.

  Default: 4444

`-b | --baseDN {baseDN}`

  Base DN for user information in the Directory Server. Multiple base DNs may be provided by using this option multiple times.

`--connectTimeout {timeout}`

  Maximum length of time (in milliseconds) that can be taken to establish a connection. Use '0' to specify no time out.

  Default: 30000

`-d | --sampleData {numEntries}`

  Specifies that the database should be populated with the specified number of sample entries.

  Default: 0

`-D | --rootUserDN {rootUserDN}`

  DN for the initial root user for the Directory Server.

  Default: cn=Directory Manager

`--generateSelfSignedCertificate`

  Generate a self-signed certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.

  Default: false

`-h | --hostname {host}`

  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.

  Default: localhost.localdomain

`-i | --cli`

  Use the command line install. If not specified the graphical interface will be launched. The rest of the options (excluding help and version) will only be taken into account if this option is specified.

  Default: false

`-j | --rootUserPasswordFile {rootUserPasswordFile}`

  Path to a file containing the password for the initial root user for the Directory Server.

`-l | --ldifFile {ldifFile}`

  Path to an LDIF file containing data that should be added to the Directory Server database. Multiple LDIF files may be provided by using this option multiple times.

`-N | --certNickname {nickname}`

  Nickname of the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.

`-O | --doNotStart`

  Do not start the server when the configuration is completed.

  Default: false

`-p | --ldapPort {port}`

  Port on which the Directory Server should listen for LDAP communication.

  Default: 1389

`-q | --enableStartTLS`

  Enable StartTLS to allow secure communication with the server using the LDAP port.

  Default: false

`-R | --rejectFile {rejectFile}`

  Write rejected entries to the specified file.

`-S | --skipPortCheck`

  Skip the check to determine whether the specified ports are usable.

  Default: false

`--skipFile {skipFile}`

  Write skipped entries to the specified file.

`-t | --backendType {backendType}`

  The type of the userRoot backend.

  Default: `je` for standard edition, `pdb` for OEM edition.

`-u | --keyStorePasswordFile {keyStorePasswordFile}`

  Certificate key store PIN file. A PIN is required when you specify to use an existing certificate (JKS, JCEKS, PKCS#12 or PKCS#11) as server certificate.

`--useBcfksKeystore {keyStorePath}`

  Path of a BCFKS key store containing the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.

`--useJavaKeystore {keyStorePath}`

  Path of a Java Key Store (JKS) containing a certificate to be used as the server certificate. This does not apply to the administration connector, which uses its own key store and certificate (default: config/admin-keystore and admin-cert).

`--useJCEKS {keyStorePath}`

  Path of a JCEKS containing a certificate to be used as the server certificate.

`--usePkcs11Keystore`

  Use a certificate in a PKCS#11 token that the server should use when accepting SSL-based connections or performing StartTLS negotiation.

  Default: false

`--usePkcs12keyStore {keyStorePath}`

  Path of a PKCS#12 key store containing the certificate that the server should use when accepting SSL-based connections or performing StartTLS negotiation.

`-w | --rootUserPassword {rootUserPassword}`

  Password for the initial root user for the Directory Server.

`-W | --keyStorePassword {keyStorePassword}`

  Certificate key store PIN. A PIN is required when you specify to use an existing certificate (JKS, JCEKS, PKCS#12 or PKCS#11) as server certificate.

`-x | --jmxPort {jmxPort}`

  Port on which the Directory Server should listen for JMX communication.

  Default: 1689

`-Z | --ldapsPort {port}`

  Port on which the Directory Server should listen for LDAPS communication. The LDAPS port will be configured and SSL will be enabled only if this argument is explicitly specified.

  Default: 1636

Utility input/output options:

`-n | --no-prompt`

  Use non-interactive mode. If data in the command is missing, the user is not prompted and the tool will fail.

  Default: false

`--noPropertiesFile`

  No properties file will be used to get default command line argument values.

  Default: false

`--propertiesFilePath {propertiesFilePath}`

  Path to the file containing default property values used for command line arguments.

`-Q | --quiet`

  Use quiet mode.

  Default: false

`-v | --verbose`

  Use verbose mode.

  Default: false

General options:

`-V | --version`

  Display Directory Server version information.

  Default: false

`-H | --help`

  Display this usage information.

  Default: false

## Exit Codes

0

  The command completed successfully.

> 0

  An error occurred.

## Examples

The following command installs OpenDJ directory server, enabling StartTLS and importing 100 example entries without interaction.

    $ /path/to/opendj/setup --cli -b dc=example,dc=com -d 100 \
     -D "cn=Directory Manager" -w password -h opendj.example.com -p 1389 \
     --generateSelfSignedCertificate --enableStartTLS -n

    OpenDJ version
     Please wait while the setup program initializes...

    See /var/.../opends-setup-484...561.log for a detailed log of this operation.

    Configuring Directory Server ..... Done.
    Configuring Certificates ..... Done.
    Importing Automatically-Generated Data (100 Entries) ......... Done.
    Starting Directory Server .......... Done.

    To see basic server configuration status and configuration, you can launch
     /path/to/opendj/bin/status

Prev | Up | Next
restore | Home | start-ds