Skip to main content
Version: 1.50.0

Installing Package Manager

Prerequisites​

Package Manager is used by Sofie to copy, analyze, and process media files. It is what powers Sofie's ability to copy media files to playout devices, to know when a media file is ready for playout, and to display details about media files in the rundown view such as scene changes, black frames, freeze frames, and more.

Although Package Manager can be used to copy any kind of file to/from a wide array of devices, we'll be focusing on a basic CasparCG Server Server setup for this guide.

caution

At this time, the Package Manager worker process is Windows-only. Therefore, these instructions as a whole will only work on Windows. The worker will not work on WSL2.

Installation For Development (Quick Start)​

Package Manager is a suite of standalone applications, separate from Sofie Core. This guide assumes that Package Manager will be running on the same computer as CasparCG Server and Sofie Core, as that is the fastest way to set up a demo. To get all parts of Package Manager up and running quickly, execute these commands:

git clone https://github.com/nrkno/sofie-package-manager.git
cd sofie-package-manager
yarn install
yarn build
yarn start:single-app -- -- --basePath "C:\your\path\to\casparcg-server\media-folder (i.e. sofie-demo-media)"

Note: if Powershell throws Unknown argument: basePath error, add one more pair of dashes (--) before the basePath argument:

yarn start:single-app -- -- -- --basePath "C:\your\path\to\casparcg-server\media-folder (i.e. sofie-demo-media)"

On first startup, Package Manager will exit with the following message:

Not setup yet, exiting process!
To setup, go into Core and add this device to a Studio

This first run is necessary to get the Package Manager device registered with Sofie Core. We'll restart Package Manager later on in the Configuration instructions.

Installation In Production​

We provide pre-built executables for Windows (x64) systems that can be used in production environments. These can be found on the Releases GitHub repository page for Package Manager. For a minimal installation, you'll need the package-manager-single-app.exe and worker.exe. Put them in a folder of your choice. You can also place ffmpeg.exe and ffprobe.exe alongside them, if you don't want to make them available in PATH.

package-manager-single-app.exe --coreHost=<Core Host Name> --corePort=<Core HTTP(S) port> --deviceId=<Peripheral Device Id> --deviceToken=<Peripheral Device Token/Password>

Package Manager can be launched from CasparCG Launcher alongside Caspar-CG. This will make management and log collection easier on a production Video Server.

You can see a list of available options by running package-manager-single-app.exe --help.

Configuration​

  1. Open the Sofie Core Settings page (http://localhost:3000/settings?admin=1), click on your Studio, and scroll down to the Attached Devices section.
  2. Click the plus button (+) and select Package Manager to add the Package Manager device to your Studio.
  3. On this same settings page, scroll down to the Package Manager section.
  4. Click the plus button under the Package Containers heading, then click the edit icon (pencil) to the right of the newly-created package container.
  5. Give this package container an ID of casparcgContainer0 and a label of CasparCG Package Container.
  6. Click on the dropdown under "Playout devices which use this package container" and select casparcg0.
    • If you don't have a casparcg0 device, add it to the Playout Gateway under the Devices heading, then restart the Playout Gateway.
  7. Click the plus button under "Accessors", then click the edit icon to the right of the newly-created accessor.
  8. Give this accessor an ID of casparcgHttpProxy0, a Label of CasparCG HTTP Proxy Accessor, an Accessor Type of HTTP_PROXY, and a Base URL of http://localhost:8080/package. Then, ensure that both the "Allow Read access" and "Allow Write access" boxes are checked. Finally, click the done button (checkmark icon) in the bottom right.
  9. Scroll back up a bit to the "Studio Settings" subsection (still in the Package Manager section) and select "CasparCG Package Container" for both "Package Containers to use for previews" and "Package Containers to use for thumbnails".
  10. Your settings should look like this once all the above steps have been completed: Package Manager demo settings
  11. If Package Manager start:single-app is running, restart it. If not, start it (see the above Installation instructions for the relevant command line).

Usage​

In this basic configuration, Package Manager won't be copying any packages into your CasparCG Server media folder. Instead, it will simply check that the files in the rundown are present in your CasparCG Server media folder, and you'll have to manually place those files in the correct directory. However, thumbnail and preview generation will still function, as will status reporting.

If you're using the demo rundown provided by the Rundown Editor, you should already see work statuses on the Package Status page (Status > Packages).

Example Package Manager status display

If all is good, head to the Rundowns page and open the demo rundown.

Further Reading​