Advanced Client Configuration

This section details configurations required for running the Key Manager clients in certain environments, and other configurations for customizing the way in which clients perform. These configurations can be performed any time after the Key Manager clients have been set up for basic use.

Adjusting Command-Line Client Command Timeout

Key Manager command-line client commands will time out if a request takes too long to complete. The timeout period is used by the Key Manager system to terminate requests that may have stalled. However, in certain Key Manager setups, such as in situations with lots of network latency between the front-end machine and the administrator workstation, this may cause premature termination of requests.

To set the command-line client timeout period, perform the following on the Key Manager front ends to which the command-line clients are connecting:

1. Set the timeout period in the Nginx configuration file /etc/nginx/sites-available/sshmgr. In the Nginx configuration file, find the proxy_read_timeout setting under location /api/:

   location /api/ {
   ...
       proxy_read_timeout 1800;
   ...
   }

   Specify the desired timeout period under proxy_read_timeout. The timeout period is specified in seconds.

   Save your changes to the Nginx configuration file.

2. Restart the Nginx web server to apply the changes:

   # service nginx restart

   note

   The maximum timeout period for command-line client commands is also limited by the front-end-worker-timeout period, which is specified by the setting Frontend timeout in the Settings→General→Backend page of Key Manager settings. When increasing command-line client timeout periods, you should also verify that the front-end-worker-timeout period is set to a value equal to or greater than the command-line client timeout period. For more information about setting the front-end-worker-timeout period, see Setting the Front-end Worker Timeout Period.