Use the setup tool to install the server. The server needs to be started and stopped by the user who installed it.

Note:

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

  1. Log in as a user, other than root.
  2. Obtain the latest zip release bundle from Ping Identity and unpack it in a directory owned by this user. 
    $ unzip PingDataSync-<version>.zip
  3. Change to the server root directory. 
    $ cd PingDataSync
  4. Run the setup command. 
    $ ./setup
  5. Type yes to accept the End-User License Agreement and press Enter to continue.
  6. If adding this server to an existing PingDataSync topology, type yes, or press Enter to accept the default (no).
  7. Enter the fully qualified host name or IP address of the local host.
  8. Create the initial root user DN for PingDataSync, or press Enter to accept the default (cn=Directory Manager).
  9. Enter and confirm a password for this account.
  10. Press Enter to enable server services and the Administrative Console.
  11. Enter the port on which PingDataSync will accept connections from HTTPS clients, or press Enter to accept the default.
  12. Enter the port on which PingDataSync will accept connections from LDAP clients, or press Enter to accept the default.
  13. Press Enter to enable LDAPS, or enter no.
  14. Press Enter to enable StartTLS, or enter no.
  15. Select the certificate option for this server.
  16. Choose the desired encryption for the directory data, backups, and log files from the choices provided:
    • 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 option is primarily intended for testing purposes, especially when only testing with a single instance, or if you intend to import the resulting encryption settings definition into other instances in the topology.
    • Encrypt data with an imported encryption settings definition. This option is recommended if you are adding a new instance to an existing topology that has older server instances with data encryption enabled.
    • Do not encrypt server data.
  17. Choose the option for the amount of memory that should be allocated to the server.
  18. To start the server when the configuration is complete, press Enter for (yes).
  19. A Setup Summary is displayed. choose the option to setup the server with the listed parameters, change the parameters, or cancel the setup.

After the server configuration is complete, the create-sync-pipe-config tool can be run to configure the synchronization environment.

The PingDataSync Administrative Console enables browser-based server management, the dsconfig tool enables command line management, and the Configuration API enables management by third-party interfaces.