Skip to main content
Version: 10.3

Configuring HTTPS in Ingress

Open iT Ingress is configured to use secure browsing (HTTPS) by default, with an SSL Certificate and Key. If you need further configuration for the HTTPS setup, please review the relevant section for detailed instructions.

Configure HTTPS with Windows Certificate Store​

Open iT Ingress can use secure browsing (HTTPS) using SSL certificates installed in the Windows Certificate Store.

Step 1: Open the Ingress Configuration Directory​

  1. Go to the Open iT Ingress configuration directory.

    By default, this is located at: C:\Program Files\OpeniT\Ingress\configuration.

Step 2: Create or Open the Override File​

  1. Create a copy of SiteBindings.json.

  2. Rename the duplicate file to SiteBindings.Override.json.

    tip

    Override files are used to store custom or environment-specific configuration changes separately from the default configuration. This approach helps preserve the original settings, simplifies upgrades, and ensures that custom modifications are not accidentally overwritten.

  3. If a SiteBindings.Override.json file already exists, open the existing file instead.

Step 3: Update the Site Bindings Configuration​

  1. In the override file, input the necessary details.

    FieldsDescription
    PreflightCheckPortUse this to enable or disable the preflight check that verifies whether the configured port is available before proceeding. The default value is true. Set the value to false to skip the check.

    Setting PreflightCheckPort to false skips the port availability check before Ingress attempts to bind to the configured port. If the port is already in use, Ingress fails immediately. When set to true, the installation continues and displays warnings if a potential port conflict is detected.
    SchemeUse this to specify the https protocol.
    HostUse this to specify the hostname or domain name.
    Warning: Hostnames or domain names cannot contain underscores _ since this is an invalid character according to the DNS specifications and RFC standards.
    PortUse this to specify the port number. You can use the default port for HTTPS, 443.
    StoreUse this to specify the Certificate Store where your SSL certificate is stored.
    LocationUse this to specify the appropriate store location.
    Required Fields for SSL Configuration in the Override File

    The Store field accepts only predefined certificate store values. These stores indicate where the SSL certificate is stored on the system. Refer to the table below for supported values and their usage:

    StoresDescription
    MyUse this to specify the Personal store, commonly used for client certificates or private keys.
    RootUse this to specify the Trusted Root Certification Authorities.
    AuthRootUse this to specify the Third-party Root Certification Authorities.
    TrustedPeopleUse this to specify the certificates of the trusted people.
    TrustedPublisherUse this to specify the trusted publishers, typically used for code signing.
    CA or Certificate AuthorityUse this to specify the intermediate Certification Authorities.
    AddressBookUse this to specify other users that are used for email encryption certificates.
    DisallowedUse this to specify revoked and explicitly untrusted certificates.
    Supported Certificate Stores for SSL Configuration

    The Location field determines where the certificate store is located. Choose one of the supported values below depending on whether the certificate applies to the current user, all users, or specific services:

    Store LocationDescription
    CurrentUserUse this to specify certificates that are available only to the currently logged-in user.
    LocalMachineUse this to specify certificates that are available system-wide for all users.
    ServiceUse this to specify certificates used by specific Windows services (e.g., IIS, SQL Server).
    GroupPolicyUse this to specify certificates deployed via Group Policy, which can apply either to a user or a machine.
    Supported Store Locations for SSL Configuration

    SiteBindings.Override.json
    {
        "PreflightCheckPort": true,
        "SiteBindings": [
            {
                "Scheme": "https",
                "Host": "customer1.openit.com",
                "Port": "443",
                "Certificate": {
                    "Store": "My",
                    "Location": "LocalMachine"
                }
            }
        ]
    }

  2. Save the file.

Step 4: Restart the Open iT Ingress Service​

  1. Open the Task Manager.

  2. Go to the Services tab.

  3. Restart the OpeniTIngress service.

Configure HTTPS with an SSL Certificate and Key​

Open iT Ingress can use secure browsing (HTTPS) using an SSL certificate and key.

Step 1: Open the Ingress Configuration Directory​

  1. Go to the Open iT Ingress configuration directory.

    By default, this is located at: C:\Program Files\OpeniT\Ingress\configuration.

Step 2: Create or Open the Override File​

  1. Create a copy of SiteBindings.json.

  2. Rename the duplicate file to SiteBindings.Override.json.

    tip

    Override files are used to store custom or environment-specific configuration changes separately from the default configuration. This approach helps preserve the original settings, simplifies upgrades, and ensures that custom modifications are not accidentally overwritten.

  3. If a SiteBindings.Override.json file already exists, open the existing file instead.

Step 3: Update the Site Bindings Configuration​

  1. In the override file, input the necessary details.

    FieldsDescription
    PreflightCheckPortUse this to enable or disable the preflight check that verifies whether the configured port is available before proceeding. The default value is true. Set the value to false to skip the check.

    Setting PreflightCheckPort to false skips the port availability check before Ingress attempts to bind to the configured port. If the port is already in use, Ingress fails immediately. When set to true, the installation continues and displays warnings if a potential port conflict is detected.
    SchemeUse this to specify the https protocol.
    HostUse this to specify the hostname or domain name.
    Warning: Hostnames or domain names cannot contain underscores _ since this is an invalid character according to the DNS specifications and RFC standards.
    PortUse this to specify the port number. You can use the default port for HTTPS, 443.
    CertUse this to specify the path to the SSL certificate.
    KeyUse this to specify the path to the SSL key.
    Required Fields for SSL Configuration in the Override File

    SiteBindings.Override.json
    {
        "PreflightCheckPort": true,
        "SiteBindings":  [
            { 
                "Scheme": "https",
                "Host": "customer1.openit.com",
                "Port": "443",
                "Certificate": {
                    "Cert": "C:\Program Files\OpeniT\Ingress\configuration\caddy\ssl.crt\server.crt",
                    "Key": "C:\Program Files\OpeniT\Ingress\configuration\caddy\ssl.key\server.key"
                }
            }
        ]
    }

  2. Save the file.

Step 4: Restart the Open iT Ingress Service​

  1. Open the Task Manager.

  2. Go to the Services tab.

  3. Restart the OpeniTIngress service.

Configure HTTPS using Let's Encrypt​

warning

If you are using Let’s Encrypt Auto HTTPS, ensure that port 80 is open and not being used by any other service, as it is required for certificate validation.

If port 80 cannot be made available, use a local certificate and key instead of Let’s Encrypt Auto HTTPS.

Open iT Ingress can use secure browsing (HTTPS) using Let's Encrypt.

Step 1: Open the Ingress Configuration Directory​

  1. Go to the Open iT Ingress configuration directory.

    By default, this is located at: C:\Program Files\OpeniT\Ingress\configuration.

Step 2: Create or Open the Override File​

  1. Create a copy of SiteBindings.json.

  2. Rename the duplicate file to SiteBindings.Override.json.

    tip

    Override files are used to store custom or environment-specific configuration changes separately from the default configuration. This approach helps preserve the original settings, simplifies upgrades, and ensures that custom modifications are not accidentally overwritten.

  3. If a SiteBindings.Override.json file already exists, open the existing file instead.

Step 3: Update the Site Bindings Configuration​

  1. In the override file, make sure that the Cert and Key fields are empty.

    SiteBindings.Override.json
    {
        "PreflightCheckPort": true,
        "SiteBindings":  [
            { 
                "Scheme": "https",
                "Host": "customer1.openit.com",
                "Port": "443",
                "Certificate": {
                    "Cert": "",
                    "Key": ""
                }
            }
        ]
    }

  2. Save the file.

Step 4: Restart the Open iT Ingress Service​

  1. Open the Task Manager.

  2. Go to the Services tab.

  3. Restart the OpeniTIngress service.

Add Multiple Site Bindings​

Site bindings define the network endpoints where Open iT Ingress listens for incoming requests. Each binding specifies the host, port, protocol, and certificate used to receive and secure client connections.

Since site bindings are configured at the system level rather than through the web interface, they must be added or modified directly on the machine where Ingress is installed. This section describes how to configure multiple site bindings.

Step 1: Open the Ingress Configuration Directory​

  1. Go to the Open iT Ingress configuration directory.

    By default, this is located at: C:\Program Files\OpeniT\Ingress\configuration.

Step 2: Create or Open the Override File​

  1. Create a copy of SiteBindings.json.

  2. Rename the duplicate file to SiteBindings.Override.json.

    tip

    Override files are used to store custom or environment-specific configuration changes separately from the default configuration. This approach helps preserve the original settings, simplifies upgrades, and ensures that custom modifications are not accidentally overwritten.

  3. If a SiteBindings.Override.json file already exists, open the existing file instead.

Step 3: Add a New Site Binding​

  1. In the override file, copy the entire site binding section.

    For example, copy the contents from line 3 to 11.

    SiteBindings.Override.json
    {
        "PreflightCheckPort": true,
        "SiteBindings":  [
            { 
                "Scheme": "http",
                "Host": "",
                "Port": "8080",
                "Certificate": {
                    "Cert": "",
                    "Key": ""
                }
            }
        ]
    }

  2. Paste the copied contents at the end of the SiteBindings array.

  3. Add a comma , to separate each site bindings.

    SiteBindings.Override.json
    {
        "PreflightCheckPort": true,
        "SiteBindings":  [
            { 
                "Scheme": "http",
                "Host": "",
                "Port": "8080",
                "Certificate": {
                    "Cert": "",
                    "Key": ""
                }
            },
            { 
                "Scheme": "http",
                "Host": "",
                "Port": "8080",
                "Certificate": {
                    "Cert": "",
                    "Key": ""
                }
            },
            { 
                "Scheme": "http",
                "Host": "",
                "Port": "8080",
                "Certificate": {
                    "Cert": "",
                    "Key": ""
                }
            }
        ]
    }

  4. Modify the values in the additional site binding(s) as needed.

    You may also use the following sections for reference:

  5. Save the file.

Step 4: Restart the Open iT Ingress Service​

  1. Open the Task Manager.

  2. Go to the Services tab.

  3. Restart the OpeniTIngress service.