Define Proxies

JFrog Platform Administration Documentation

Content Type
Administration / Platform

Note

This feature is only available in self-managed JPDs.

In corporate environments, a proxy server is often required to access remote resources, such as a remote repository or a federated repository.

You can define any number of proxies on a JPD and use them with specific resources or services. To use a proxy, specify it when you configure the repository or remote resource.

In addition, you can define several default proxies that are scoped to different JFrog services. These default proxies are active once they are defined in the Platform. Some services allow you to override these defaults.

JFrog Platform supports several types of network proxy including NTLMv2 On Linux, you may use NTLMv2 only with CNTLM. To use NTLM run a third-party CNTLM container like https://hub.docker.com/r/robertdebock/docker-cntlm/.

To define a new proxy server:

  1. In the JFrog Platform, select Administration and go to Proxies > Configuration > Proxy Configuration. Click New. The New Proxy dialog appears.

  2. Enter values for the configuration fields that are relevant to the type of proxy you define. Fields that are not required by the proxy may be left blank. For example you may omit Username and Password values if you are not using authentication credentials, or with an NTLM proxy.

    Field

    Description

    Proxy Key

    The unique ID of the proxy.

    Default proxy

    The service(s) that use this proxy by default. Valid values include:

    • Platform Default: core services of the JFrog Platform. including Artifactory, Distribution, and Xray, use this proxy. See The Platform Default Proxy.

    • Artifactory: the Artifactory service connects to remote and Federated repositories through this proxy.

    • Distribution: when Distribution is installed, the Distribution service connects to Edge nodes through this proxy.

    • Xray: when JFrog security is installed, the Xray service connects to the Xray database through this proxy.

    Host

    The name of the proxy host.

    Port

    The proxy port number.

    Username

    The proxy username when authentication credentials are required.

    Password

    The proxy password when authentication credentials are required.

    NT Host

    The computer name of the machine (the machine connecting to the NTLM proxy).

    NT Domain

    The proxy domain/realm name.

    Redirecting Proxy target Hosts

    An optional list of newline or comma-separated host names to which this proxy may redirect requests.

    The credentials defined for the proxy are reused by requests redirected to all of these hosts.

  3. Click Create. The proxy appears in the table.

  4. (Optional) For a proxy connection secured by a self-signed certificate, add the certificate to the trusted certificate folder. For more information, see Trust a self-signed certificate or a new CA.Trust a self-signed certificate or a new CA

The Platform Default Proxy

When you define a platform default proxy it is used for the following connections. Some services let you override the default during configuration, as indicated.

  • Remote Repositories and Federated Repositories (Artifactory Service).

    Custom proxy and No_Proxy options can be configured per repository.

  • Mail Server

  • Webhooks (Event service)

    Custom proxy can be configured per webhook.

  • Bridge Client

    Proxy can be reconfigured after bridge creation.

  • JPD deployment and registration (Mission Control service)

    The No_Proxy option can be set in the sytem.yaml file.

  • Authentication providers and Access Federation (Access service)

  • Entitlements (JFConnect service)

  • Xray database (Xray service)

  • Edge Notes (Distribution service)