Skip to content

Commit ef95f7f

Browse files
authored
Merge pull request Sofie-Automation#1538 from Sofie-Automation/chore/docs/quick-install
2 parents 73f3691 + a707964 commit ef95f7f

File tree

3 files changed

+30
-12
lines changed

3 files changed

+30
-12
lines changed

packages/documentation/docs/user-guide/installation/installing-a-gateway/rundown-or-newsroom-system-connection/intro.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1+
---
2+
sidebar_position: 1
3+
---
14
# Rundown & Newsroom Systems
25

36
Sofie Core doesn't talk directly to the newsroom systems, but instead via one of the Gateways.
47

5-
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.
8+
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.
69

710
### Further Reading
811

packages/documentation/docs/user-guide/installation/installing-sofie-server-core.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ sidebar_position: 2
88

99
### **Prerequisites**
1010

11-
**\(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).
12-
**\(Windows\)** Install [Docker for Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows).
11+
* **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).
12+
* **Windows**: Install [Docker for Windows](https://hub.docker.com/editions/community/docker-ce-desktop-windows).
1313

1414
### Installation
1515

@@ -82,8 +82,6 @@ services:
8282
- core
8383

8484
# Choose one of the following images, depending on which type of ingest gateway is wanted.
85-
# If using the Rundown Editor, then none of the below images are needed.
86-
# The Rundown Editor can be found here: https://github.com/SuperFlyTV/sofie-automation-rundown-editor
8785

8886
# spreadsheet-gateway:
8987
# image: superflytv/sofie-spreadsheet-gateway:latest
@@ -122,6 +120,18 @@ services:
122120
# depends_on:
123121
# - core
124122

123+
# rundown-editor:
124+
# image: ghcr.io/superflytv/sofie-automation-rundown-editor:v2.2.4
125+
# restart: always
126+
# ports:
127+
# - '3010:3010'
128+
# environment:
129+
# PORT: '3010'
130+
# networks:
131+
# - sofie
132+
# depends_on:
133+
# - core
134+
125135
networks:
126136
sofie:
127137
lan_access:
@@ -134,13 +144,11 @@ volumes:
134144
135145
Create a `Sofie` folder, copy the above content, and save it as `docker-compose.yaml` within the `Sofie` folder.
136146

137-
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.
138-
139-
Then open a terminal, `cd your-sofie-folder` and `sudo docker-compose up` \(just `docker-compose up` on Windows\).
147+
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.
140148

141-
Once the installation is done, Sofie should be running on [http://localhost:3000](http://localhost:3000)
149+
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`.
142150

143-
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.
151+
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_.
144152

145153
:::note
146154
Starting with Sofie version 1.52.0, `sofietv` container images will run as UID 1000.

packages/documentation/docs/user-guide/installation/rundown-editor.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,13 @@ sidebar_position: 8
66

77
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
88

9-
### Installing Sofie Rundown Editor
9+
### Connecting Sofie Rundown Editor
1010

11-
Check the installation instructions on the [project repository](https://github.com/SuperFlyTV/sofie-automation-rundown-editor).
11+
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:
12+
13+
| Property | Value |
14+
| -------- | ------ |
15+
| Address | `core` |
16+
| Port | `3000` |
17+
18+
The header should change to _Core Status: Connected to core:3000_.

0 commit comments

Comments
 (0)