Home
Installing
Use this documentation to install the HCL Domino® server and subsequently deploy the HCL Notes®client.
Installing and upgrading Domino® servers
Perform a new or upgrade install of one or many Domino® servers.
Preparing for installing and setting up Domino® servers
Installing an HCL Domino® server is the first part of deploying a server. The second part is using the Domino server setup program to configure the server.
One-touch Domino setup
Use one-touch Domino setup to simplify setting up a server.
Preparing input parameters for one-touch Domino setup
To prepare input parameters for one-touch Domino setup, follow the appropriate procedure, depending on whether you provide input through a JSON file or system environment variables.
Preparing input parameters in a JSON file
You can create a JSON file (.json) to provide input parameters for one-touch Domino setup.
JSON file schema validation
Domino provides a JSON schema for one-touch Domino setup that is used to validate JSON in a JSON input file.

Installing
Use this documentation to install the HCL Domino® server and subsequently deploy the HCL Notes®client.
- Installing and upgrading Domino® servers
  Perform a new or upgrade install of one or many Domino® servers.
  - Preparing for installing and setting up Domino® servers
    Installing an HCL Domino® server is the first part of deploying a server. The second part is using the Domino server setup program to configure the server.
    - Entering system commands
      Some of the procedures that follow include instructions for entering commands at the system command prompt.
    - Domino on Docker
      HCL Domino® is available as a container image that can be used with current Docker or Podman runtimes. HCL Domino is preinstalled on this image, allowing you to deploy Domino servers as containers with just a few commands.
    - Domino® server installation
      The first step in deploying a Domino® server is installation, or copying the program files to the system's local drive.
    - Disabling concurrent I/O and direct I/O on Domino® servers on AIX®
      Concurrent I/O (CIO) and Direct I/O (DIO) are not supported with Domino® servers. CIO is a file system feature introduced in IBM® AIX® 5.2.0.10, also known as maintenance level 01, in the Enhanced Journaling File system (JFS2). This feature improves performance for relational databases.
    - Domino® server setup program
      The Domino® server setup program guides you through the choices you make to configure a Domino server. Setting up the first Domino server in a domain establishes a framework that consists of the Domino Directory, ID files, and documents. When you set up additional servers, you build upon this framework.
    - Using the Domino® server setup program
      The following procedures describe the ways you can use the server setup program.
    - One-touch Domino setup
      Use one-touch Domino setup to simplify setting up a server.
      - Preparing input parameters for one-touch Domino setup
        To prepare input parameters for one-touch Domino setup, follow the appropriate procedure, depending on whether you provide input through a JSON file or system environment variables.
        Preparing input parameters in a JSON file
        You can create a JSON file (.json) to provide input parameters for one-touch Domino setup.
        Example: Minimal JSON file for first server setup
        This example shows JSON input for first server setup that specifies required parameters only.
        Example: Minimal JSON file for additional server setup
        This example shows JSON input for additional server setup that specifies required parameters only.
        Example: Full JSON file for first server setup
        This example shows JSON input for first server setup that specifies all available parameters.
        Example: Full JSON file for additional server setup
        This example shows JSON input for additional server setup that specifies all available parameters.
        Example: JSON for first server setup and a full configuration
        This example shows most of the possible JSON input parameters for first server configuration.
        JSON file schema validation
        Domino provides a JSON schema for one-touch Domino setup that is used to validate JSON in a JSON input file.
        Validating a JSON file in advance with the Domino Administrator
        You can use the Domino Administrator tool Validate JSON to validate that a JSON input file has valid JSON and conforms to a one-touch Domino setup schema.
        Validating a JSON file in advance from the command line
        HCL Domino comes with a simple command-line tool to use to validate a one-touch setup JSON configuration file.
        Preparing input parameters through system environment variables
        As an alternative to using a JSON file, you can use system environment variables to provide input parameters for one-touch Domino setup.
        Specifying passwords indirectly
        Any JSON parameter or system environment variable used for one-touch Domino setup that takes a password as a value can be specified indirectly through the use of keywords.
      - Invoking one-touch Domino setup
        To invoke one-touch Domino setup, follow the appropriate procedure, depending on whether you provide input through a JSON file or system environment variables and the platform on which you run Domino.
      - Troubleshooting one-touch Domino setup
        If you run into problems with one-touch Domino setup, use these tips to help troubleshoot.
    - Understanding the Domino® server certification log
      The Domino® certification log records server certification and ID information.
    - Domino® server registration
      Before you install and set up additional servers, you must register them. In effect, registering a server adds the server to the system. The server registration process creates a Server document for the server in the Domino® Directory and creates a server ID. After registering and installing a server, you use the server setup program to obtain a copy of the Domino Directory for the new server and to set up the server to run particular services and tasks -- for example, the HTTP service, the Mail Router, and so on.
    - Optional tasks to perform after Domino® server setup
      You can perform addition tasks after server startup.
    - Starting and shutting down the Domino® server
      Start the Domino® server at the server console.
    - Starting Domino® as an application or a Windows™ service
      If you have installed Domino® as a Windows™ service, when you start the Domino server, you are prompted to specify whether to start Domino as an application or a Windows service.
    - Using instant messaging in the Domino® Directory
      The Domino® Directory is enabled for instant messaging, meaning that you can conduct an online chat directly from the Domino Directory.
    - Running the Domino-Portal integration wizard
      Use the Domino-Portal integration (DPI) wizard to configure an IBM® WebSphere® Portal server to work with your Domino-based infrastructure.
  - Uninstalling a Domino® server
    While it is not necessary to uninstall a Domino® server prior to upgrading to a new Domino release, you may want to uninstall a server.
- Installing and upgrading Notes® clients
- Planning your upgrade to Notes and Domino 12.0.2
  Use this documentation to upgrade the existing Domino® server and subsequently upgrade the Notes® client to a new release. You can also upgrade additional clients such as Domino Administrator and Domino Designer clients and additional features and plug-ins such as the embedded HCL Sametime® client.

JSON file schema validation

Domino provides a JSON schema for one-touch Domino setup that is used to validate JSON in a JSON input file.

The JSON schema is provided as the file dominoOneTouchSetup.schema.json in the Domino program directory. If you use a JSON file as input to one-touch Domino setup, when you invoke one-touch Domino setup, your JSON file is validated automatically against this schema prior to any setup steps. If your JSON file is not valid, errors are written to IBM_TECHNICAL_SUPPORT/autoconfigure.log and one-touch Domino setup exits without performing any setup. This validation helps guard against a partially set up server. Note that not all errors can be detected by schema validation. Even with a valid JSON file, other errors are possible, such as specification of an invalid directory.

Domino also provides the means to validate the JSON in a JSON input file before invoking one-touch setup.