Configuring HTTPS

For IBM Automatic Data Lineage to work, Secured HTTP (HTTPS) communication must be configured on a reverse proxy. This can be done:

• Automatically by the Automatic Data Lineage installer, or

• Manually by the customer using their own reverse proxy.

If you use your own reverse proxy, Automatic Data Lineage's default proxy (Caddy) must be disabled. Caddy is an open-source reverse proxy included with Automatic Data Lineage. It can be enabled or disabled based on your setup.

Enabling Caddy

If you are installing Automatic Data Lineage on your own server (e.g., an on-premises VM) and do not have an existing reverse proxy, you should enable Caddy. During installation, you will be prompted to "Enable Caddy." Respond with Yes to enable it.

Consult your IT team to confirm whether an existing reverse proxy is already configured before enabling Caddy.

Disabling Caddy

If you already have a reverse proxy or plan to use one, Automatic Data Lineage's default proxy (Caddy) must be disabled.

Common scenarios:

• Running Automatic Data Lineage in AWS, Azure, or Google Cloud, where reverse proxies are typically pre-configured.

• Organizations with dedicated IT teams managing infrastructure and reverse proxy configurations.

Disabling Caddy and configuring your reverse proxy

1. Disable Caddy during installation.

   During the installation process, you will be asked whether to "Enable Caddy." Respond with No.

2. Update the manta.properties file.

   After installation, edit the manta.properties file to enable proxy integration:

   • Set the manta.https.proxy flag to true: manta.https.proxy=true

   • The file is located in the conf subdirectory of your Automatic Data Lineage installation folder ('mantaflow', by default):

     • Linux: mantaflow/conf/manta.properties

     • Windows: mantaflow\conf\manta.properties

3. Configure your reverse proxy.

   Set up your reverse proxy to make Automatic Data Lineage accessible over HTTPS. While Automatic Data Lineage does not provide specific guides for third-party proxies, the Caddyfile used for Automatic Data Lineage's configuration can be a useful reference:

   • Location:

     • Linux: mantaflow/caddy/conf/Caddyfile

     • Windows: mantaflow\caddy\conf\Caddyfile

   • Refer to Caddy proxy for more details.

   If needed, consult your IT team for assistance.

   When configuring your proxy, make sure not to impose stringent timeout constraints. Responses from Automatic Data Lineage can take a long time, so an error should not be thrown in such cases.

4. Restart Automatic Data Lineage services.

   Restart all Automatic Data Lineage services to apply the changes.

   • Shut down and restart the services manually or use the provided Automatic Data Lineage service scripts.