Proxy Settings

Last modified on July 27, 2021

Introduced in SwaggerHub On-Premise 1.18.5.

You can configure an HTTP/S proxy server for SwaggerHub On-Premise that will be used for outbound connections. “Try it out” requests, importing definitions, downloading upgrades, and other outbound HTTP/S traffic will be sent through the proxy unless the destination server is added to the proxy exception list.

Considerations

Only the HTTP/S proxy type is supported this time. The SOCKS proxy type is not supported.

The following functionality does not use a proxy and requires direct outbound access from your SwaggerHub On-Premise instance:

Configure the proxy

  1. Open the Admin Center.

  2. Select Settings on the left.

  3. In the Privacy section, select the Enable proxy check box.

  4. Specify your proxy server information:

    • Proxy host – Required. The proxy hostname or IP address.

    • Proxy port – Required. The proxy port.

    • Proxy username and Proxy password – Optional. If your proxy server requires authentication, enter the username and password here.

    • Bypass proxy for – Optional. A comma-separated list of hostnames or IP addresses that the system will always connect to directly. * can be used as a wildcard, for example: *.github.com, 198.51.100.*. See more examples below.

      Note: Do not include port numbers, localhost and local network IP addresses in this list.
  5. Click Save Changes and Restart (or Save Changes in earlier versions).

Test the proxy

  1. Open the Admin Center.

  2. Select Settings > Privacy on the left.

  3. In the Proxy Server Test field, enter a website that is not on the proxy exception list, and click Test Proxy.

If everything is OK, you should see “The URL provided is accessible”.

If you see an error, double-check the proxy settings with your network administrator.

Disable the proxy

  1. Open the Admin Center.

  2. Select Settings > Privacy on the left.

  3. Unselect Enable proxy.

  4. Click Save Changes and Restart (or Save Changes in earlier versions).

Proxy exceptions

The Bypass proxy for option specifies a list of proxy exceptions, that is, hosts or IP addresses that should be accessed directly, bypassing the proxy. Use commas to separate multiple entries, and * as a wildcard for any substring.

Hosts should not include the protocols and ports.

Correct: *.example.com

Incorrect: http://*.example.com:8080

The following table contains more examples of using wildcards:

Filter Description
example.com The exact example.com domain only, excluding subdomains. For instance, this will not match www.example.com.
*example.com All domains that end with example.com. For instance, www.example.com, api-example.com and others.
*.example.com Subdomains of example.com. Note the difference from the previous example.
*github.com,*bitbucket.com,*gitlab.com All domains that end with github.com, bitbucket.com or gitlab.com.
example.* All domains that start with example.: example.com, example.co.uk, example.sandbox.acme.com, and so on.
www.*.com All domains that start with www. and end with .com.
50.57.35.40 The exact IP address.
50.57.35.* IP addresses that begin with 50.57.35 (CIDR range 50.57.35.0/24).
50.*.35.* IP addresses such as 50.57.35.40, 50.100.35.0, and so on.
* Everything.

See Also

Configuring SwaggerHub On-Premise

Highlight search results