Self-Signed Certificate (SSL) environment variables

In some infrastructure setups, you might run into problems connecting to Neptune because of the SSL certificate configuration. This can happen if, for example:

• You are in a corporate network, behind a proxy that inspects traffic between your runs and Neptune SaaS.
• The SSL/TLS certificate of your self-hosted installation is not recognized by Python by default.
• The software on your machine is not up to date.

The above problems may result in a NeptuneConnectionLostError. To solve it, set the NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE and NEPTUNE_VERIFY_SSL environment variables to True.

note

The Neptune API currently consists of two Python packages:

• neptune-scale, for logging metadata to Neptune.
• neptune-fetcher, for fetching logged metadata from Neptune.

The NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE variable of neptune-scale corresponds to the NEPTUNE_VERIFY_SSL variable of neptune-fetcher. We plan to unify these variables, but for now, you must set each of them separately.

NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE

Python package: neptune-scale

If not set, the default value is False.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_VERIFY_SSL=True

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_VERIFY_SSL=True

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_VERIFY_SSL True

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.

NEPTUNE_VERIFY_SSL

Python package: neptune-fetcher

If not set, the default value is False.

Linux

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE=True

macOS

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE=True

Windows

In a terminal app, such as PowerShell or Command Prompt, enter the setx command and press enter:

setx NEPTUNE_ALLOW_SELF_SIGNED_CERTIFICATE True

To activate the change, restart the terminal app.

You can also navigate to Settings → Edit the system environment variables and add the variable there.