PingDirectory

Installing the server

Use the setup tool to install the server.

About this task

The server must be started and stopped by the user who installed it.

A Windows installation requires that the Visual Studio 2010 runtime patch be installed prior to running the setup command.

Steps

  1. Sign on as a user other than root.

  2. Obtain the latest .zip release bundle from Ping Identity and extract it in a directory owned by this user.

    $ unzip PingData<server-version>.zip

  3. Change to the server root directory.

    $ cd PingData<server>

  4. Run the setup command.

    $ ./setup

  5. To accept the End-User License Agreement, enter yes or press Enter to accept the default.

  6. Read the installation process and prerequisites. Press Enter.

  7. Enter the port number of the PostgreSQL database instance to use to store monitoring or press Enter to accept the default port.

  8. Enter the directory to be used for PostgreSQL data files or press Enter to accept the default.

    The default is pgsql_data.

    If the name entered is a relative path name, it is created in the current working directory.

  9. Enter a name for the database administrative account or press Enter to accept the default.

    The setup tool creates a user (role) and database to be used by the PingDataMetrics server. These credentials are strictly for use by this tool during this session and are not retained.

  10. Enter and save a password.

  11. Choose the name of the PostgreSQL account to be associated with the PingDataMetrics server historical monitoring data or press Enter to accept the default.

    The default is metrics.

    The tool creates this user account using the administrative account specified in step 9.

  12. To enter and confirm a new password, type yes and provide a new password or press Enter to accept the default.

  13. Enter the fully-qualified host name for the server or press Enter to accept the default.

  14. Create the initial root user DN for the server or press Enter to accept the default.

  15. Enter and confirm a password for this account.

  16. Enter the port for HTTPS connection to the Platform APIs or press Enter to accept the default.

    The Platform APIs are the System for Cross-domain Identity Management (SCIM) and the Configuration.

  17. Enter the port on which the PingDataMetrics server accepts LDAP client connections or press Enter to accept the default.

  18. To enable LDAPS, enter yes or press Enter to accept the default.

    The default is no.

  19. If LDAPS is enabled, enter the port on which the server accepts LDAPS client connections or press Enter to accept the default.

    The default is 2636.

  20. To enable StartTLS, enter yes or press Enter to accept the default.

    The default is no.

  21. Select a certificate option for the server.

    Choose from:

    • Generate self-signed certificate. This is recommended for testing purposes only.

    • Use an existing certificate located on a Java KeyStore (JKS).

    • Use an existing certificate located on a PKCS12 KeyStore.

    • Use an existing certificate on a PKCS11 token.

      Depending on the option you choose, you might need additional information. If you choose the Java or the PKCS#12 KeyStore, you need the KeyStore path and PIN. If you choose the PKCS#11 token, you need the key PIN.

  22. Select the desired encryption for the directory data, backups, and log files.

    Choose from:

    • Encrypt data with a key generated from an interactively provided passphrase. Using a passphrase (obtained interactively or read from a file) is the recommended approach for new deployments, and you should use the same encryption passphrase when setting up each server in the topology.

    • Encrypt data with a key generated from a passphrase read from a file.

    • Encrypt data with a randomly generated key. This is intended for testing, or if you intend to import the resulting encryption settings definition into other instances in the topology.

    • Do not encrypt server data.

  23. Choose an option to assign the amount of memory that the server should allocate to the PingDataMetrics server or press Enter to accept the default.

  24. When the configuration is complete, press Enter (yes) to start the server.

  25. To install the PingDataMetrics server with the defined parameters, press Enter.

Next steps

After you install the PingDataMetrics server, access the Metrics landing page at https://host:HTTPS-port/view/index for access to the default dashboards, chart builder tool, and online documentation.