ST11 Installation and Administration
ST11 Installation and Administration
HCL Sametime 11
Installation and Administration Guide
Updated
1-22-2020
Contents
System Requirements ................................................................................................................................... 2
Installation (Servers) ..................................................................................................................................... 2
Sametime Community V11 Server Install ..................................................................................................... 2
Install Domino V11 ........................................................................................................................................ 2
Set up Domino .............................................................................................................................................. 4
Steps to Set up Domino ............................................................................................................................ 4
Install MongoDB............................................................................................................................................ 5
Configure MongoDB...................................................................................................................................... 6
Install the Sametime Community Server .................................................................................................... 13
Before you begin ..................................................................................................................................... 13
Procedure................................................................................................................................................ 13
Install the V11 Sametime Community Server ............................................................................................. 13
Results ..................................................................................................................................................... 25
Windows ............................................................................................................................................. 26
HCL Sametime Proxy Server ........................................................................................................................ 26
Installation .................................................................................................................................................. 28
Installation .............................................................................................................................................. 28
Configuration .......................................................................................................................................... 29
URL to use for webchat ............................................................................................................................... 30
Modifying the Sametime Proxy Server’s default configuration.................................................................. 30
Configure policy to allow/disallow users to use the new persistent chat features.................................... 26
Configure Sametime Community Server to enable chat logging ................... Error! Bookmark not defined.
Configure Sametime Chat Logging to point to MongoDB........................................................................... 27
Update TTL index for chatlogging.ini ...................................................................................................... 27
Steps:................................................................................................................................................... 27
Sametime Community Server ..................................................................................................................... 28
New Client ID’s for Sametime V11 .............................................................................................................. 28
Policy Administration .............................................................................................................................. 31
Migration ................................................................................................................................................ 31
Installation (Clients) .................................................................................................................................... 32
System Requirements
Installation (Servers)
NOTE: A fresh installation of Sametime 11 is required. Upgrades from an earlier release are
not supported.
2. On the computer where you will install the Domino Server, log on as the system
administrator (Microsoft Windows).
4. Read the Welcome window and click Next. Then read the license agreement and click
Yes.
5. Enter the administrator’s name and the company name. Do not elect to install Domino on
partitioned servers.
6. Select the program and data directory in which to copy the software. Make note of the
locations that you provide for the Domino program and data directories. You need this
information when you install Sametime. Click Next.
11. Click the HCL Domino Server desktop icon or click Start > Programs > HCL
Applications> HCL Domino Server to start the Server Setup program. Answer the
questions to finish setting up the Domino server.
Installing Domino® on Unix™
This topic guides you through the steps for installing Domino® interactively on a UNIX™
system.
You can install Domino® on a UNIX™ system by following this procedure, or you can perform
a silent installation of a local server.
Procedure
1. Before you install the Domino® server program files on a UNIX system, do the
following:
• Temporarily disable any screen savers and turn off any virus-detection software.
• Complete any pending reboot actions.
• Make sure that all other applications are closed.
2. As the root user, run the install program ./install available in the software package.
Note: This step runs the installation in console mode. Graphical mode is not available.
3. Read the Welcome screen and click Next.
4. Read the license agreement, accept the terms, and click Next.
5. Optional: Choose Install Data Directories Only.
Note: Choose the Data Directories Only option when migrating a single server install to
a multiple server install. If you are adding multiple partitions, select the option to install
partitioned servers when specifying the corresponding program files directory name. Or,
choose this option when you are upgrading only one partition on a multiple-partitioned
server.
6. Choose the program directory and choose whether you are installing partitioned servers.
(You can install up to eight partitioned servers.) Click Next.
7. Specify the data directory in which to copy the software. If you are installing a
partitioned server, specify a data directory for each partition.
Note: For partitions, use the Add button to add each of the data directories to the list. If
they are not added to the list, they will not be installed.
8. Specify a UNIX™ username and UNIX™ group name.
9. Required: If you are installing to a directory other than /opt/hcl/domino, you must
create the /opt/hcl/domino soft link.
10. Choose a server setup option.
Note: The server setup options are not available for servers with multiple partitions.
11. Select the server type you acquired:
• Domino Utility Server -- Installs a Domino® server that provides application
services only, with support for Domino® clusters. The Domino® Utility Server
removes client access license requirements. Note that it does NOT include support for
messaging services. See full licensing text for details.
• Domino Messaging Server -- Installs a Domino® server that provides messaging
services. Note that it does not include support for application services or Domino
clusters.
• Domino Enterprise Server -- Installs a Domino® server that provides both
messaging and application services, with support for Domino clusters.
• Customize -- Allows you to select the features you want to install.
Note: All installation types support Domino® partitioned servers.
12. Review the summary information and click Next to begin installing files.
13. Click Finish to complete the install program.
Set up Domino
Steps to Set up Domino
To configure Domino, do the following:
1. At the admin user screen, specify a unique name that is not in the LDAP directory.
2. At Internet Services, select web browsers and deselect LDAP.
3. Make sure the hostname is fully qualified and that it resolves locally to IP and not
localhost.
4. When setup is complete, start Domino, let it run for a few minutes, and stop it before you
install the Sametime Community Server.
Note: You must select the Version and Platforms as mentioned below:
o Version as latest (Stable) from the Version drop-down menu.
o Platforms as Windows 64-bit (7+) from the Platforms drop-down menu.
Note: You can select the Platforms as either Windows 64-bit (7+) or Windows 64-bit
(7+) (Zip).
Reference: https://docs.mongodb.com/v3.6/tutorial/install-mongodb-on-windows
4. Create the default MongoDB data path before starting MongoDB – default is
“c:/data/db”.
5. Create the logs directory “c:/Program Files/MongoDB/logs/”.
6. To start the MongoDB server, open a command prompt and navigate to the MongoDB
install directory/bin folder and execute “mongod.exe”.
7. To start a MongoDB console, open a command prompt and navigate to the MongoDB
install directory/bin folder and execute “mongo.exe”.
> db.system.users.remove({})
> db.system.version.find()
Then the following commands will update the authSchema value to the required version
of 3.
"authSchema"})
> schema.currentVersion = 3
> db.system.version.save(schema)
Restart the MongoDB server and exit the console to pick up the new schema version
change. To exit the MongoDB console use “exit”. To shut down the MongoDB server
use “CTL+C” in its command window.
2. Use the Compass UI to create a database called “chatlogging”. Create with an initial
collection called “SESSIONS” and create an additional collection called EVENTS.
Under New Connection, select "Fill in connection fields individually". Leave the
defaults, unless the MongoDB server is on another host.
Note: The user and password specified below are examples and can be changed at this
time if desired. If changing, use the new values when you configure the Sametime
Community server in a later step.
5. Create the mongod.cfg file in the path referenced above in the MongoDB installation
path (C:\Program Files\MongoDb\Server\3.6\) with the following
contents:
systemLog:
destination: "file"
path:"c:\\Program Files\\MongoDB\\logs\\log.txt"
storage:
dbPath: "c:\\data\\db"
net:
bindIpAll: true
replication:
replSetName: rs0
Note: You can copy/paste the instructions from the document. However, the format of
the instructions is critical and must remain the same.
8. Using the MongoDB console, use rs.initiate() to initiate the replica set.
9. The replica set is now operational. To view the replica set configuration, use
rs.conf(). To check the status of the replica set, use rs.status().
>vi mongodb-org-3.6.repo
[mongodb-org-3.6]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-
org/3.6/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-3.6.asc
After saving/exiting the file (:wq), execute YUM to install the MongoDB package.
This will install the mongodb components, create the mongod user and default log and data
directories. You can validate this by checking that the following two directories exist and are
owned by ‘mongod'
/var/log/mongodb
/var/lib/mongo
To modify the default directories, consult the online documentation for MongoDB as referred to
earlier.
>mongo
> db.createUser( {
user: "sametimeUser",
pwd: "sametime",
});
> rs.initiate()
Note: this last command should indicate that the node was not started with replSet option, this is
expected as you will set that up in the next step after you exit the shell with
> exit
Use VI to edit the mongod.cfg file located at /etc/mongod.cfg and add the following two lines
after the bindIp line and above #security
replication:
replSetName: rs0
Using the prior lines in the cfg file as a guide for format.
Save the mongod.cfg file (:wq) and then restart the mongod service
>service mongod restart
And then restart the shell to confirm the replica set is available – If the rs.initiate does not return
with an error, exit the console. If there is an error, recheck the mongod.cfg file.
>mongo
>rs.initiate()
>exit
Procedure
Silent Install
As root -
• Use VI to create a file named “installer.properties” in the same directory as the
‘install.bin’ executable, with the following contents
DataInstallDir=/local/notesdata
UNIX_UserName=notes
UNIX_GroupName=notes
UNIX_ServerName=<hostname of the server you are
installing on>
#Directory Selection
#-------------------
DIRECTORY_TYPE_DOMINO=1
DIRECTORY_TYPE_LDAP=0
LDAP_SERVER=
LDAP_PORT=
ADVANCED_LDAP_CONFIG=0
ST_BRANDING_INFO=<standard> or <entry>
#Install
#-------
-
fileOverwrite_/tmp/156305.tmp/stnotesinstallutilities_
linux64=Yes
-
fileOverwrite_/tmp/156305.tmp/stnotesinstallutilities.
jar=Yes
-
fileOverwrite_/tmp/156305.tmp/stnotesinstallutilities.
dll=Yes
-
fileOverwrite_/tmp/156305.tmp/stinstallutilities.dll=Y
es
-fileOverwrite_/tmp/156305.tmp/vcredist_x64.exe=Yes
-
fileOverwrite_/tmp/156305.tmp/UnixSetNotesFieldValue.s
h=Yes
-fileOverwrite_/local/notesdata/_HCL Sametime Server
11.0.0_installation/Change HCL Sametime Server 11.0.0
Installation.lax=Yes to All
• Notes:
• DIRECTORY_TYPE should be set as applicable to your environment. If you set
LDAP to 1, be sure to set DOMINO to 0 and add the appropriate
LDAP_SERVER and LDAP_PORT information.
• ST_BRANDING_INFO should be ‘entry’ or ‘standard’ as applicable to your
environment
• All of these entries are on a single line, so be sure that copy/paste does not break
them
• If you copy/paste - be sure there are no spaces at the end of the line(s).
• In the Server subdirectory, execute ‘./install.bin -i silent’
• HCL Sametime v11 do not support the console based install in this release. If you are
attempting to do the Graphical install using VNC and you see the console option start,
this means that you were not successful in exporting the display – most common reason
would be that you are not running as root.
Installation Steps -
1. On the computer where you will install the HCL Sametime Community Server, the
InstallAnywhere install shield will guide you through the installation process. Click
Next.
Note: You can choose either Standard or Limited depending on your license. Currently
the Dynamic model option, where you can enter the flex net url is not supported for this
release.
5. The Pre-Installation Summary displays. Click Install.
6. The installation begins.
7. Confirm the installation is performed without error.
Note: You must restart the system to complete the installation. Select the radio button Yes,
restart my system and then click Done.
To do this, you would edit ‘policies.users.xml’ file and modify the ‘current-value’ of
im.persistentChatEnabled to “0” (for false) and save the file. More details on updating policy
settings is provided at the end of the document.
Note: In order to use the new webchat client the persistent chat feature must be enabled.
Configure Sametime Chat Logging to point to MongoDB
If you followed the examples in the “Install MongoDB” section, the defaults should work
without any modifications. If you used a different username or password or installed MongoDB
on a separate machine, you will need to update the following settings in sametime.ini and
chatlogging.ini as appropriate.
The following shows the default settings.
Sametime.ini -
[stconvomap]
MONGO_URI=mongodb://127.0.0.1:27017
Chatlogging.ini –
CL_MONGO_HOST=127.0.0.1
CL_MONGO_PORT=27017
CL_MONGO_USER=sametimeUser
CL_MONGO_PASSWORD=sametime
The ‘Time To Live’ (or TTL) setting in the sametime.ini defines how long to store chathistory in
the database.
To change the TTL from the default 90 days, you must rebuild the TTL index in MongoDB.
Steps:
If you have an existing environment and have settings that are specific to it (LDAP tuning, for
example) those settings can be copied to stconfig.nsf and sametime.ini as they still apply.
Note: Do not duplicate or overwrite any current setting.
Installation
File name: Extract the Sametime 11 Proxy Server archive file to the desired install location.
(example: C:\sametimeproxy or \opt\sametimeproxy)
Installation
• Open a command prompt and navigate to the location that you placed the extracted files.
• Run the command install.bat (install.sh) to view and accept the license.
• Simple prompts will ask for the address of the Sametime Community and MongoDB
servers.
Note: If you don’t have an IDP server, leave it blank.
• A few files will be created as well as a ‘self signed’ certificate for the server.
• The installation is competed with:
Proxy server configured successfully
Configuration
Based on the responses during installation, settings will be stored in the following files:
• sametimeproxy\setenv.bat (setenv.sh)
• sametimeproxy\conf\stproxyconfig.xml
• sametimeproxy\conf\dbconfig.properties
After installation, these configuration files can be manually edited to alter the server's
configuration.
Note: Changes to stproxyconfig.xml are automatically read, without needing a server
restart but may take up to 30 mins. If you have an existing Sametime Proxy server (v9 or V10)
with settings specific to your environment, those settings can be copied to the new
stproxyconfig.xml as needed.
Note: If MongoDB is running on Windows, it may be required for the Windows server’s domain
name to be in the proxy server’s DNS hosts file. For example, if the Windows server’s domain
name is, “WIN-SERVERNAME” then the Sametime Proxy should add this in its host file.
Example:
# mapping the windows domain name of the MongoDB to this
uservers hosts file, so redirects will work
10.123.55.55 WIN-SERVERNAME
https://<sametimeProxyHostname>:8443/chat
• https://support.hcltechsw.com/kb_view.do?sysparm_article=KB0024812
• https://support.hcltechsw.com/kb_view.do?sysparm_article=KB0040617
Forcing a non-Sametime System Console, Sametime server with multiple NICs to bind to the correct IP
address
• https://support.hcltechsw.com/kb_view.do?sysparm_article=KB0037695
• https://support.hcltechsw.com/kb_view.do?sysparm_article=KB0039463
• https://help.hcltechsw.com/sametime/10.0/config/st_adm_security_ssl_ov_t.html?hl=configuri
ng%2Csametime%2Ccommunity%2Cserver%2Cuse%2Cssl%2Cencryption
Policy Administration
• For an example of how to configure policies in the new system – see this document
which talks about using the managed settings feature
o https://hclpnpsupport.hcltech.com/sys_attachment.do?sys_id=c79e28d71be0809083cb
86e9cd4bcb9c
• For a complete list of Policy IDs – see
https://help.hcltechsw.com/sametime/10.0/admin/admin_policy_im_ids.html?hl=instant%2Cm
essaging%2Cpolicy%2Cids
Migration
Here are best practices for migration from an earlier Sametime release.
• Build the new system in Parallel.
o Block via firewall 1516 to prevent confusion as to which server users are on for
testing/validation of new feature set.
o Make sure that vpuserinfo.nsf is replicating, or plan for a copy at cutover time.
o do a DNS flip so that existing users silently move over to the new system at the
next login.
Installation (Clients)