Service: Sofie Rundown Editor - EyevinnOSC/community GitHub Wiki

Sofie Rundown Editor

Sofie Automation Rundown Editor (serviceId superflytv-sofie-automation-rundown-editor, catalog page) is a web tool for creating and editing Sofie rundowns in a demo environment. It connects to a Sofie Core (release 53) instance that has the demo blueprints uploaded. It is a long-running service instance with up to 1 GiB of storage per instance. License: MIT.

What it can do

  • Configure the connection to a Sofie Core instance.
  • Import demo Piece Types and a demo rundown.
  • Sync the rundown into Sofie so you can open and work with it in the Sofie Core UI.

Creating an instance

Create a Sofie Core instance first, with the demo blueprints uploaded, and confirm it is running. Run describe-service-instance on it and note its cluster-internal host and internal port. The public URL of Sofie Core is behind the OSC authentication gate, so the editor cannot use it.

Then call create-service-instance with serviceId: "superflytv-sofie-automation-rundown-editor":

{ "name": "myeditor", "CoreHost": "<internal-core-host>", "CorePort": "<internal-core-port>" }

Verify with wait-for-service-ready or get-instance-status, then describe-service-instance for the URL. The instance name is lowercase letters and digits, at most 20 characters.

Options

Option Required Type Meaning
name Yes string Name of the instance. Lowercase letters and digits, at most 20 characters.
CoreHost No string Hostname of the Sofie Core the editor connects to (CORE_HOST). Applied as the initial Core address when the instance first starts, and only while the saved address is still the default 127.0.0.1; an address saved on the editor's Settings page is kept. On OSC use Core's cluster-internal host.
CorePort No string Port of the Sofie Core (CORE_PORT). Applied as the initial Core port when the instance first starts, and only while the saved port is still the default 3000; a port saved on the Settings page is kept. Use the internal port listed in the Core instance details.

Because both are only initial values, changing them later with update-service-instance does not override an address already saved in the editor; change it on the Settings page instead.

Using the instance

Open the instance URL. If you did not set CoreHost and CorePort, open the Settings page and enter the Core connection there. Then import the demo Piece Types and the demo rundown and sync the rundown into Sofie.

Example with the OSC CLI:

osc create superflytv-sofie-automation-rundown-editor myeditor \
  -o CoreHost="<internal-core-host>" \
  -o CorePort="<internal-core-port>"

Limitations

  • Storage is limited to 1 GiB per instance.
  • Intended for a demo environment with Sofie Core release 53 and the demo blueprints.

Resources