Configuring and installing Verse On-Premises on a Domino mail server

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 Technote 7049613.

Obtain the IBM Verse On-Premises package from Passport Advantage®.

Procedure

  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 Domino documentation.
  2. Register users as iNotes users. For more information, 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.

    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:
    HTTPJVMMaxHeapSize=1024M
    HTTPJVMMaxHeapSizeSet=1
    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 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.
    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' Internet passwords and Notes ID passwords are the same. The Internet passwords, which are used to log on to Verse, must match the Notes ID passwords for Verse users to be able to read and send signed or encrypted messages. As a best practice, also complete the following steps to ensure that when Notes ID passwords change, the Internet passwords automatically change to match:
    1. Open the Security Settings document that you use to assign users to the vault.
    2. Click Password Management > Password Management Basics.
    3. Select Update Internet Password When Notes Client Password Changes.
  8. 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, sdaryn@renovations.com.
  9. Extract the files from the Verse On-Premises package. The package contains the following files:
    IBM_Verse_On_Premises.zip
    iwaredir.ntf
    license.zip
    readme.zip
    VOPDesign.nsf
  10. Stop the Domino Web server. From the server console, enter:
    tell http quit
  11. If a previous version of Verse On-Premises is installed, delete the existing Verse On-Premises .jar files from the following directory:
    <Domino program directory>/osgi/shared/eclipse/plugins

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

  12. Extract the contents of the IBM_Verse_On_Premises.zip 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 
  13. Copy VOPDesign.nsf and iwaredir.ntf to the Domino data directory.
  14. 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.
  15. Start the Domino Web server. From the server console, enter:
    load http
  16. 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
    Note: If the mail servers are in a cluster, do this step on one server in the cluster only.
  17. Prepare mail files for 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:
      ($VerseLookup)
      ($VerseTrashLookup)
      Note: If you have an existing Verse On-Premises installation, delete the following obsolete custom views from the mail template or mail files:
      ($CollaborationProvider)
      ($ConversationProvider)
      ($PoBByInetFrom)
      ($ActionableWaitingfor)
      ($ActionableNeedsAction)
    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 Creating and updating full-text indexes for single databases.
    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
  18. 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.