How to install and configuration HCL Sametime 12.0 Premium on Docker

1. ALEŠ LICHTENBERG
twitter: @a_lichtenberg
blog: www.alichtenberg.cz
HCL Sametime 12.0
Deployment Guide
Step by Step
Ver. 1.0

2. Intro
This document contains a step-by-step deployment of HCL Sametime Premium 12.0
The document does not replace official documentation, but is intended to help deploy
HCL Sametime Premium 12.0 in a relatively short time.
The document will guide you through the basic installation so that you will be able to
run Sametime for chat and meetings, especially for testing purposes
The implementation will be demonstrated on a specific example.
The document will be gradually supplemented and updated.
1

3. About me
I am a technical consultant of HCL Digital Solutions software: Domino/Notes,
Sametime, Nomad, Verse. I am a Member of Czech Lotus User Group =
Sutol. I am a Bloger and a Speaker. I have been primarily engaged in the
Lotus software family since 1994. I remember the era when these products
were owned by Lotus, then IBM, and now I am looking forward to another
successful years with HCL Software.
Contacts:
e-mail: ales@alichtenberg.cz
twitter: a_lichtenberg
blog: alichtenberg.cz
2

4. Agenda
▪ HCL Sametime 12.0 – Resources
▪ Pilot example
▪ Step 1 - Installation and configuration MongoDB
▪ Step 2 - Installation and configuration Docker
▪ Step 3 - Installation and configuration Sametime 12 Premium
▪ Step 4 - Updating the Sametime 12 Premium TLS Certificates
3

5. HCL Sametime 12 – Resources
Current resources:
➢ Documentation
https://help.hcltechsw.com/sametime/12/admin/installing.html
➢ HCL Customer Support
https://hclpnpsupport.hcltech.com/csm
➢ Discussion HCL Sametime
https://hclpnpsupport.hcltech.com/community?id=community_forum&sys_id=e3c946d01b80841077761fc58d4bcb04
4

6. Pilot example
Deployment will take place on Centos 7.x
Installed components:
• MongoDB
• Docker
• HCL Sametime 12.0 Premium (chat and meetings)
• LDAP (exists Domino server 12)
All components will be installed on one virtual machine.
I recommended using FQDN everywhere instead of IP address
• This will prevent, for example, the problem of an empty chat in the web client or mobile phone
or a problem with the client's connection to the Sametime server
5

7. Hardware required for this Pilot Example Deployment
Hardware:
✓ 8 core, 32GB RAM, 500 GB Hard disk
Operation system:
✓ Linux Centos 7.x
Pre-Requisites
✓ MongoDB 4.4.x
✓ HCL Sametime 12 Premium or Standard (without Meetings)
✓ LDAP (for example exists Domino 12)
✓ FQDN for my Pilot example server: “sametime12.alichtenberg.cz”
6

8. Topology HCL Sametime 12
7
Source: HCL Software

9. Step 1
Installation and configuration
MongoDB
8

10. Installation and configuration MongoDB
➢Installation and configuration MongoDB
• MongoDB use for saving chat history, persistent chat, meetings etc.
• Supported version Mongo 4.4.x
• Installation instuctions:
Linux
https://www.mongodb.com/docs/v4.4/administration/install-on-linux
https://help.hcltechsw.com/sametime/12/admin/installing_mongodb_linux.html
!!! Be careful when copying commands and configuration lines from the manual (spaces, slashes)
9

11. Installation and configuration MongoDB
• You will need to edit the configuration files, and because it works well with Midnight
Commander, I installed it with Centos:
yum install mc
• After installation start Midnight Commander (MC) by mc command
• Create a repository file for YUM to install MongoDB. Use the VI command or
Midnight Commander (MC) to create and edit the mongodb-org-4.4.repo file
10

12. Installation and configuration MongoDB
• To edit the file, use Insert (VI) or F4 (MC) and then copy and paste the following
content
• Press Esc to exit insert mode. To save and exit, use the wq command (VI) or F2 (MC).
11
[mongodb-org-4.4]
name=MongoDB Repository
baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/4.4/x86_64/
gpgcheck=1
enabled=1
gpgkey=https://www.mongodb.org/static/pgp/server-4.4.asc

13. Installation and configuration MongoDB
• Run the MongoDB package installation.
yum install mongodb-org
• Type y to confirm the download and installed size
• Type y to accept the GPG key import.
12

14. Installation and configuration MongoDB
• After the installation is complete, start the MongoDB server
service mongod start
• Start the MongoDB console
mongo
13

15. Installation and configuration MongoDB
• From the MongoDB console, run the following commands to create sametimeUser in
MongoDB.
• If you change the user and password, you must use the new values when you
configure later steps the Sametime server.
• Use admin comand
use admin
• Run the command to create sametimeUser
14
db.createUser({user: "sametimeUser", pwd: "sametime", roles:[{role:"readWrite",
db:"chatlogging"},{ role:"readWrite", db:"mobileOffline"},{ role:"readWrite",
db:"meeting"},{role:"dbAdmin", db:"meeting"},{role:"userAdminAnyDatabase",
db:"admin"}]})

16. Installation and configuration MongoDB
• When complete, a message is displayed
15

17. Installation and configuration MongoDB
• From the MongoDB console, run the following commands to create the
chatlogging database with events and sessions collections in MongoDB.
16
> use chatlogging
> db.EVENTS.insertOne({"_id" : "dummy"})
> db.SESSIONS.insertOne({"_id" : "dummy"})

18. Installation and configuration MongoDB
• Stop the MongoDB server and exit the console to pick up the new schema version
change.
• To exit the MongoDB console, use the exit command.
• To shut down the MongoDB server: use run the service mongod stop command
17

19. Installation and configuration MongoDB
• Edit the mongod.cfg file (/etc/mongod.conf)
• Uncomment the replication statement. Add add replSetName: rs0 under it.
(Notice: use 2 spaces before “replSetName: rs0“, not tabs)
• Under #network interfaces, add bindIpAll: true
18
replication:
replSetName: rs0
net:
port: 27017
bindIp: 127.0.0.1
bindIpAll: true

20. Installation and configuration MongoDB
• Start the MongoDB service command prompt on Linux: service mongod start
• Start the MongoDB console: mongo
• From the MongoDB console, initiate the Replica Set in MongoDB with the command
rs.initiate()
• The message is rs0:Secondary or rs0:OTHER. Press Enter and the message changes to
rs0:Primary>
• Now, you can exit the console using the exit command
19

21. Installation and configuration MongoDB
DONE!
Now you have a MongoDB.
20

22. Step 2
Installation and configuration
Docker
21

23. Installation Docker for HCL Sametime 12
What is Docker?
Docker is an open-source lightweight containerization technology. It allows you to
automate the deployment of applications in lightweight and portable containers and
ship it all out as one package. It also allows you to run multiple Operating systems on
the same host.
How to install Docker Engine: https://docs.docker.com/engine/install/centos
How to install Docker Compose: https://docs.docker.com/compose/install
22

24. • Log in with your Centos server as “root“ user and execute all commands under this
• Before installing Docker Compose run the following commands for installation
required Docker Engine packages: yum install -y yum-utils
23
Installation Docker for HCL Sametime 12

25. • Now run the following commands for add the docker repository for software downloads:
yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
24
Installation Docker for HCL Sametime 12

26. • Install the latest version of Docker Engine and containerd:
yum install -y docker-ce docker-ce-cli containerd.io
25
Installation Docker for HCL Sametime 12

27. • Use the command to start the Docker Service
systemctl start docker
• Use the command to enable Docker auto start
systemctl enable docker
26
Installation Docker for HCL Sametime 12

28. • Now install Docker Compose on Linux systems
curl -L "https://github.com/docker/compose/releases/download/1.26.2/docker-compose-$(uname -s)-
$(uname -m)" -o /usr/local/bin/docker-compose
27
Installation Docker for HCL Sametime 12

29. • Apply executable permissions to the binary:
chmod +x /usr/local/bin/docker-compose
• Use the command to start the Docker server
service docker start
28
Installation Docker for HCL Sametime 12

30. DONE!
Installation Docker for HCL Sametime 12
29

31. Step 3
Installation and configuration
Sametime 12 Premium
30

32. • We will now install HCL Sametime Premium 12 into to Docker.
• Download HCL Sametime Premium 12 file from Flexnet and copy this file for my example
to directory /local/ sametime
• Extract the zip file Sametime_Premium_12.0.zip:
unzip Sametime_Premium_12.0.zip
• If you do not have unzip available, install using:
yum install unzip
31
Installation HCL Sametime Premium 12

33. • After extract Sametime_Premium_12.0.zip file run the below command to load and
initialize the docker images in the directory where you have extracted the zip file and
./install.sh
32
Installation HCL Sametime Premium 12

34. • Note: The Sametime Premium 12 requires access to a MongoDB server and LDAP server.
You can use the existing LDAP server for example existing Domino server.
• You are prompted to enter the following information:
Fully qualified name of the Sametime server
Sametime domain name
Mongo host
Mongo port
Mongo admin user name
Mongo admin user password
Mongo Connection URL
LDAP server host name or IP address
Use TLS to access LDAP
LDAP server port
LDAP Base DN for resolving users and groups
Configure advanced LDAP settings needed for binding
Base64 encoded JWT SECRET
TURN server address
Configure TCP over 4443
Configure LTPA
33
Installation HCL Sametime Premium 12

35. • You can now proceed according to the individual images or enter your data.
• If you have properly configured DNS, they recommend using an FQDN
• Enter: Fully qualified name of the Sametime server and Sametime domain name
(Just confirm the default values with the "Enter" key)
34
Installation HCL Sametime Premium 12

36. • Enter:
Mongo host and Mongo port
Mongo admin user name and Mongo admin user password
Mongo Connection URL
35
Installation HCL Sametime Premium 12

37. • Enter:
LDAP server host name or IP address
Use TLS to access LDAP
LDAP server port
36
Installation HCL Sametime Premium 12

38. • Enter:
LDAP Base DN for resolving users and groups
Configure advanced LDAP settings needed for binding
37
Installation HCL Sametime Premium 12

39. • Enter:
Base64 encoded JWT SECRET
TURN server address
Configure TCP over 4443
Configure LTPA
38
Installation HCL Sametime Premium 12

40. • Installation progress
39
Installation HCL Sametime Premium 12

41. • After installation run the below command to check if meetings server is running.
Show all the loaded docker images
docker images
40
Installation HCL Sametime Premium 12

42. • After installation run the below command to list all running containers in docker engine
docker ps
41
Installation HCL Sametime Premium 12

43. • Now try your url: https://sametime12.alichtenberg.cz/chat (for my example)
• Use Google Chrome
42
Installation HCL Sametime Premium 12

44. • Now try your url: : https://sametime12.alichtenberg.cz /meeting (for my example)
43
Installation HCL Sametime Premium 12

45. Installation HCL Sametime Premium 12
DONE!
Now you have complete HCL Sametime Premium 12
44

46. Step 4
Updating the Sametime 12 Premium
TLS Certificates
45

47. • The Sametime Premium 12 is pre-configured with a self-signed certificate. Use these
instructions to replace the self-signed certificate with a third party certificate.
• Docker compose down by command: docker-compose down
• Replace the cert and key files in
<install dir>./sametime-config/web/keys/cert.crt and cert.key with the correct key and crt file.
• Docker compose up -d by command: docker-compose up -d
46
Updating the Sametime Premium 12 TLS Certificates

48. DONE!
Updated the HCL Sametime Premium 12 TLS Certificates
47

49. HCL Sametime Premium 12.0
Deployment Guide
Step-by-Step
The END
48