Proxy Server

Overview

The Proxy Server is an application that allows the Deadline Client applications to connect to a Deadline farm over HTTP, instead of connecting directly to the Deadline Repository and Database. If you would like to connect over HTTPS instead, you will need to set up a web server such as NGINX.

Note that the Proxy Server application itself should NOT be exposed to the internet, as it does not provide built-in support for authentication. This is to ensure that information about your render farm and its users are not open to the internet.

../_images/proxy_overview.png

Running the Proxy Server

To start the Proxy Server:

  • On Windows, you can start the Proxy Service by double clicking on deadlineproxyserver.exe in the Deadline installed folder, usually under

    C:\Program Files\Thinkbox\Deadline[VERSION]\bin
    
  • On Linux, you can start the Proxy Service from a terminal window by running the deadlineproxyserver script in the bin folder, usually under

    /opt/Thinkbox/Deadline[VERSION]/bin
    
  • On Mac OS X, you can start the Proxy Service from a terminal by running the DeadlineProxyServer application in

    /Applications/Thinkbox/Deadline[VERSION]/DeadlineProxyServer[VERSION].app/Contents/MacOS
    

where [VERSION] is the MAJOR release number of Deadline, such as 8.

Setup

The default IP and port settings can be set in the Deadline Monitor through the “Tools -> Configure Repository Options” menu, under the “Web Service and Proxy Server” tab.

../_images/proxy_configure.png

The options are:

  • IP Address: This is the default IP address the Proxy Server(s) will bind to and listen for incoming traffic. The Recommended value is 0.0.0.0
  • Listening Port: This is the default port the Proxy Servers will attach to. Default port is 8080

You can also configure the Proxy Servers through the command line using the -ip and -port command line flags. For example:

deadlineproxyserver.exe -ip 192.168.2.5 -port 1212

The Proxy Server will favor the command line settings over the default settings set in the Monitor.

Proxy Server can also be configured to automatically start and recover from a crash/shutdown via the Client Configuration ini file.

Proxy Servers Panel

The Proxy Servers can be monitored through the Deadline Monitor with the “Proxy Servers” panel. You can use this panel to check the state of the Proxy Servers and to monitor their CPU and memory usage.

../_images/proxy_panel.png

Connecting to the Proxy

The “Change Repository” dialog has been extended to include an option to connect to a Proxy.

../_images/proxy_connect.png

Select the “Use Proxy” radio button and fill in either the DNS or IP address of your Proxy Server and select the correct port number. If connecting with HTTPS, you can place the path to the PFX certificate in the “SSL Certificate” text box. See our SSL Certificate Generation documentation on how to create a SSL certicate for your chosen web server.

See also Firewall and Security Considerations to ensure you allow the Proxy Server to be accessible through your firewall.

Windows Namespace Reservation

If the Proxy Server is running on Windows, you may also need to add a namespace reservation for the current user that the Proxy Server is running under, so that it can reserve namespaces for the URL connection. See the Configuring Namespace Reservations section in this MSDN Article for more information. Note, Windows XP users require SP2 to be installed and XP 64bit does NOT support namespace reservation. It is recommended to use a server based Windows OS such as Windows 2003, 2008 R2, 2012 or newer.

Note that by default, the Proxy Server listens on http://+:8080/, so make sure you set the port number correctly in the URL you use when reserving the namespace. For example:

netsh http add urlacl url=http://+:8080/ user=USERNAME

Ensure you have correctly elevated permissions when executing the above in a command prompt and replace USERNAME with the appropriate %USERNAME% that the Proxy Server is running under. Depending on your local security policy, the user account may need to have local administrator rights temporarily for you to initially reserve the namespace. The namespace reservation will also need updating if you ever modify the port number or user account used. Use the following command in a command prompt to help list what namespace reservations are currently present on your machine:

netsh http show urlacl

Note that this is NOT the same reservation that is required for the Web Service.

HTTPS and Load Balancing

HTTPS and Load Balancing are achieved using a Web Server such as NGINX.

To create SSL certificates see the SSL Certificate Generation documentation.

FAQ

Is Proxy Server used for usage based licensing or 3rd party licensing?

No. This is handled by the Cloud License Server Proxy and License Forwarder application respectively.