Alba TV 2 server

Alba TV 2 server is the backend server for Alba that contains all things TV 2 specific. This includes blueprints and specializations of the more generic types from Alba server.

graph TD

client[["Alba clients"]]



subgraph albaTv2Server["Alba TV2 server"]

albaTv2RestApi["Alba TV2 REST API"]
albaTv2WebSocketApi["Alba TV2 WebSocket API"]
albaTv2Services[["Alba TV2 services"]]

albaTv2RestApi -->|"calls"| albaTv2Services
albaTv2WebSocketApi -->|"calls"| albaTv2Services

end



subgraph albaServer["Alba server"]

albaRestApi["Alba REST API"]
albaWebSocketApi["Alba WebSocket API"]

end



client -->|"send requests to"| albaTv2RestApi
client -->|"subscribes to events from"| albaTv2WebSocketApi

albaTv2RestApi -->|"proxies requests to"| albaRestApi
albaTv2WebSocketApi ---> |"proxies events to and from"| albaWebSocketApi

Loading

Requirements

• NodeJS >= 20.12.0
• Yarn >= 4.1.1
• A running MongoDB instance with an initialized replica set.

Usage

Building

The server can be built to JavaScript by:

1. Install dependencies with yarn install.
2. Build to the folder /dist with yarn build.
3. To start the built application, run yarn start.

Note

The project is intended to be run as a Docker container and is currently published to the tv2media space.

Configuration

Configuration is done through environment variables:

Variable	Description	Example
TV2_SERVER_API_PREFIX	The prefix under which the REST and WEBSOCKET APIs are exposed.	TV2_SERVER_API_PREFIX=tv2-server
ALBA_REST_URL	The URL to proxy requests to for the Alba server REST API.	ALBA_REST_URL=http://localhost:3005
ALBA_WEBSOCKET_URL	The URL to proxy events to and from, for the Alba server WebSocket API.	ALBA_WEBSOCKET_URL=http://localhost:3006
ALBA_TV2_SERVER_PORT	The port used for the REST and WebSocket APIs.	ALBA_TV2_SERVER_PORT=3010
MONGO_URL	The connection URL to the MongoDB instance.	MONGO_URL=mongodb://localhost:3001

Running with development server

You can start a development server with yarn watch.