diff --git a/packages/documentation/docs/user-guide/installation/installing-a-gateway/rundown-or-newsroom-system-connection/intro.md b/packages/documentation/docs/user-guide/installation/installing-a-gateway/rundown-or-newsroom-system-connection/intro.md index cf2c62a508..7c9c6fd5c4 100644 --- a/packages/documentation/docs/user-guide/installation/installing-a-gateway/rundown-or-newsroom-system-connection/intro.md +++ b/packages/documentation/docs/user-guide/installation/installing-a-gateway/rundown-or-newsroom-system-connection/intro.md @@ -1,8 +1,11 @@ +--- +sidebar_position: 1 +--- # Rundown & Newsroom Systems Sofie Core doesn't talk directly to the newsroom systems, but instead via one of the Gateways. -The Google Spreadsheet Gateway, iNEWS Gateway, and the MOS \( [Media Object Server Communications Protocol](http://mosprotocol.com/) \) Gateway which can handle interacting with any system that communicates via MOS. +The Google Spreadsheet Gateway, iNEWS Gateway, and the MOS \([Media Object Server Communications Protocol](http://mosprotocol.com/)\) Gateway which can handle interacting with any system that communicates via MOS. ### Further Reading diff --git a/packages/documentation/docs/user-guide/installation/installing-sofie-server-core.md b/packages/documentation/docs/user-guide/installation/installing-sofie-server-core.md index eb02213327..8d930108a4 100644 --- a/packages/documentation/docs/user-guide/installation/installing-sofie-server-core.md +++ b/packages/documentation/docs/user-guide/installation/installing-sofie-server-core.md @@ -8,8 +8,8 @@ sidebar_position: 2 ### **Prerequisites** -**\(Linux\)** Install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/) and [docker-compose](https://www.digitalocean.com/community/tutorials/how-to-install-docker-compose-on-ubuntu-18-04). -**\(Windows\)** Install [Docker for Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows). +* **Linux**: Install [Docker](https://docs.docker.com/install/linux/docker-ce/ubuntu/) and [docker-compose](https://www.digitalocean.com/community/tutorials/how-to-install-docker-compose-on-ubuntu-18-04). +* **Windows**: Install [Docker for Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows). ### Installation @@ -82,8 +82,6 @@ services: - core # Choose one of the following images, depending on which type of ingest gateway is wanted. - # If using the Rundown Editor, then none of the below images are needed. - # The Rundown Editor can be found here: https://github.com/SuperFlyTV/sofie-automation-rundown-editor # spreadsheet-gateway: # image: superflytv/sofie-spreadsheet-gateway:latest @@ -122,6 +120,18 @@ services: # depends_on: # - core + # rundown-editor: + # image: ghcr.io/superflytv/sofie-automation-rundown-editor:v2.2.4 + # restart: always + # ports: + # - '3010:3010' + # environment: + # PORT: '3010' + # networks: + # - sofie + # depends_on: + # - core + networks: sofie: lan_access: @@ -134,13 +144,11 @@ volumes: Create a `Sofie` folder, copy the above content, and save it as `docker-compose.yaml` within the `Sofie` folder. -Navigate to the _ingest-gateway_ section of `docker-compose.yaml` and select which type of _ingest-gateway_ you'd like installed by uncommenting it. Save your changes. If you are using the [Rundown Editor](rundown-editor.md), then no ingest gateways need to be uncommented. - -Then open a terminal, `cd your-sofie-folder` and `sudo docker-compose up` \(just `docker-compose up` on Windows\). +Visit [Rundowns & Newsroom Systems](installing-a-gateway/rundown-or-newsroom-system-connection/intro.md) to see which _Ingest Gateway_ can be used in your specific production environment. If you don't have an NRCS that you would like to integrate with, you can use the [Rundown Editor](rundown-editor) as a simple Rundown creation utility. Navigate to the _ingest-gateway_ section of `docker-compose.yaml` and select which type of _ingest-gateway_ you'd like installed by uncommenting it. Save your changes. -Once the installation is done, Sofie should be running on [http://localhost:3000](http://localhost:3000) +Open a terminal, execute `cd Sofie` and `sudo docker-compose up` \(or just `docker-compose up` on Windows\). This will download MongoDB and Sofie components' container images and start them up. The installation will be done when your terminal window will be filled with messages coming from `playout-gateway_1` and `core_1`. -Next, you will need to install a Rundown Gateway. Visit [Rundowns & Newsroom Systems](installing-a-gateway/rundown-or-newsroom-system-connection/intro.md) to see which _Rundown Gateway_ is best suited for _your_ production environment. +Once the installation is done, Sofie should be running on [http://localhost:3000](http://localhost:3000). Next, you need to make sure that the Playout Gateway and Ingest Gateway are connected to the default Studio that has been automatically created. Open the Sofie User Interface with [Configuration Access level](../features/access-levels#browser-based) by opening [http://localhost:3000/?admin=1](http://localhost:3000/?admin=1) in your Web Browser and navigate to _Settings_ 🡒 _Studios_ 🡒 _Default Studio_ 🡒 _Peripheral Devices_. In the _Parent Devices_ section, create a new Device using the **+** button, rename the device to _Playout Gateway_ and select _Playout gateway_ from the _Peripheral Device_ drop down menu. Repeat this process for your _Ingest Gateway_ or _Sofie Rundown Editor_. :::note Starting with Sofie version 1.52.0, `sofietv` container images will run as UID 1000. diff --git a/packages/documentation/docs/user-guide/installation/rundown-editor.md b/packages/documentation/docs/user-guide/installation/rundown-editor.md index b46e173d08..4293431ac4 100644 --- a/packages/documentation/docs/user-guide/installation/rundown-editor.md +++ b/packages/documentation/docs/user-guide/installation/rundown-editor.md @@ -6,6 +6,13 @@ sidebar_position: 8 Sofie Rundown Editor is a tool for creating and editing rundowns in a _demo_ environment of Sofie, without the use of an iNews, Spreadsheet or MOS Gateway -### Installing Sofie Rundown Editor +### Connecting Sofie Rundown Editor -Check the installation instructions on the [project repository](https://github.com/SuperFlyTV/sofie-automation-rundown-editor). +After starting the Rundown Editor via the `docker-compose.yaml` specified in [Quick Start](./installing-sofie-server-core), this app requires a special bit of configuration to connect to Sofie. You need to open the Rundown Editor web interface at [http://localhost:3010/](http://localhost:3010/), go to _Settings_ and set _Core Connection Settings_ to: + +| Property | Value | +| -------- | ------ | +| Address | `core` | +| Port | `3000` | + +The header should change to _Core Status: Connected to core:3000_.