Skip to Content

Proxy server for Jitterbit private agents

Introduction

You can configure a private agent to communicate via a proxy server. How you do this depends on your agent's platform, and whether the agent is already installed and running. In any case, you must know the details of the proxy server (hostname, port number, login credentials). These are referred to in the following sections by the placeholder keywords shown below, which you should replace with the values for your proxy server:

Keyword Value
HOSTNAME Hostname or IP address.
PORT (Optional.) Port number. Default: 0.
USERNAME/PASSWORD (Optional.) Username and password for servers requiring authentication.
NTLM_DOMAIN (Optional.) NTLM domain for NTLM authentication.

Tip

For an HTTPS proxy, you must add a certificate to the Java keystone.

Configure a proxy during agent setup

To configure a proxy while setting up an agent, follow these steps:

  1. On the Login Credentials page of the standard installer, click Enable Proxy.

  2. On the Proxy Information page, enter your proxy server's information, select the options you want, then click the Ok button:

    Proxy configure

  3. Restart the agent.

You can not configure a proxy server before agent setup, and must use the command line or configuration utility after agent setup.

  1. In the [Configure](/agent/linux/#configure step, add the arguments shown below to the jitterbit-config command before running it:

    jitterbit-config --proxy-host HOSTNAME[:PORT] \
--proxy-user USERNAME \
--proxy-password PASSWORD \
--proxy-ntlm-domain NTLM_DOMAIN

  2. Restart the agent.

  1. Set up a reverse proxy.

  2. Configure Docker to use a proxy server.

  3. Set values for the following environment variables to be passed to your container's environment (passed with the -e/--env or --env-file options):

    Environment variable Value
    PROXY_SERVER_HOSTNAME HOSTNAME
    PROXY_SERVER_USERNAME USERNAME
    PROXY_SERVER_PASSWORD PASSWORD
    PROXY_SERVER_PORT PORT
    http_proxy http://host.docker.internal:8888
    https_proxy https://host.docker.internal:8888

  4. Start the container using manual registration and environment variables.

Configure after agent setup

To use a proxy after setting up an agent, follow these steps:

You can configure a proxy on the command line or with the configuration utility:

  1. In a Command Prompt or PowerShell, run the JitterbitUtils.exe command:

    JitterbitUtils.exe --set-http-proxy-host HOSTNAME[:PORT] `
--set-http-proxy-username USERNAME `
--set-http-proxy-pwd PASSWORD `
--set-http-proxy-domain NTLM_DOMAIN

  2. Restart the agent.

  1. Select Start > Jitterbit Agent > Configure Jitterbit. The Jitterbit Agent Configuration Utility opens.

  2. Enter your proxy server's information, select the options you want, then click the OK button:

    Configure Jitterbit

  3. Restart the agent.

  1. Run the jitterbit-utils command:

    jitterbit-utils --set-http-proxy-host HOSTNAME[:PORT] \
--set-http-proxy-username USERNAME \
--set-http-proxy-pwd PASSWORD \
--set-http-proxy-domain NTLM_DOMAIN

  2. Restart the agent.

Disable proxy

To stop a private agent from using the configured proxy server, follow these steps:

  1. Run this command:

    JitterbitUtils.exe --disable-http-proxy

  2. Restart the agent.

Note

This does not disable an NTLM proxy. To do that, use the configuration utility.

  1. Select Start > Jitterbit Agent > Configure Jitterbit.

  2. When the Jitterbit Agent Configuration Utility opens, click the Clear button, then the OK button.

  3. Restart the agent.

  1. Run this command:

    jitterbit-utils --disable-http-proxy

  2. Restart the agent.