Xephr Administration Console
Home

The Home page is displayed when you log into the Xephr® Administration Console.  The following information is displayed.

Location: The current location within the administration console.

Xephr Version: the Xephr version and build number for this Xephr installation.

Licensed To: The name of the company to which the Xephr install is registered.  This information is obtained from the NDS Corporate database during install, using the serial number provided.

Address: The address for the company to which the Xephr install is registered.  This information is obtained from the NDS Corporate database during install, using the serial number provided.

City: The city for the company to which the Xephr install is registered.  This information is obtained from the NDS Corporate database during install, using the serial number provided.

State: The state for the company to which the Xephr install is registered.  This information is obtained from the NDS Corporate database during install, using the serial number provided.

Postal Code: the zip code or postal code for the company to which the Xephr install is registered.  This information is obtained from the NDS Corporate database during install, using the serial number provided.

Country: The country for the company to which the Xephr install is registered.  This information is obtained from the NDS Corporate database during install, using the serial number provided.

Contact: the primary contact for the company to which the Xephr install is registered.  This information is obtained from the NDS Corporate database during install, using the serial number provided.

Contact Phone: The primary phone number for the company to which the Xephr install is registered.  This information is obtained from the NDS Corporate database during install, using the serial number provided.

Contact eMail: The email address for the primary contact for the company to which the Xephr install is registered.  This information is obtained from the NDS Corporate database during install, using the serial number provided.

Set/Change Xephr Serial Number

Change Administrator Password

Server Settings

Restart Xephr Service

Log Out: Log out of the Xephr Administration Console.

Set/Change Xephr Serial Number

Select this link to set or change the Xephr Serial Number.  The Serial Number field contains the serial number provided during installation.  

  1. The location is the current location within the administration console.

  2. To change the serial number, in the Serial Number field, enter the Xephr serial number.

    When you update the serial number, and click on the Get License button, the serial number validation checks the serial number entered with the NDS Licensing server to retrieve the customer's information and generate the Xephr master record.  

  3. It is necessary to establish an http (web) connection with the NDS Licensing server or the validation will not occur and the Xephr installation will not operate.  In some environments, it is necessary to use a proxy server to gain http (web) access.  If your environment requires the use of a proxy server, complete the following steps.

    Set the Use Proxy to Connect to NDS Licensing Server checkbox to on.  Additional properties will be displayed.

  1. When all entries have been made, click on the Get License button.

  2. Click on Home on the left menu or Xephr in the Location string to get back to the home screen.

Change Administrator Password

Select this link to change the administrator user and password for the administration console.  

  1. The location is the current location within the administration console.

  2. In the Enter Old User ID field, enter the user ID for the current administrator log in.

  3. In the Enter Old Password field, enter the password for the current administrator log in.

  4. In the Enter New User ID field, enter the new user ID.

  5. In the Enter New Password field, enter the new password.

  6. In the Verify New Password field, re-enter the new password to verify it.

  7. Click on the Save button.

  8. Click on Home on the left menu or Xephr in the Location string to get back to the home screen.

Server Settings

Select this link to modify the server settings for the Xephr server.

WARNING: Changing values on this screen should be done with extreme care. Improper setup can render your Xephr Server inoperable!

All file paths on this page specify locations accessible to the Xephr server, either local or network shares (by mounting an NFS volume or mapping a Windows share to a drive letter).  When using a network share the Xephr server will throw errors if the share becomes unavailable, possibly shutting down the internal service.  For example, if the Backup path is pointing to an NFS share, and the remote host is shut down, Xephr will be unable to perform the backup.

Xephr runs on the Apache Tomcat application server.  For instructions on how to generate an SSL certificate and keystore, follow your certificate providers instructions for Apache Tomcat. Note that you should not manually change Tomcat's 'server.xml' file, but rather use this page to provide the appropriate values from your certificate provider.

  1. Set the Password Type pop-list to the desired setting.  

    When set to Normal, there are no restrictions on the types of passwords that can be used.  

    When set to Strict, the passwords must be at least 8 characters long and have at least one of each of the following:
    Upper Case Letters
    Lower Case Letters
    Digits
    Symbols

  2. Set the Enable HTTP flag to the desired setting.  The default setting is on.  If you set this flag to off and save the changes, the server will no longer respond through http protocol.  

    Xephr uses Apache Tomcat application server as a stand alone web server.  For more information, see http://jakarta.apache.org/tomcat

    This flag can be used to disable Xephr response entirely, unless HTTPS response is enabled.  If both the Enable HTTP flag and the Enable HTTPS/SSL flags are set to off, you will NOT be able to access the Xephr server or the administration console.  You will have to re-install Xephr to recover from this.

  3. In the HTTP Port field, enter the port to which the server will respond for http requests.  The default port is 80.

  4. Set the Enable HTTPS/SSL to the desired setting.  The default setting is off.  When this flag is set to on, additional fields are displayed for entry.

    If both the Enable HTTP flag and the Enable HTTPS/SSL flags are set to off, you will NOT be able to access the Xephr or the administration console.  You will have to re-install Xephr to recover from this.

  5. In the HTTPS/SSL Port, enter the port to use for HTTPS/SSL requests.  The default port is 443.  This field is only displayed when HTTPS/SSL is enabled.  

  6. In the Keystore Password field, enter the keystore password that you set up when generating your private key and obtaining your security certificate.  For more information, contact your certificate provider.

  7. In the Keystore Location field, enter the file path from the Xephr server to the previously generated keystore.

  8. In the Amount of RAM to use field, select the amount of RAM on your server that can be used for your Xephr installation.  

  9. In the Location of Uploaded files field, enter the file path from the Xephr server for files uploaded through the Xephr Runtime File Upload Component.  This can be a Window's share or Samba/NFS mount point, provided the Xephr Service will have access to it when it starts.

  10. In the Export directory field, enter the file path from the Xephr server for Xephr repository exports.  This can be a Window's share or Samba/NFS mount point, provided the Xephr Service will have access to it when it starts.

  11. In the Backup directory field, enter the file path from the Xephr server for Xephr repository backups.  This can be a Window's share or Samba/NFS mount point, provided the Xephr Service will have access to it when it starts.

  12. In the Maximum log-file size pop-list, select the maximum size that a log file can reach before it rolled over into a back up log file.

  13. In the Maximum number of log files field, enter the maximum number of back up log files that can exist.  As log files roll over into back ups, the older back up files are incremented by one, and the new one is named with the lowest increment.

    For example: you might have wrapper.log (logging current activity), wrapper.log.1 (most recent rollover), and wrapper.log.2 (previous roll over).  When wrapper.log reaches the maximum log-file size, wrapper.log.2 is renamed wrapper.log.3, wrapper.log.1 is renamed wrapper.log.2, wrapper.log is renamed wrapper.log.1, and a new wrapper.log is created.

  14. Click on the Update Server button to update the Xephr server with the changed settings.

Restart Xephr Service

Click on this link to stop and restart the Xephr service.

You will receive three warnings.  After selecting Ok on the third warning, the service will be restarted.  



Once you press Ok on the third message, wait until the screen goes to white and it's obvious that the service has been stopped (You'll get an error on your browser page.)  It will take approximately the same time for the service to come back up.  You will need to close your browser and open a new connection to the Xephr Administration Console after that time has passed.

 

Xephr is a registered trademark of NDS Systems, LC.

Copyright © 2007 NDS Systems LC.