Configure an external proxy
Last updated
Was this helpful?
Last updated
Was this helpful?
This documentation is for the CARTO Self-Hosted Legacy Version. Use only if you've installed this specific version. Explore our latest documentation for updated features.
CARTO Self-hosted supports operating behind an HTTP or HTTPS proxy. The proxy acts as a gateway, enabling CARTO Self-hosted components to establish connections with essential external services like CARTO licensing system, or auth.carto.com. You can find detailed information about these components and services in the network requirements section.
CARTO Self-hosted does not provide or install any proxy component; It's built to connect to an existing proxy software deployed on your side.
A comprehensive list of domains that must be whitelisted by the proxy for the proper operation of CARTO Self-hosted can be found here. Such list includes domains for the core services of CARTO Self-hosted, as well as some optional domains that should be enabled to access specific features.
In order to configure an external HTTP proxy on your CARTO Self-hosted installation, you'll have to:
Set the following environment variables (both in uppercase and lowercase) in your .env file:
HTTP_PROXY (mandatory): Proxy connection string, consisting of http://<hostname>:<port>.
HTTPS_PROXY (mandatory): Same as HTTP_PROXY.
GRPC_PROXY (mandatory): Same as HTTP_PROXY.
NO_PROXY (optional): Comma-separated list of domains to exclude from proxying.
To configure an HTTPS proxy on CARTO Self-hosted, you'll have to change the following configuration:
Set the following environment variables (both in uppercase and lowercase) in your .env file:
HTTP_PROXY (mandatory): Proxy connection string, consisting of https://<hostname>:<port>.
HTTPS_PROXY (mandatory): Same as HTTP_PROXY.
NO_PROXY (optional): Comma-separated list of domains to exclude from proxying.
NODE_EXTRA_CA_CERTS (optional): Path to the proxy CA certificate. If the proxy certificate is signed by a custom CA, such CA must be included here. If the proxy certificate is signed by a well known CA, there is no need to add it here. Well known CAs are usually part of the ca-certificates package
NODE_TLS_REJECT_UNAUTHORIZED (optional): Specify if CARTO Self-hosted should check if the proxy certificate is valid (1) or not (0). For instance, self signed certificates validation must be skipped.
While certain data warehouses can be configured to work with a proxy, there are some providers that will inherently bypass it. This means that the connection to these data warehouses won't be created through the proxy, so CARTO Self-hosted services will try to directly perform requests to the providers.
BigQuery: It supports both HTTP and HTTPs proxy.
PostgreSQL and Redshift: They use a TCP connection instead of HTTP(S), so the proxy is bypassed.
Databricks: Proxy is not supported, so the HTTPS connection will be bypassed.
Snowflake: It supports HTTP proxy, but HTTPS is not supported and will have to be bypassed. In order to bypass it, you'll have to add snowflakecomputing.com to the list of excluded domains.
When the proxy is bypassed, and you have a restrictive network policy in place, you will need to explicitly allow this egress of non-proxied traffic.
Password authentication is not supported for the proxy connection.
Importing data using an HTTPS Proxy configured with a certificate signed by a Custom CA is not supported.
