Home
HCL Sametime® Administration Guide 12.0.1
Configuring
This section provides information on configuring the HCL Sametime server. Configuration tasks are dependent on the deployment environment.
Meetings
This contains configuration steps specific to the HCL Sametime Meetings server.
Setting up a TURN server
A TURN server can be configured to provide for efficient traffic flow within your Sametime meeting.
Configuring the TURN server for Docker and Podman
You can configure the Sametime Meeting service to enable a TURN server on port 443 for Docker.

HCL Sametime® Administration Guide 12.0.1
- Accessibility features for Sametime
  Accessibility features help users who have a disability, such as restricted mobility or limited vision, use information technology products successfully. HCL® strives to provide products with usable access for everyone.
- What's new
  HCL Sametime and HCL Sametime Premium 12.0.1 provide many new features, enhancements and fixes to servers and clients. Additional releases to version 12.0.1 also provides updates to the product.
- Planning
  This section describes the system requirements and server configurations needed for HCL Sametime and HCL Sametime Premium.
- Installing
  This section provides information on installing the servers for Sametime and Sametime Premium.
- Configuring
  This section provides information on configuring the HCL Sametime server. Configuration tasks are dependent on the deployment environment.
  - Adding corporate branding to meeting pages
    You can customize meetings to reflect your company's branding and visual presence.
  - Downloading content to the server
    When downloading content to the Sametime sever, it must be downloaded to the web/download directory.
  - Adding virtual backgrounds to the global library
    By default, you can customize your meetings with virtual backgrounds. As an administrator, you can choose which backgrounds are available to all users.
  - Configuring alternate STUN servers
    Sametime Meetings uses public Google STUN servers by default. To use different STUN servers, you must complete this procedure before installing Sametime Meetings.
  - Setting up business cards
    You can configure the Sametime server so that business card information about an individual displays when a user hovers over a name in a chat window or a contact list. Business card information also displays at the top of an active chat window.
  - Configuring LDAP
    Sametime supports LDAP directory servers as the user repository.
  - Updating the time-to-live index for persistent chat
    The time-to-live (TTL) setting defines how long the chat history is stored in the database. The default value is 90 days. However, administrators can update the value based on the organization's preferred setting.
  - Managing secrets in Kubernetes
    Sensitive information such as passwords, service account names, certificates, and other confidential data needed by Sametime pods are stored in secrets. In addition to helm charts and configuration map, the Sametime configuration is also derived from secrets.
  - Applying configuration changes in Docker or Podman
    Configuration files contain environment variables that can be changed and applied to the Sametime server.
  - Applying configuration changes in Kubernetes or Openshift
    Configuration files contain environment variables that can be changed and applied to the Sametime server.
  - Chat
    This section contains Chat configuration considerations.
  - Meetings
    This contains configuration steps specific to the HCL Sametime Meetings server.
    - Disabling secure meeting room names
      Users are provisioned with a personal meeting room the first time that they log into their meeting. Their personal meeting room is created with a secure name that cannot be easily guessed by other users. For example: be:MeetMe.CWGRAff90q9HETLne4mhzA.
    - Enabling conference dial-in
      You can set up your environment to allow users to dial in to a meeting using a SIP-capable phone system that is connected to a public switched telephone network (PSTN). This feature uses the ilink TeamCall Meeting Gateway (TMG).
    - Configuring alternate host name for Web Chat
      The default host name for Meetings and Web Chat are the same. However, you can configure Web Chat to use a different host name. In other words, you can use your chat host name instead of the default. There is a secondary cookie that is also used in the meeting authentication flow where if the cookie is present, then the redirect target is pulled from the cookie instead of the TARGET= parameter.
    - Enabling meeting dial-out
      You can enable the dial-out option on Docker and Kubernetes.
    - Configuring the maximum number of meeting participants
      A maximum of 100 users are supported in a meeting regardless of the selected meeting mode. To reach a wider audience, you can start a live stream and share the link to all intended participants.
    - Enable Videobridge for TCP
      This section provides steps to configure TCP for media streams using TCP port 4443.
    - Disable sharing of meeting recording
      By default meeting recordings can be shared with others. You can change a setting to disable sharing of meeting recordings.
    - Enabling Microsoft Outlook Add-in
      To use the Sametime Meetings add-in for Microsoft Outlook, it must be enabled on the Sametime server. The add-in is provided as part of Sametime installation package.
    - Setting up a TURN server
      A TURN server can be configured to provide for efficient traffic flow within your Sametime meeting.
      - Installing a TURN Server on Ubuntu
        You can install and configure a TURN server to use with Sametime Meeting on an Ubuntu operating system.
      - Installing a TURN Server
        You can install and configure a TURN server to use with Sametime Meetings.
      - Configuring the TURN server for Docker and Podman
        You can configure the Sametime Meeting service to enable a TURN server on port 443 for Docker.
      - Configuring the TURN server for Kubernetes
  - Integrating with other applications
    Integration with an application such as Verse prior to Sametime 12.0 requires the legacy web-client interface. Beginning in Sametime 12.0 the legacy web-client is not enabled by default, but can enabled when needed for integration with other products.
  - Monitoring your meeting and chat metrics with Grafana
    Sametime uses the third-party software, Grafana, to generate insightful graphs and visualizations derived from time-series database (TSDB) data. Integrating Grafana into your Sametime environment allows you to see analytic metrics about Sametime meetings and chats on a Grafana dashboard. The metrics can be used to monitor Sametime usage and resources.
  - Push messaging through a proxy
    Depending on your network settings, your firewalls could prevent Sametime proxy from connecting to push networks like Apple Push Notification Service (APNS) and Firebase Cloud Messaging (FCM) through the Internet. Sametime supports the sending of APNS and FCM messages through a proxy server. If you need to send APNS or FCM message through a proxy server in your environment, you need to configure the settings for the messages you want routed through the proxy.
- Securing
  This section provides information on securing your HCL Sametime environments.
- Administering
  This section provides information on administering on Sametime environments.
- Troubleshooting
  This section provides information on troubleshooting and supporting Sametime environments.
- Uninstalling Sametime
  In the event that Sametime must be removed, follow the procedure for the platform that Sametime is installed on.
- Migrating and Upgrading
  This section provides information on migrating data from an earlier release to Sametime 12.
- Notices

Configuring the TURN server for Docker and Podman

You can configure the Sametime Meeting service to enable a TURN server on port 443 for Docker.

About this task

The Docker and Podman commands are similar. The only difference is that docker precedes the command when issued in a Docker environment and podman precedes the name in a Podman environment. Example commands used in the Sametime documentation are shown using Docker. For Podman, change docker to podman.

Procedure

Update the following configuration in the custom.env file.

# Enable TURN for JVB (bridge mode) connections
TURN_ENABLE=1

# Secret for connect to TURN server
# Add the same secret that you used to configure TURN server.
TURN_SECRET=secret

# Announce FQDN/IP address of the turn server via XMPP server (XEP-0215).
# If empty or not set, variable DOCKER_HOST_ADDRESS will be used by default.
TURN_HOST=turn.example.com

# TLS/TCP/UDP turn port for connection
TURN_PORT=443

# Transport for stun/turn connection. Can be tcp or udp.
TURN_TRANSPORT=tcp

Add the following configuration to the custom.env file.
```
TURN_CREDENTIALS=secret
```
Update the following configuration in the .env file.
```
GLOBAL_MODULES=turncredentials
```
Start the Sametime server to apply the changes.
```
docker compose up -d
```

Rate this topic

5 stars 4 stars 3 stars 2 stars 1 star

Comment on this topic.

By clicking this box, you acknowledge that you are NOT a U.S. Federal Government employee or agency, nor are you submitting information with respect to or on behalf of one. HCL provides software and services to U.S. Federal Government customers through its partners immixGroup, Inc. Contact this team at https://hcltechsw.com/resources/us-government-contact. Do not include any personal data in this Comment box. Note: To report a problem or question about the product software, do not use this form. Instead, go to the HCL Software Support site.