Home
Administering HCL Traveler
Information on planning, installing, configuring, and administering HCL Traveler.
Planning for installation and configuration
There are many installation and configuration considerations you should review before installing the HCL Traveler server.
Capacity planning guidelines
This section provides guidance on capacity planning for various deployment configurations of the HCL Traveler server. It also touches on best practices for monitoring capacity.
Physical vs. virtual hardware
Most customers run at least some part of their Traveler environment on virtual hardware. Doing so is fully supported however to avoid pitfalls, use the following best practices.

Administering HCL Traveler
Information on planning, installing, configuring, and administering HCL Traveler.
- Planning for installation and configuration
  There are many installation and configuration considerations you should review before installing the HCL Traveler server.
  - Choosing a deployment configuration
    The HCL Traveler server can be deployed using several different configurations.
  - Planning HCL Traveler on Docker
    HCL Traveler on Docker is a full-function Domino on Docker server with Traveler preinstalled and configured to start whenever the Domino server starts. The Docker container runs Red Hat Linux, so Domino and Traveler are Linux also. As with any other Linux-based Domino, the HCL Domino Administrator Client must be run remotely on a Windows server connected to the the Docker image over the network.
  - Planning HCL Traveler on IBM® i
    There are several IBM® i operating system considerations to be aware of when planning the HCL Traveler server installation on IBM i.
  - Clustering and failover
    The key to any production environment is the enablement of redundancy to account for planned or unplanned outages.
  - Planning for device security
    This section provides information about each HCL Traveler security option and how they can be applied by device type. You can use this information to plan your security configuration for HCL Traveler on your devices.
  - Planning for user authentication
    HCL Traveler requires every HTTP request to be authenticated for the operations being done to be correctly associated with the proper user. Hence, anonymous access is not supported. This validation of identity, referred to as authentication, is typically handled by the HCL Domino HTTP task or a secure proxy such as HCL SafeLinx. This section provides information on the supported authentication types by client to help plan for the Traveler server's authentication configuration.
  - Planning for migration
    Migration covers a number of scenarios.
  - Language support
    This section lists and provides information on all supported languages for HCL Traveler.
  - Sync protocol support
    When data is synced between the server and device, it is done so utilizing a protocol which controls what the message content (the HTTP body) contains.
  - Capacity planning guidelines
    This section provides guidance on capacity planning for various deployment configurations of the HCL Traveler server. It also touches on best practices for monitoring capacity.
    - Physical vs. virtual hardware
      Most customers run at least some part of their Traveler environment on virtual hardware. Doing so is fully supported however to avoid pitfalls, use the following best practices.
    - Central processing units (CPUs)
      These days it doesn’t make sense to talk much about processing speed, as most CPUs are 2GHZ or better, which is more than sufficient for use with the Traveler product. Instead we discuss the number of CPUs allocated to the physical or virtual system.
    - Memory
      Similar to CPU, it’s no longer interesting to discuss memory speed as most memory is now capable of transfer rates of 2400MB per second or greater which is more than sufficient. Instead, it’s important to review the amount of available memory.
    - Disk configuration
      The number one recommendation for disk architecture to support an HCL Traveler deployment is to use solid state disks (SSDs) for the Traveler database volume. For a standalone environment, this is the volume used by the Traveler server. For HA environments, this is the volume used by the enterprise database server.
    - Enterprise database configuration
      A Traveler HA environment should be set up over a Traveler standalone environment. A Traveler HA environment offloads all the work to store, index, sort and retrieve relational data to an enterprise database management server (DBMS) like MySQL, DB2, or MS SQL Server. This greatly improves the performance and availability of the Traveler environment.
    - Network and geography
      Network is a broad term that encompasses any component that the Traveler server uses to communicate to service mobile devices.
    - Co-locating Traveler with other Domino applications
      In general, running other Domino applications on the Traveler server isn't recommended, including mail, Sametime, SMTP, POP, and so forth. Maximum performance of the Traveler environment is best achieved on dedicated hardware whether it be virtual or physical. That said, there are some scenarios where you may want to investigate running Traveler along with other Domino services.
    - Number of mobile devices
      When talking capacity, we always talk about the number of devices that will be connected to a particular Traveler environment rather than the number of users.
    - Type of mobile user
      Not all mobile device users are created equal and it is important to understand your user base to plan accordingly.
    - Theoretical device capacity
      Each environment is different, influenced by the user base, hardware, network, geography and other factors. Virtualization can also have an impact on server capacity. HCL recommends monitoring the environment on a regular basis to understand if your environment is below, above or has reached capacity.
    - Monitoring for capacity
      In general, the best metric to monitor for capacity is the Traveler server Availability Index (AI). The AI is a measure of the overall server capacity. The AI and overall health of the Traveler server can be checked with the tell traveler status command. For more information, see Tell_command.html.
  - Estimating the space needed for the HCL Traveler database
    You can estimate how much space is needed for the HCL Traveler database before it is installed.
- Installing the HCL Traveler server
  The following topics describe options for installing and uninstalling the server:
- Configuring HCL Traveler server
  The HCL Traveler configuration settings are part of the Domino® server document. The first time that the HCL Traveler server is started, it performs any necessary configurations. You might want to perform additional configurations beyond the basics. The following topics describe additional configuration options.
- Administering HCL Traveler
  The HCL Traveler server component functions as a Domino® server add-in task and responds to Domino server console commands. Topics in this section describe common administrative tasks for administering a HCL Traveler server.

Physical vs. virtual hardware

Most customers run at least some part of their Traveler environment on virtual hardware. Doing so is fully supported however to avoid pitfalls, use the following best practices.

Never run the Traveler server or the Traveler Enterprise Database Server on a virtual machine that shares resources on demand with other VMs. Sharing CPU, memory and disk I/O with other VMs can greatly impact the performance of the Traveler environment and should be avoided.
The virtual machine that is hosting the Traveler database must have a dedicated physical volume assigned (SSD recommended). In a standalone Traveler environment, this is the Traveler server itself. In an HA Environment this is the VM that is hosting the enterprise database instance that the Traveler environment is using. The Traveler database is disk I/O intensive, sharing this volume with other VMs will likely lead to disk I/O contention and poor performance. In addition, Spindle disk drives should never be used for the VM hosting the Traveler database. See the topic on disk configuration for more details.

If you follow these best practices, using virtual hardware can be a great way to save cost and allow for ease of scalability in deploying new environments in short a timeframe as usage grows. Each VM deployment is different, therefore it’s important to monitor the performance of your VMs to ensure they are meeting the demands of your environment.