Installing and configuring

To install and configure IBM Verse On-Premises on a Domino® mail server, complete the following steps.

Before you begin

Make sure that your Domino server meets the system requirements. For information, see the technote IBM Verse On-Premises 1.0.6 System Requirements.

Obtain the IBM Verse On-Premises package from the HCL License and Delivery Portal.


  1. Enable IBM iNotes on the Domino® server. Make sure that you run the HTTP server task and that you configure iNotes® settings. See Configuring iNotes® in the Domino documentation.
  2. Register users as iNotes® users. See Registering iNotes® users in the Domino documentation.
  3. To ensure that international characters are displayed correctly, configure the Web server to use UTF-8 for output:
    1. In the Domino® Directory, open the Server document in edit mode.
    2. Click the Internet Protocols tab and then the Domino Web Engine tab.
    3. In the Character Set section for Use UTF-8 for output, select Yes.
  4. Configure the following notes.ini settings on the Domino® server:
    If the settings don't exist, add them. If they exist, make sure that they have these values.
  5. Enable SSL on the Domino® server. Verse On-Premises requires HTTPS and a valid certificate. Follow the instructions in the article Generating a keyring file with a third party CA SHA-2 cert using OpenSSL and KYRTool on a Windows workstation .
    Note: If you are using a proxy server in front of the Domino server, it is the proxy server that needs to support HTTPS and have a valid certificate.
  6. Make sure that you configure the ID vault on the Domino® server and that you assign Verse users to the vault. An ID vault is required so users can read and send signed or encrypted messages. For information, see Notes® ID vault.
    Note: In the ID vault tab of the Security Settings document that you use to assign users to the vault, select the option Allow Notes-based programs to use the Notes ID vault.
  7. Make sure that users have valid Internet addresses in their Domino® directory Person documents:
    1. Open the Person document.
    2. On the Basics tab, verify that the Internet Address field contains a valid address for example,
  8. Extract the files from the Verse On-Premises package. The package contains the following files:
  9. Stop the Domino Web server. From the server console, enter:
    tell http quit
  10. If a previous version of Verse On-Premises is installed, delete the existing Verse On-Premises jar files from one of the following directories, depending on how product was installed:
    <Domino program directory>/osgi/shared/eclipse/plugins


    <Domino data directory>/domino/workspace/applications/eclipse/plugins 

    Use the wildcard syntax "*-1.0.*-0.0-*.jar", core-1.0.*.*.jar and servlet-1.0.*.*.jar to ensure that only the Verse On-Premises jar files are removed.

  11. Extract the contents of the file to the following directory:

    <Domino data directory>/domino/workspace/applications

    <Domino data directory> is typically:
    IBM\Domino\Data (Windows)
    /local/notesdata (Linux)

    Note: Extract with the directory structure intact. After extraction, the Verse On-Premises .jar files should be in the following directory:
    <Domino data directory>/domino/workspace/applications/eclipse/plugins 
    Note: As of Verse On-Premises 1.0.6, there are just four .jar files, fewer than in previous versions.
  12. Copy VOPDesign.nsf and iwaredir.ntf to the Domino data directory.
  13. If there isn't a redirector database, create one using the iwaredir.ntf template that you copied to the data directory. For more information, see Using iNotes® Redirect to access mail in iNotes® in the Domino documentation. Otherwise, replace the design of the existing redirector database using the new iwaredir.ntf template that you copied to the data directory:
    1. From IBM® Notes®, open the redirector database on the server. The default file name is iwaredir.nsf.
    2. Click File > Application > Replace Design.
    3. Select the new iwaredir.ntf template that you copied to the data directory.
    4. Click Replace and click Yes.
    Note: On the redirector database's UI Setup page, make sure the Enable Personal Options? option is set to No. Otherwise users won't get the chance to select to log into Verse. This option is set to No by default.
  14. If you are upgrading from the previous release, simply start the Domino Web server. From the server console, enter:
    load http
    If you are setting up Domino for the first time, you may need to stop and restart the server:
    restart server
  15. If there is not a credential store application on the server, run the following commands at the Domino® console to create one. The first command creates a document encryption key to be used for authentication that is called credstore. The second command creates the application credstore.nsf to store the encryption key.
    keymgmt create nek credstore
    keymgmt create credstore credstore
    If the mail servers are in a cluster, complete the following steps to configure the credential store on each additional server:
    1. From the server console of the server on which you created credstore.nsf, enter the following command to export the encryption key to a file in the Domino data directory:
      KEYMGMT export nek credstore <keyname>.key <password>

      For example:

      KEYMGMT export nek credstore NameVerseKey.key Password
    2. Copy the key file to the data directory of each Domino cluster member.
    3. From the server console of each Domino cluster member, enter the following command to import the encryption key:
      KEYMGMT import nek <keyname>.key <password>

      For example:

      KEYMGMT import nek NameVerseKey.key Password

      You see this response:

      NEK credstore - Fingerprint XXXX XXXX XXXX XXXX XXXX XXXX
      NEK credstore imported successfully
    4. Create a replica of credstore.nsf from the initial server to all Domino cluster members.
  16. Prepare mail files, if they have haven't already been prepared for a previous version of Verse On-Premises:
    1. From IBM® Domino® Designer, open the VOPDesign.nsf file that you copied previously to the data directory.
    2. Copy the following views from VOPDesign.nsf to your mail template on the server or to individual mail files:
      Note: The custom views used by Verse On-Premises are included in the standard mail template of Domino 9.0.1 FP9. If your mail template is based on FP9 or later or Domino 10, then you don't need to copy the views again.
      Note: If you have an existing Verse On-Premises installation, delete the following obsolete custom views from the mail template or mail files:
    3. If you copied the views to the mail template on the server, run the design task on the server to distribute the design elements. For example, from the server console, enter:
      load design
    4. Create full-text indexes on mail files, if they don't already have them. For information, see the topic
    5. Run the updall task to update full-text and view indexes on the mail files. For example, from the server console, enter:
      load updall
  17. To confirm that Verse On-Premises works, have a user with a mail file on the server complete these steps:
    1. From a browser, go to https://domino_hostname/verse.
    2. Log in.
    3. Verify that you see the Verse user interface.