Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 22 Next »

Summary: step-by-step instructions for installing CAST Extend Proxy.

Download the installation media

Download the latest release of CAST Extend Offline from https://extend.castsoftware.com/#/extension?id=com.castsoftware.aip.extendproxy&version=latest.

Run the installation

Interactive setup

Double click the executable file as provided with the installation media. You may be prompted to allow the installation - click Yes:

The installation wizard will be displayed. Read and accept the license agreement and click Next:

Choose a location on the local machine that will be used for the installation. The setup will suggest: %PROGRAMFILES%\CAST\ExtendProxy, but you are free to choose a different location. Click Next to continue:

Fill in the required information. Note that Server name and Server port will form the CAST Extend Proxy URL that needs to be configured in AIP Console or in Extension Downloader:

Server nameThe setup will use the server's name as defined in Windows.
Server portThe setup will use port 8085 by default. If you have another service running on this port, you are free to choose a different port number. Note that CAST Extend Offline also uses this port number by default, therefore if you already have CAST Extend Offline installed, please ensure you are not using the same port.
Your Extend emailEnter your CAST Extend credentials - these will be used to connect to CAST Extend and fetch the required extensions.
Your Extend password
Data folder location

Choose a location to store the CAST Extend Proxy data - i.e. the extensions that have been downloaded automatically or manually uploaded. The setup will suggest: %PROGRAMDATA%\CAST\ExtendProxy.

A brief summary of the chosen options will be displayed. The installation will start when you click Install:

The installation will proceed:

A summary screen will be displayed. Please take note of the API key - this will be required when configuring AIP Console to use CAST Extend Proxy. Click Next to terminate the installation process:

Silent installation

If you would prefer to run a silent installation, please use the following command line:

com.castsoftware.aip.extendproxy.<version>.exe /SP- /VERYSILENT /SUPPRESSMSGBOXES /LOG="filename.log" /LOADINF="filename.inf"
/SILENTInstructs Setup to be totally silent. When Setup is totally silent the wizard, the background window and the installation progress window are not displayed. Everything else is normal, so for example error messages during installation are displayed. If you do want the progress window to be displayed, use /SILENT instead.
/LOG="filename.log"Allows you to specify a fixed path/filename to use for the log file, for example install.log. If a file with the specified name already exists it will be overwritten. If the file cannot be created, Setup will abort with an error message.
/LOADINF="filename.inf"

Instructs Setup to load the settings from the specified file after having checked the command line, for example install.infThe file should be defined before running the installation, with the following syntax:

[Setup]
Lang=english
Dir=C:\Program Files\CAST\ExtendProxy
Group=CAST Extend
NoIcons=0
Tasks=
ServerName=my_server_hostname
ServerPort=my_port_number
ExtendMail=my_extend_email
ExtendPassword=my_extend_password
DataDir=C:\ProgramData\CAST\ExtendProxy

Modify DirServerName, ServerPort, ExtendMail and ExtendPassword to the required values, for example:

  • Dir= the path to the installation location. CAST recommends installing to C:\Program Files\CAST\ExtendProxy, but you are free to change this to another location if necessary.
  • ServerName= the name of the server on which you are installing the service
  • ServerPort= the port number on which the service will run. CAST recommends using 8085, but you are free to change this to if necessary.
  • ExtendMail= enter your CAST Extend login email address
  • ExtendPassword= enter your CAST Extend password corresponding to the login you entered for ExtendMail=

Note that the Microsoft Windows UAC prompt will be displayed regardless. It is not possible to supress this.

What is installed?

Files

On completion of the installation, all files related to CAST Extend Proxy are stored in:

%PROGRAMFILES%\CAST\ExtendProxy
%PROGRAMDATA%\CAST\ExtendProxy

Windows Services

The following Windows Services will be created:

Windows Service nameDescriptionListening PortAuto start?Notes
CAST_ExtendProxyCAST Extend Proxy service8085 (default)(tick)You may need to adjust firewall rules on the server to allow incoming connections on the listening port.

Running executables

CAST Extend Proxy runs under the following executables:

%PROGRAMFILES%\CAST\ExtendProxy\tools\nssm.exe
%PROGRAMFILES%\CAST\ExtendProxy\NodeJS\node.exe

Installed third-party software

The following table lists all third-party software that is shipped and installed with CAST Extend Proxy:

SoftwareVersion
Node.js10.15.3

Testing the installation

To test CAST Extend Proxy, browse to the following location from a different machine on your local network. Change server_name and port to match your installation:

http://<server_name>:<port>/api

If CAST Extend Proxy is functioning, the following should be returned:

Unauthorized

Configuring AIP Console to use CAST Extend Proxy

To use CAST Extend Proxy in AIP Console there are two methods, available in AIP Console  1.21.0-funcrel:

Configuration during initial start-up wizard (new installations)

During the initial start-up wizard, a new option will be available in Step 4: Connect to CAST Extend:

The required information is as follows:

CAST Extend URL

Enter the URL of your on-premises deployment of CAST Extend Proxy. This will take the form:

http://server:port

By default CAST Extend Proxy runs on port 8085.

API key

Enter your CAST Extend Proxy API key. This will have been generated during the installation of CAST Extend Proxy and is displayed in the final summary screen of the installer:

 

Alternatively you can find the API key in the following location on the server on which CAST Extend Proxy is installed:

%PROGRAMFILES%\CAST\ExtendProxy\config.proxy.json

The key is located on the line APIKEY:

{
  "PORT": 8085,
  "STORAGE_DIR": "c:/ProgramData/CAST/ExtendProxy",
  "PACKAGE_DIR": null,
  "LOG_DIR": "C:/Program Files/CAST/ExtendProxy/logs",
  "PUBLIC_URL": "http://WIN10TEST:8085/",
  "EXTEND_URL": "https://extend.castsoftware.com",
  "APIKEY": "XCGN1-9263B92E143984F6EF357684F7EFD3EE336C6E7A5F2278ADE1352D7BD34147FFC60F94920F90B9095EBDBD11",
  "USER": "",
  "CREDENTIALS": "CRYPTED2:A65B5035B193DB7B2B59221",
  "SYNC_TYPE": "auto"
}

Configuration in System Settings (existing upgraded installations)

If you are currently using CAST Extend (live) or CAST Extend Offline, you can switch to CAST Extend Proxy using the CAST Extend - System Settings in the Administration Center. The same settings are required as explained above for the initial startup-wizard:

Updating the available extensions in CAST Extend Proxy

CAST Extend Proxy is provided empty but will be automatically populated when an extension is requested by AIP Console/Extension Downloader. It is also possible to update the content manually - see Update CAST Extend Proxy with new content.

Proxy configuration

If the AIP Node/Server accessing CAST Extend Proxy is configured to pass all outgoing connections through a proxy (via the Windows proxy settings or via the AIP Console settings), then you may need to whitelist the IP address/host name of the server running CAST Extend Offline in order to route connections correctly.

  • No labels