Securing your help server

You can make your help server accessible only when logged on to the help server or enable remote access to the help server. When you enable remote access, you can create passwords for users to secure your help server.

Creating users for the help server

Procedure

  1. In a browser, open the Help Administration page by typing a URL that is in this format: http://server:port/help-name/updater/admin.jsp
  2. Click the Administrative Access Management tab. The default user is warupdateadmin and uses the password warupdateadmin.
  3. Select an authentication type.
    • Local access only: Only users who are logged on to the help server can update the help content.
    • Role based security: Users can log in to the Help Administration page remotely.

    If you selected Role based security, continue to the next step. If you selected Local access only, no further setup is needed.

  4. If you selected Role based security, create users who can administer the help content remotely.
    1. Click Add.
    2. Enter and confirm a password for that user. You cannot customize the user name.
    3. If the commenting feature is enabled in your product documentation and you want to give a user the ability to manage the comments that are entered, select the Comment Administrator option.
    4. If you want to give a user the ability to create other users for help server administration, select the User Administration option. If the User Administration option is not selected, the user can update the help content, but cannot create help server users.

Setting security type preferences

You can set Eclipse and help system security type preferences in your Eclipse workspace

Before you begin

The security preferences might already be configured for your product. Check your product_customization.ini to see whether the values were configured for you.

About this task

Table 1. Eclipse and help system security preferences
Preference Description
com.ibm.ut.help.common.sslcontexts Help server security preference
Example values:
  • SSL
  • SSLv2
  • SSLv3
  • TLS
  • TLSv1
  • TLSv1.1
org.eclipse.help.base.sslcontexts Eclipse security preference
Example values:
  • SSL
  • SSLv2
  • SSLv3
  • TLS
  • TLSv1
  • TLSv1.1

Procedure

To set the security preferences in the user workspace:

  1. Open the following files with a text editor:
    • <application_server_workspace>\.metadata\.plugins\org.eclipse.core.runtime\.settings\org.eclipse.help.base.prefs
    • <application_server_workspace>\.metadata\.plugins\org.eclipse.core.runtime\.settings\com.ibm.ut.help.common.prefs

    Apache Tomcat example: <tomcat_installation_directory>\work\Catalina\server\help\eclipse\workspace\.metadata\.plugins\org.eclipse.core.runtime\.settings\com.ibm.ut.help.common.prefs

  2. Specify both preferences in each .prefs file. You can list more than one SSL type by separating them with commas. When more than one type is specified, each one is tested until the correct type is found. Specify the same values for both preferences.
    Example:
    com.ibm.ut.help.common.sslcontexts=TLS,TLSv1
    org.eclipse.help.base.sslcontexts=TLS,TLSv1
  3. Save the changes to both .prefs files.

Feedback