1 Render Farm Service Configuration

1.1 Minimum Setup

At a minumum, the following items must be configured for your render farm to be able to accept cloud-based job submissions:

  1. Router settings
  2. Cloud service configuration settings ( see Main Configuration Window )
  3. Email settings ( see Email Setup )
  4. Enabling render farm for remote access

Note

Make sure you register your SquidNet license before following this procedure. (see License Registration section)

1.1.1 Router Settings

The following ports must be opened on your local router.

  • TCPIP 17388: HTTP non-secure connection to Web/JSON interface
  • TCPIP 17389: HTTPS secure connection to Web/JSON interface
  • TCPIP 17392: Cloud Transport Protocol (CUI) OpenSSL AES-256.
  • TCPIP 17393: Cloud User Interface (CUI) OpenSSL AES-256.

These ports must be port-forward (routed) to the SquidNet master on your render farm.

Make sure these ports are open on your firewall before attempting to use. You can check your port WAN status using this port tester.

1.1.2 Cloud SSL Certificate

If you’re planning on using the secured HTTPS Web/JSON interface, you may need to acquire an official SSL Certificate for SquidNet’s internal web server. By default, SquidNet uses an automatically-generated self-signed SSL Certificate which is sufficient for most localized testing. However, this certificate may not be sufficient as some web management services like Microsoft’s IIS server may require a trusted HTTPS connection.

To configure SquidNet to use your SSL Certificate, follow these steps:

  1. Acquire an SSL Certificate from a well-know Certificate Authority (CA). Follow CA instructions for generating a certificate signing request (CSR) for your domain (example: cloud.<render-service>.com)
  2. Make sure Private key and SSL Certificate are in PEM format then append to a single file named https_ssl2.pem.
  3. Copy PEM formatted file to <squinet-install>/webroot folder. Override any existing https_ssl2.pem file.
  4. Restart SquidNet service to re-load new SSL Certificate.

Here’s an example of what the PEM file should look like:

-----BEGIN RSA PRIVATE KEY-----
MIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDmhM8xbNWoCTCj
3xsRkTnmnUMIo6m1nL/Gt9JKDY4r3WhnyWr+jgqKE+62OKGmrzcSlKlEkGGKldJP
.
.
.
9t569IMO/Na0QgB8d64MOCxLI5BcLMeHUddXD6N+0VN8GTBazzDOlXW8W8cphB8K
slGCA9qSOGYtjLtl6WERtw7jovbUbQbE6JgsRh6p9n2je8gtrniCpzdEBUNmRSyT
kaNkeeew6zJELqZqZhZuupxu
-----END RSA PRIVATE KEY-----
-----BEGIN CERTIFICATE-----
MIIFejCCBGKgAwIBAgIJRRU1RsfVCG1GMA0GCSqGSIb3DQEBCwUAMIGNMQswCQYD
VQQGEwJUUjFNMEsGA1UECgxEVMOcUktUUlVTVCBCaWxnaSDEsGxldGnFn2ltIHZl
.
.
.
/tVI9BdjndPt2+Nv4OFc3LSLfXF/brh0mfBasTRfa/qTP5/C1lYpUPe2NQFZmReU
tvKAwXxxGtvqcnqbt6gwEQwJeWFzYXJlZHUABAQBAAAA
-----END CERTIFICATE-----

Validate that your private key and certificate are a match by using this website: https://www.sslshopper.com/certificate-key-matcher.html Alternatively, you can use the openssl command line tool to verify your csr, private key and site certificate:

openssl rsa -noout -modulus -in *<private.key>* | openssl md5
openssl x509 -noout -modulus -in *<certificate.crt>* | openssl md5
openssl req -noout -modulus -in *<request.csr>* | openssl md5

* Ensure that all MD5 hashes are identical.

To decode your SSL certificate, use the following website: https://www.sslshopper.com/certificate-decoder.html. Just cut/paste in your certificate portion of the PEM fie.

To ensure that your PEM file is correct, do a port test to https://cloud.<render-service>.com:17389 or point your web browser to https://cloud.<render-service>.com:17389 and verify that you’re not asked for a securty exception.

1.1.3 Cloud Connection Settings

_images/cloud_configuration.jpg

Cloud Configuration Settings.

In the main cloud configuration window (Main Configuration Window) , set the following fields:

1.1.4 Setting Render Farm Online

If configured correctly, you’ll now be able to connect to your farm from the CUI. To enable, select the “Change” status button and set the state of your render farm to online.

_images/cloud_status.png

Cloud Connection Status Settings.

1.1.5 Testing Connection

_images/cui_login.jpg

Cloud User Interface Login

To test the internet connection to your render farm, open the CUI and enter the following fields:

  • Render Farm URL: www.my_render_farms_service.com
  • Studio Account: Renderfarm
  • Username: administrator
  • Password: administrator

Caution

Renderfarm is the default studio account for local rendering and remote administration/configuration. The default password is administrator. Make sure to change the password (admin->Render Farm Accounts …) as soon as it’s convenient.

1.1.6 Creating Studio Account

_images/cloud_create_studio_account.jpg

Creating a Studio Account

If you have a SQUIDNET RENDER FARM LICENSE you can now start creating your user studio accounts by doing each of the following tasks:

  1. Create a new studio account.
  2. Enter specific customer information including website URL, email notications and list of rendering applications that will be used.
  3. Rendering lease that contains render credits to be used by user.

You can create your first studio account by selecting the (right-click->Create new studio account…) menu item in the Configuration tab in the Cloud Rendering Window … or select the (New Studio) button at the bottom of the window.

1.1.7 Editing Studio Account

_images/cloud_edit_studio_account.jpg

Editing a Studio Account

With the new studio account window open, enter the following information (at a minimum):

  • Studio Name: Enter the name of your customer.
  • Notification Emails: A comma-separted list of customer admins that will be receiving nofication emails (job completion reports, alerts, updates, etc… )
  • Application Profiles: List of application profiles that user will be using on your farm.

Press the “Apply” button to add the account to the SquidNet SQL database.

1.1.8 Creating Studio Account Lease

_images/cloud_create_lease.jpg

Creating Studio Account Lease

With the new studio account now added to the database, select the new account in the listing, (right-click->Add new lease) then set the following parameters:

  • Lease Tile: The name of the lease (example: BASE_LEASE)
  • Lease Status: Select Active from the dropdown list
  • Render Queue: Select the render queues that will be used.
  • Render Credit Allocation: Determine how many render credits the customer can use.

Press the “Apply” button to add the lease to the SquidNet SQL database. You can now log into the Cloud User Interface with the information that was just added.

Note

Make sure to check the Studio name at the top of the lease to make it’s being assigned to the proper studio account.

1.1.9 FileZilla Server Transport Settings (Windows Only)

If you’ll be using FileZilla Server to act as your farm’s transport service for the uploading and downloading of content you’ll need to use the FileZilla Server Configuration settings to integrate SquidNet with FileZilla Server.

Prerequisites:

  • Install FileZilla Server: Download and install FileZilla Server from FileZilla Website.
  • Open Ports: Open the following ports on your router’s firewall:
    • Port 21: FTP protocol port (explicit FTP).
    • Port 990: FTP protocol port (implicit FTP).
    • Port 14147-14447: FTP Passive Mode ports.
    • Port 2100: Only required if not using standard FTP port 21.
  • Verify Port: Verify FTP port(s) are open by using this port tester.
  • Service Account: To avoid network permission issues, change the FileZilla Server Service account to use SquidNet’s Service account. By default, FileZilla Server runs under the Windows SYSTEM account which may not have access to network resources.

** Refer to FileZilla Server Configuration for additional information.

In SquidNet master GUI, open FileZilla Server Configuration window (lower right corner in Main Configuration Window), set the following fields:

  • FileZilla Server Install Path: Location of FileZilla Server installation. Typically located in C:Program Files (x86)FileZilla Server
  • FTP URL: URL to your FTP website.
  • FTP Port: Port number (21).
_images/filezilla_settings.jpg

FileZilla Configuration Settings.

1.1.9.1 FileZilla Server Configuration

Depending on your local network’s setup (Firewall, NAT, etc.. ), you may need to edit some of the settings within FileZilla Server.

To test your FTP connection, use https://ftptest.net to verify your settings. (website.)

_images/filezilla_passive_mode.jpg

Passive Mode Settings.

If using FTP in Passive Mode:

  • Select “Use Custom Port Range” checkbox and enter in a valid port range. Make sure these ports are open on your router’s firewall.
  • Select “Retrieve external IP address from:” check box. Use the default URL.
  • Select “Don’t use external IP for local connections”
_images/filezilla_disable_ip_check.jpg

Disable IP Checking Settings.

Use the above settings to disable IP addess checking

_images/filezilla_tls_settings.jpg

FTP over TLS Settings.

Use the above settings to enable FTP over TLS by creating a self-signed X.509 Certificate.

  • Make sure port 990 is open on your router’s firewall.

1.1.9.2 FileZilla Server Troubleshooting

If issues arise from FileZila Server settings, try the following troubleshooting tips:

  • Try FTP test page (website.). This website will test your FTP connection and previde solution recommendations.
  • Try a different port. By default, FTP uses TCPIP port 21. Try using port 2100 (for example).
  • Try logging into FileZilla Server from inside your network by using the LOCALHOST host address.