Welcome to the Alba ecosystem. This is the central server for rundown execution and management.
- NodeJS >= 16.20
- Yarn
- A running MongoDB instance with an initialized replica set.
- Optional: Docker and Docker Compose
The server can be built to JavaScript by:
- Install dependencies with
yarn install. - Build to the folder
/distwithyarn build. - 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 is done through environment variables:
| Variable | Description | Example |
|---|---|---|
MONGO_URL |
The connection URL to the MongoDB instance. | MONGO_URL=mongodb://localhost:3001 |
INEWS_HOST |
The host and port for the REST API of the Sofie iNews Gateway. | INEWS_HOST=localhost:3007 |
PLAYOUT_GATEWAY_HOST |
The host and port for the REST API of the Sofie Playout Gateway. | PLAYOUT_GATEWAY_HOST=localhost:3009 |
INEWS_GATEWAY_HOST |
The websocket URL used to connect to the Alba iNews Gateway. | INEWS_GATEWAY_HOST=ws://localhost:3008 |
You can start a development server with yarn watch.
As Alba is being rewritten, based on Sofie, in chunks, it co-exists with Sofie and relies on Sofie for functionalities like rundown ingest and playout control. With time this will gradually be moved over to Alba.
The repository has a Docker compose setup for Sofie, which you need Docker and Docker compose in order to use. For now, it is possible to start a Sofie instance by:
- Starting a mongo database:
- Run
yarn start-database. - Wait til the Docker container is started.
- Run
yarn init-replica-set
- Run
- Start Sofie ecosystem by running
yarn start-sofie. For more information see the README for Sofie Docker Compose setup.
At TV 2 the Alba server is used in conjunction with the Alba TV 2 server and the Angular web client. All 3 applications are needed to run Alba at TV 2.