Configuring Verse On-Premises on a Domino mail server

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

Before you begin

Install the following software on the IBM® Domino 9.0.1 server:
  • IBM Domino 9.0.1 Feature Pack 8 or higher.
  • IBM iNotes® 9.0.1 Feature Pack 8 or higher.
  • NOTE: If Verse On-Premises is currently installed on Fix Pack 7, before upgrading to Feature Pack 8, see Technote 2000072 for important information.
Obtain the IBM Verse On-Premises package from Interim Fixes & JVM patches for 9.0.1.x versions of IBM Notes/Domino & add-ons.


  1. If you haven't done so, enable IBM iNotes on the Domino server. To do so, make sure that you run the HTTP server task and that you configure iNotes settings. For information on the settings, see Configuring iNotes in the iNotes documentation.
  2. Register users as iNotes users. For more information, see Registering iNotes users in the iNotes 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.

    Or, if you use a Web Site document, see the procedure Specifying the character set to use when retrieving Web pages in the Domino documentation.

  4. Configure the following notes.ini settings on the Domino server:
  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 in the Domino wiki.
  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 to enable Verse users to read and send signed or encrypted messages. For information, see the Notes ID vault section of the Domino documentation.
  7. Make sure that users have valid internet addresses in their Domino directory Person documents:
    1. Open the Person document.
    2. On the Mail tab, verify that there is a valid address in the Internet Address field, for example,
  8. If you previously installed any version of the Verse On-Premises beta, shut down the Domino server if it is running, then delete the beta .jar files from the following directory:
    <domino data>\domino\workspace\applications\eclipse\plugins

    Use the wildcard syntax "*-0.0.0-0.0-0.jar" to ensure that only the Verse On-Premises beta .jar files are removed.

  9. Extract the file from the Verse On-Premises package that you downloaded from Passport Advantage. It contains the follow files:
  10. Extract the contents of to the Domino program directory, typically:
    C:\Program Files\IBM\Domino (Windows) /opt/ibm/domino/notes/latest/linux (Linux)
  11. Copy VOPDesign.nsf and iwaredir.ntf to the Domino data directory, typically:
    IBM\Domino\Data (Windows) /local/notesdata (Linux)
  12. Replace the design of the redirector database with the iwaredir.ntf template from the extracted package:
    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 in step 11.
    4. Click Replace and click Yes.
    Note: If there isn't a redirector database, create one before you complete this step. For information, see the topic Using iNotes Redirect to access mail in iNotes in the iNotes documentation.
  13. Start the Domino server.
  14. Run the following commands at the Domino console to create the credential store application that is used by Verse On-Premises. 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
    Note: If the mail servers are in a cluster, do this step on one server in the cluster only.
  15. Prepare mail files for Verse On-Premises:
    1. From IBM Domino Designer, open the VOPDesign.nsf file that you copied in step 11.
    2. Copy the following views from VOPDesign.nsf to your mail template on the server or to individual 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. Run the updall task to build indexes on the mail files. For example, from the server console, enter:
      load updall
    5. Confirm that the mail files have full-text indexes that are enabled and created.
    6. Give the Domino server Designer access to the mail files.
    7. Run the Convert utility with the -m argument on the server to enable folder references in mail files. For more information on this utility, see Upgrading mail files with the mail conversion utility in the Domino documentation.
  16. 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.