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.
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.
Configuring Docker and Podman to run Grafana

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.
  - 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.
    - Configuring Docker and Podman to run Grafana
    - Configuring Kubernetes to run Grafana
  - 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 Docker and Podman to run Grafana

Before you begin

Ensure that the following ports for the different monitoring services are open.
- Grafana: 3001
- Prometheus: 9091
- Pushgateway: 9092
- Node-exporter: 9100
- Cadvisor: 8088
When applicable, ensure that these services are up and active for panels to be working.
- Pushgateway: http://host.docker.internal:9092
- Proxy metrics: http://host.docker.internal:8081/actuator/prometheus
- Cadvisor: http://host.docker.internal:8088/containers
Note: If using a local server, replace host.docker.internal with localhost.

About this task

You must have Grafana administrator privileges to configure the Sametime Grafana dashboard.

Procedure

Edit the docker-compose.yml file. Locate the community statement under environment and add the following environment variable after it.
```
MONITORING_ENABLED=true
```
Run the command to start monitoring services.
```
docker-compose -f docker-compose.yml -f docker-compose-monitoring.yml up -d
```
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.
When using a remote setup, navigate to the Grafana sign-in page in your browser.
```
http://host.docker.internal:3001
```
Note: 3001 is the default port for Grafana. Alternatively, you can use localhost:3001 if you are on your local machine.
Enter admin for both username and password, and then select Sign In. If successful, you will be prompted to change the password.
Select OK and enter the new password.
From the side menu, select Settings .
Select Data sources.
Select Add data source.
Select Prometheus as the data source.
Open the Prometheus data source and edit the settings. Under the HTTP section, enter the following URL.
```
http://host.docker.internal:9091
```
Select Save and test. A message is displayed to confirm if the data source is working.
Upload the Docker_Sametime_Dashboard.json file. For more information, contact HCL Customer Support.
Select Prometheus (default) as data source and then select Import.
Save the dashboard.

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.