Service: Just Go Live - EyevinnOSC/community GitHub Wiki
Just Go Live (serviceId eyevinn-just-go-live) is a one-click live streaming setup tool. It uses your OSC account to configure an RTMP ingest endpoint and an HLS output stream automatically. In Eyevinn Open Source Cloud (OSC) it is a long-running service instance. License: MIT. Source: Eyevinn/just-go-live.
- Generate the RTMP URL and stream key for broadcasting from OBS, Streamlabs or any RTMP-compatible encoder.
- Make the live stream available as an HLS playback URL for viewers.
- Provision the underlying live encoder (an
eyevinn-live-encodinginstance) in your tenant when you call its API.
You need your OSC personal access token (create it on the API Access page, see Finding Your API Token). Store it as a service secret with create-service-secret (serviceId: "eyevinn-just-go-live", name osctoken, value your token). Then call create-service-instance with serviceId: "eyevinn-just-go-live". The instance name must be alphanumeric and at most 20 characters.
{ "name": "mystream", "OscAccessToken": "{{secrets.osctoken}}" }Wait with wait-for-service-ready (or get-instance-status) and read the URL with describe-service-instance. Allow 1-2 minutes after the instance is ready before the first API call; the instance hostname needs time to obtain a valid TLS certificate.
| Option | Required | Type | Meaning |
|---|---|---|---|
| name | Yes | string | Name of the instance. Alphanumeric/underscore only, at most 20 characters. |
| OscAccessToken | Yes | string, sensitive | Your OSC personal access token, which the service uses to provision streaming resources in your account. Store it as a service secret and pass {{secrets.NAME}}. This is separate from the token used to call the instance API (see Auth note). |
A {{secrets.NAME}} reference must be the entire field value. Overwriting a secret does not restart a running instance.
POST /api/go-live and GET /api/stream/{streamId} require a Service Access Token, not a personal access token. A personal access token returns a bare 401 from the gateway with no error body. Create a service token with create-service-token (or via the API).
Call POST /api/go-live on your instance URL:
curl -X POST https://<tenant>-<instance>.eyevinn-just-go-live.auto.prod-se.osaas.io/api/go-live \
-H "x-jwt: Bearer <serviceAccessToken>"The response contains:
{
"rtmpUrl": "rtmp://217.61.247.34:10519/live/<streamKey>",
"viewerUrl": "...",
"streamId": "<streamId>"
}Get the HLS playback URL with GET /api/stream/{streamId}:
curl https://<tenant>-<instance>.eyevinn-just-go-live.auto.prod-se.osaas.io/api/stream/<streamId> \
-H "x-jwt: Bearer <serviceAccessToken>"The response includes hlsUrl.
| Format | |
|---|---|
| RTMP ingest | rtmp://217.61.247.34:10519/live/<streamKey> |
| HLS playback | https://<tenant>-<encoderInstance>.eyevinn-live-encoding.auto.prod-se.osaas.io/origin/hls/index.m3u8 |
The RTMP ingest endpoint uses a bare IP address and a non-standard port; the stream key is the only thing distinguishing one publisher from another, so keep it private. The HLS playback URL is on the eyevinn-live-encoding encoder instance, not the just-go-live instance. The encoder instance name is generated when you call POST /api/go-live.
- Open Settings > Stream and set Service to Custom.
- Set Server to the
rtmpUrlup to and including/live(for examplertmp://217.61.247.34:10519/live). - Set Stream Key to the
<streamKey>part after/live/. - Click OK, then Start Streaming.
The hlsUrl can be shared with viewers or embedded in a browser player such as hls.js.
npx -y @osaas/cli create eyevinn-just-go-live mystream \
-o OscAccessToken="{{secrets.osctoken}}"- Just Go Live on OSC
- Eyevinn Live Encoding: open source live encoder for more control over the transcoding pipeline
- SRT WHEP Bridge: low-latency SRT-to-WebRTC alternative for contributors