Service: Open Live - EyevinnOSC/community GitHub Wiki
Open Live
Open Live (serviceId eyevinn-open-live) is the central API server of a cloud-based, browser-native live production tool for broadcast workflows. Production teams manage and control live productions from the browser with no installed software. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance. License: MIT. Source: Eyevinn/open-live. For a full walkthrough (dependencies, local development, Stream Deck control) see the Open Live Setup Guide.
What it can do
- Store productions, sources and templates in CouchDB.
- Activate productions swiftly and manage sources through its API.
- Drive the Strom pipeline engine, which handles video mixing and audio routing for activated productions.
- Be controlled from a studio frontend in the browser, and from Stream Deck / Bitfocus Companion via the Open Live Companion Module.
Creating an instance
Two dependencies must be running first:
- CouchDB (serviceId
apache-couchdb, see Apache CouchDB). Create an instance and a database namedopen-liveinside it. Note the instance URL and admin password. - Strom, which handles the media pipeline. Either use the shared Eyevinn instance (contact Eyevinn for access) or self-host one. Creating a Strom instance from the OSC catalogue is not a supported backend for Open Live. Note the Strom URL and access token.
Store the credentials-bearing values as service secrets (create-service-secret, serviceId: "eyevinn-open-live"), then call create-service-instance:
{
"name": "myprod",
"DatabaseUrl": "{{secrets.livedburl}}",
"StromUrl": "<URL of your Strom instance>",
"StromAccessToken": "{{secrets.stromtoken}}"
}
Verify with wait-for-service-ready or get-instance-status, and read the URL with describe-service-instance. If it fails to start, check get-logs-for-instance and the DatabaseUrl format below.
Options
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric/underscore only (^\w+$), at most 20 characters. |
| DatabaseUrl | Yes | string, sensitive | Complete CouchDB connection URL with credentials and database name; used to store productions, sources and templates. Equivalent to the COUCHDB_URL variable. The catalog associates it with a CouchDB instance (apache-couchdb, HTTPS, credentials and path included). Format below. |
| StromUrl | Yes | string | Base URL of the Strom pipeline engine used for video flow processing. For local development the application default is http://localhost:7000. |
| StromAuthMode | No | string | Authentication mode when connecting to Strom. Catalog default osc: the server uses an OSC personal access token and exchanges it for short-lived Service Access Tokens, refreshing them before expiry. Other accepted values are not documented in the catalog. |
| StromAccessToken | No | string, sensitive | OSC personal access token for authenticating against an OSC-hosted Strom instance (one behind OSC authentication). Needed only when StromUrl points to such an instance; leave unset for a local Strom without authentication. |
| OscAccessToken | No | string, sensitive | OSC personal access token, used with the default osc auth mode for a Strom instance behind OSC authentication. The upstream README describes this token under STROM_AUTH_TOKEN; exact mapping to this option is not documented. |
| CorsOrigin | No | string | Allowed CORS origin, the URL where the studio frontend is hosted, so browsers can call the API. Application default http://localhost:5173. |
Sensitive options (DatabaseUrl, StromAccessToken, OscAccessToken) should be stored as service secrets and passed as {{secrets.NAME}}; the reference must be the entire field value. Overwriting a secret does not restart a running instance.
DatabaseUrl format
https://{user}:{password}@{hostname}/{database-name}
{user}: CouchDB admin username (typicallyadmin).{password}: the admin password.{hostname}: the CouchDB hostname without thehttps://prefix.{database-name}: a database that already exists in CouchDB, for exampleopen-live.
Example for a CouchDB at https://myname.apache-couchdb.auto.prod-se.osaas.io:
https://admin:[email protected]/open-live
Troubleshooting
The most common cause of startup failure is an incorrectly formatted DatabaseUrl:
- No double
https://:https://admin:pw@https://host/open-liveis wrong; use the hostname only after the@. - Include the database name in the path:
https://admin:pw@hostis wrong;https://admin:pw@host/open-liveis correct. - The database named in the URL must exist in CouchDB. Create it in the CouchDB admin panel (Fauxton) at your CouchDB URL if missing.
- Passwords containing
@,:,/or#break URL parsing. Use only letters and numbers.