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

Summary: step-by-step instructions for manually updating CAST Extend local server with new content.

Introduction

CAST Extend local server is delivered "empty" without any preconfigured extensions and in normal functioning mode, extensions will be automatically downloaded from CAST Extend when requested by AIP Console or Extension Downloader. However, you can also populate CAST Extend local server with specific extensions manually should you need to.

The process of updating is as follows:

When CAST Extend local server is updated with a new bundle of extensions and extensions have already been added, a "merge" is actioned, rather than a "delete and add". This means that no extensions are ever removed, i.e.:

  • Any extensions that already exist in CAST Extend local server but do not exist in the new bundle will remain as they are in CAST Extend local server
  • Any extensions that already exist in CAST Extend local server at a given version number will remain as they are in CAST Extend local server when:
    • an older version of the same extension is added to the bundle (both versions will be available for use)
    • a newer version of the same extension is added to the bundle (both versions will be available for use)
    • an older and a newer version of the same extension are added to the bundle (all three versions will be available for use)
    • the same version of the extension is added to the bundle

When an .extarchive is uploaded, the packages are stored by default in:

%PROGRAMDATA%\CAST\Extend\packages

Update process

Creating the bundle

Using ExtendCLI

See ExtendCli for more information.

Using extend.castsoftware.com

Log in to https://extend.castsoftware.com and click the Create Bundle located in the top right corner next to the profile icon:

The following screen will be displayed:

This screen shows:

  • on the left: a list of predefined "bundles" that are available for use
  • on the right: a list of the extensions (and version number) included in the bundle - the latest and/or latest stable release will be included

Choose the bundle(s) you wish to include by toggling the slider to the enabled position:

Finally click the Generate Update button to build the bundle:

The following message will be displayed:

You will receive an email (sent to the email address associated with your CAST Extend login) when your bundle is ready to download. Click the Download button to return to extend.castsoftware.com where you can start the bundle download:

  • A bundle containing only default extensions is generally around 500MB
  • Bundle files will use the .extarchive file extension

Upload the bundle to CAST local server

Via AIP Console

If you are using CAST Extend local server with AIP Console, the process of updating CAST Extend local server is handled automatically by AIP Console. Login to AIP Console with a user account that already has the Admin role and switch to the Admin Center:

Now move to the Administration Center - System Settings panel and expand the CAST Extend option:

Click to enlarge

Drag and drop your downloaded bundle in to the options screen, or click the button to choose the .extarchive file directly. The bundle will then be uploaded and added to CAST Extend local server automatically and all new extensions added to the bundle will be available immediately.

Via the CAST Extend local server GUI

Starting v. ≥ 1.1.0, CAST Extend local server has its own GUI which you can use to upload the .extarchive file. See Manage CAST Extend local server via Administration Center for more information about this.

Via the CAST Extend local server built in API and curl

CAST Extend local server has a built in API that can be accessed in a manner of ways. It is therefore possible to upload a new bundle using the API, for example with curl:

curl -H "x-cxproxy-apikey:<APIKEY>" -F "data=@path_to_file.extarchive" http://<server>:<port>/api/update
-H This option defines an extra header to include in the request when sending HTTP to a server. In the case of CAST Extend local server, this is used to send the APIKEY value to allow access. See https://curl.se/docs/manpage.html#-H.
APIKEY

The APIKEY that grants access to Extend local server. The APIKEY value is displayed at the end of the CAST Extend local server installation process. Alternatively you can find the APIKEY value in the following location on the server on which CAST Extend local server is installed:

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

The key is located on the line APIKEY:

{
	"PORT": 8085,
	"STORAGE_DIR": "c:/ProgramData/CAST/Extend",
	"PACKAGE_DIR": null,
	"LOG_DIR": "C:/Program Files/CAST/Extend/logs",
	"PUBLIC_URL": "http://WIN10TEST:8085/",
	"EXTEND_URL": "https://extend.castsoftware.com",
	"APIKEY": "<api_key>",
	"ADMI": "admi194c45b7d34a12adb81df7838b66e127e280838b2585276604865460316d6813353000e1b800c50e3d2cd6b2740bf47a99568c70ca52424c77f7d5a2b8016b810",
	"SYNC_TYPE": "auto"
}
-FThis causes curl to POST data using the Content-Type multipart/form-data. See https://curl.haxx.se/docs/manpage.html#-F
path_to_file.extarchiveThe path to the .extarchive bundle file. Replace this with your 
<server>

Forms part of the URL to your on premises CAST Extend local server. For example:

  • <server>: the local server on which CAST Extend local server is installed.
  • <port>: the port number which CAST Extend local server runs on. This is determined during the installation (default port number is set to 8085).
<port>

For example:

curl -H "x-cxproxy-apikey:<api_key>" -F "data=@D:\downloads\b2b430df976c412ca29e799fff0fd86e.extarchive" http://WIN10TEST:8085/api/update
  • No labels