Service: Strom - EyevinnOSC/community GitHub Wiki
Strom (serviceId eyevinn-strom) is an open source GStreamer-based GUI and flow engine with a visual, web-based editor for building and managing streaming media pipelines. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance with up to 10 GiB of storage per instance. License: Apache-2.0.
- Wire together sources, filters, encoders, muxers and outputs in a visual editor without writing GStreamer command lines.
- Use WebRTC WHIP Output and WHEP Input/Output blocks for real-time streaming.
- Prototype live encoding and distribution workflows.
- Manage flows through a REST API.
- Store flows in a local JSON file (default) or in PostgreSQL for persistent storage shared across instances.
Strom has no required dependencies. PostgreSQL is optional: by default Strom stores flows in a local JSON file; for production use or to share flows across instances, connect a PostgreSQL database.
- Optional: create a PostgreSQL instance (
birme-osc-postgresql, see PostgreSQL) withcreate-service-instance, giving a name andPostgresPassword, and wait until it runs. Read the IP and port withdescribe-service-instance. The URI ispostgresql://postgres:<password>@<IP>:<PORT>/strom. Because it embeds the password, store it as a service secret withcreate-service-secret(serviceId: "eyevinn-strom", for example namedburl). - Create the Strom instance with
create-service-instanceusingserviceId: "eyevinn-strom". The instance name must be alphanumeric (underscores allowed) and at most 20 characters.
Minimal (JSON file storage):
{ "name": "mystrom" }With PostgreSQL:
{ "name": "mystrom", "DatabaseUrl": "{{secrets.dburl}}" }- Verify with
wait-for-service-readyorget-instance-status, then read the URL withdescribe-service-instance.
OSC CLI example:
# Without a database (JSON file storage)
osc create eyevinn-strom mystrom
# With PostgreSQL backend
osc create eyevinn-strom mystrom \
-o DatabaseUrl="postgresql://postgres:mypassword@<IP>:<PORT>/strom"| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Letters, digits and underscore only; on OSC at most 20 characters. |
| DatabaseUrl | No | string | PostgreSQL connection URL for storing flows and blocks, for example postgresql://user:pass@host:5432/strom. When set, Strom uses PostgreSQL instead of JSON file storage, runs schema migrations on startup, and several isolated instances can share one PostgreSQL server. Contains a password, so store as a secret and pass as {{secrets.NAME}}. |
| IceServers | No | string | ICE server (STUN/TURN) configuration for WebRTC connections used by WHIP/WHEP blocks. Needed for WebRTC connectivity especially when clients are behind NAT or firewalls. |
A {{secrets.NAME}} reference must be the whole field value. Overwriting a secret does not restart a running instance.
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Instance name, at most 20 characters. |
| PostgresPassword | Yes | string, sensitive | Password for the PostgreSQL superuser. Example: {{secrets.postgrespwd}}. |
| PostgresUser | No | string | Superuser name; postgres if not provided. |
| PostgresDb | No | string | Name of the default database created at first start; the user name if not specified. Create or name a database strom to match the URI above. |
| PostgresInitDbArgs | No | string | Extra arguments passed to initdb when the cluster is initialized. |
| PostgresInitDbSql | No | string | SQL executed during database initialization. |
Open the instance URL. The visual editor shows a canvas where you:
- Click Add block to add a source, filter, encoder, muxer or output block.
- Connect blocks by dragging from an output pad to an input pad.
- Click Start to launch the pipeline and monitor it in real time.
For a simple test pipeline, add a videotestsrc source and connect it to an autovideosink output, then click Start.
Strom exposes a REST API for managing pipelines:
# List all flows
curl https://<your-instance-url>/api/flows
# Start a flow by ID
curl -X POST https://<your-instance-url>/api/flows/<flow-id>/start- Storage is limited to 10 GiB per instance.
- With the default JSON file storage, flows are not shared across instances; use PostgreSQL for that.
- Strom on GitHub
- GStreamer Documentation
- Strom Local Setup Guide, self-hosted deployment with Docker, GPU, and authentication