Installing and configuring
To install and configure HCL Verse™ on a Domino® mail server, complete the following steps.
Before you begin
Procedure
- Enable HCL iNotes on the Domino® server. Make sure that you run the HTTP server task and that you configure iNotes® settings. See the topic Configuring iNotes in the Domino documentation..
- Register users as iNotes® users. See the topic Registering iNotes users in the Domino documentation.
-
To ensure that international characters are displayed correctly, configure the Web server to
use UTF-8 for output:
- In the Domino® Directory, open the Server document in edit mode.
- Click the Internet Protocols tab and then the Domino Web Engine tab.
- In the Character Set section for Use UTF-8 for output, select Yes.
Or, if you use a Web Site document, see the topic Specifying the character set to use when retrieving Web pages in the Domino documentation.
- Create full-text indexes on mail files, if they don't already have them. For information, see the topic Full-text indexes for single databases in the Domino documentation.
-
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.HTTPJVMMaxHeapSize=2048M HTTPJVMMaxHeapSizeSet=1
-
Enable SSL on the Domino® server. Verse™
requires HTTPS and a valid certificate. Follow the
instructions Generating a keyring file with a third party CA SHA-2 cert using OpenSSL and
KYRTool on a Windows™ workstation in this article on the HCL Customer Support site.
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.
- Make sure the SSL key file name field matches the file name that you created. For more information see the description of the Key Ring File Name field in the topic Creating a server key ring file in the Domino documentation.
- Domino 11 ships a version of KYRTool. For other versions of Domino, you can get a version of the tool from here on the HCL Support site.
- Make sure the SSL port status is enabled. For more information, see the topic Modifying Web server Internet port and protocol settings in the Domino documentation.
-
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 the topic Notes ID vault in 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.
-
Make sure that users have valid Internet addresses in their Domino® directory Person documents:
- Open the Person document.
- On the Basics tab, verify that the Internet Address field contains a valid address for example, sdaryn@renovations.com.
-
Extract the files from the Verse™
package. The package
contains the following files:
catalog12.ntf HCL_Verse.zip iwaredir.ntf readme.html servers-lookup-<version>.jar
-
Stop the Domino server. From the server console, enter:
quit
-
If a previous version of Verse™
is
installed, delete the existing Verse™
jar
files from the following directory:
<Domino data directory>/domino/workspace/applications/eclipse/plugins
Delete the following files: ats-*.jar, sequoia-osgi-*.jar, core-*.jar, servlet-*.jar, servers-lookup-*.jar.
-
Extract the contents of the HCL_Verse.zip file to the
following directory:
<Domino data directory>/domino/workspace/applications
<Domino data directory> is typically:
HCL\Domino\Data (Windows)
/local/notesdata (Linux)Note: Extract with the directory structure intact. After extraction, the Verse .jar files should be in the following directory:<Domino data directory>/domino/workspace/applications/eclipse/plugins
Note: As of Verse 1.0.6, there are just four .jar files, fewer than in previous versions. -
If your Domino server deployment requires redirecting users to their mail
servers follow the steps below, otherwise skip to step 15. Single server
deployments do not require redirection. For more information on using
redirection, see Using iNotes® Redirect to access mail in
iNotes® in the Domino documentation.
The Verse installation kit includes a copy of iwaredir.ntf. This copy comes directly from Domino 11.0.1. If you are not using Domino 11.0.1 or greater, copy iwaredir.ntf to the Domino data directory as the 11.0.1 version can be used with of previous Domino versions.Note: This version of the redirector template includes translations for English, Chinese (China), Chinese (Taiwan), French, German, Italian, Japanese, Korean, Portuguese (Brazil), and Spanish.If there isn't a redirector database, create one using the iwaredir.ntf template. Otherwise, if there is a redirector database created already and you are running a Domino version less than Domino 11.0.1, replace the design of the existing redirector database using the new iwaredir.ntf template that you copied to the Domino data directory:
- From HCL Notes®, open the redirector database on the server. The default file name is iwaredir.nsf.
- Click .
- Select the new iwaredir.ntf template that you copied to the data directory.
- Click Replace and click Yes.
Open the redirector database and on the UI Setup page, select options to enable users to log on to Verse:If you use Domino to authenticate:- Enable Personal Options? No
- Enable Login Options? Yes
- Enable HCL Verse? Yes
- Optional setting to enable TOTP support (starting from Domino 12.0.1):Enable TOTP Login Form? Yes or No
If you use SAML to authenticate:- Enable Personal Options? No
- Enable SAML Options? Yes
- Select Default Mail Application Verse
Note: The option Enable HCL Verse? is not applicable for SAML authentication. -
Ensure you have created a Domino® Web Server Configuration application (see
https://help.hcltechsw.com/domino/11.0.1/admin/conf_creatingthedominoconfigurationdatabase_t.html) and set the target database and target
login form:
-
Set your server's home URL. For more information on where to set the home URL,
see the topic Configuring HTML, CGI, icon, and Java files
for Web Site documents in the Domino documentation.
If your Domino server deployment uses redirection, set the home URL to /iwaredir.nsf?open.
If your Domino server deployment does not use redirection, set the home URL to /verse.
- Start the Domino server.
-
If there is not a credential store application on the server, create one. For
instructions, see the Domino documentation:
- If the Verse server is not in a cluster, complete the procedure Creating the credential store application on a single Domino server.
- If the Verse server is in a cluster, complete the procedure Creating the credential store application in a cluster.
-
To confirm that Verse™
works, have a user with a mail file
on the server complete these steps:
- From a browser, go to https://domino_hostname/verse.
- Log in.
- Verify that you see the Verse user interface.