Skip to content

Commit 3151572

Browse files
authored
chore(docs): Use docker compose profiles to select ingest gateway to run (Sofie-Automation#1448)
1 parent 6f26580 commit 3151572

File tree

4 files changed

+62
-37
lines changed

4 files changed

+62
-37
lines changed

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ The iNEWS Gateway communicates with an iNEWS system to ingest and remain in sync
66

77
The iNEWS Gateway allows you to create rundowns from within iNEWS and sync them with the _Sofie Core_. The rundowns will update in real time and any changes made will be seen from within your Playout Timeline.
88

9-
An example setup for the iNEWS Gateway is included in the example Docker Compose file found in the [Quick install](../../installing-sofie-server-core.md), but commented out.
9+
An example setup for the iNEWS Gateway is included in the example Docker Compose file found in the [Quick install](../../installing-sofie-server-core.md) with the `inews-gateway` profile.
1010

11-
Remove the _\#_ symbol from the start of the lines beginning at `# inews-gateway:` and ending at the next blank line. Be careful not to change the indentation of the file.
11+
You can activate the profile by setting `COMPOSE_PROFILES=inews-gateway` as an environment variable or by writing that to a file called `.env` in the same folder as the docker-compose file. For more information, see the [docker documentation on Compose profiles](https://docs.docker.com/compose/how-tos/profiles/).
12+
13+
If you are not using the example docker-compose, please follow the [instructions listed on the GitHub page](https://github.com/tv2/inews-ftp-gateway).
1214

1315
Although the iNEWS Gateway is available free of charge, an iNEWS license is not. Visit [Avid's website](https://www.avid.com/solutions/news-production) to find an iNEWS reseller that handles your geographic area.

packages/documentation/docs/user-guide/installation/installing-a-gateway/rundown-or-newsroom-system-connection/installing-sofie-with-google-spreadsheet-support.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,14 @@
22

33
The Spreadsheet Gateway is an application for piping data between Sofie Core and Spreadsheets on Google Drive.
44

5+
### Installing the Spreadsheet Gateway
6+
7+
If you are using the example Docker Compose file found in the [Quick install](../../installing-sofie-server-core.md), then the configuration for the Spreadsheet Gateway is includedin the `spreadsheet-gateway` docker-compose profile.
8+
9+
You can activate the profile by setting `COMPOSE_PROFILES=spreadsheet-gateway` as an environment variable or by writing that to a file called `.env` in the same folder as the docker-compose file. For more information, see the [docker documentation on Compose profiles](https://docs.docker.com/compose/how-tos/profiles/).
10+
11+
If you are not using the example docker-compose, please follow the [instructions listed on the GitHub page](https://github.com/SuperFlyTV/spreadsheet-gateway) labeled _Installation \(for developers\)_.
12+
513
### Example Blueprints for Spreadsheet Gateway
614

715
To begin with, you will need to install a set of Blueprints that can handle the data being sent from the _Gateway_ to _Sofie Core_. Download the `demo-blueprints-r*.zip` file containing the blueprints you need from the [Demo Blueprints GitHub Repository](https://github.com/SuperFlyTV/sofie-demo-blueprints/releases). It is recommended to choose the newest release but, an older _Sofie Core_ version may require a different Blueprint version. The _Rundown page_ will warn you about any issue and display the desired versions.
@@ -10,8 +18,6 @@ Instructions on how to install any Blueprint can be found in the [Installing Blu
1018

1119
### Spreadsheet Gateway Configuration
1220

13-
If you are using the example Docker Compose file found in the [Quick install](../../installing-sofie-server-core.md), then the configuration for the Spreadsheet Gateway is included but commented out. For those who are not, please follow the [instructions listed on the GitHub page](https://github.com/SuperFlyTV/spreadsheet-gateway) labeled _Installation \(for developers\)._
14-
1521
Once the Gateway has been installed, you can navigate to the _Settings page_ and check the newly added Gateway is listed as _Spreadsheet Gateway_ under the _Devices section_.
1622

1723
Before you select the Device, you want to add it to the current _Studio_ you are using. Select your current Studio from the menu and navigate to the _Attached Devices_ option. Click the _+_ icon and select the Spreadsheet Gateway.

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,10 @@ The MOS Gateway communicates with a device that supports the [MOS protocol](http
44

55
The setup for the MOS Gateway is handled in the Docker Compose in the [Quick Install](../../installing-sofie-server-core.md) page.
66

7+
An example setup for the MOS Gateway is included in the example Docker Compose file found in the [Quick install](../../installing-sofie-server-core.md) with the `mos-gateway` profile.
8+
9+
You can activate the profile by setting `COMPOSE_PROFILES=mos-gateway` as an environment variable or by writing that to a file called `.env` in the same folder as the docker-compose file. For more information, see the [docker documentation on Compose profiles](https://docs.docker.com/compose/how-tos/profiles/).
10+
11+
Development of the MOS gateway is done as a package in the [sofie-core repository on GitHub](https://github.com/nrkno/sofie-core/tree/master/packages/mos-gateway).
12+
713
One thing to note if managing the mos-gateway manually: It needs a few ports open \(10540, 10541\) for MOS-messages to be pushed to it from the NCS.

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

Lines changed: 44 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -72,36 +72,39 @@ services:
7272
# If using the Rundown Editor, then none of the below images are needed.
7373
# The Rundown Editor can be found here: https://github.com/SuperFlyTV/sofie-automation-rundown-editor
7474

75-
# spreadsheet-gateway:
76-
# image: superflytv/sofie-spreadsheet-gateway:latest
77-
# restart: always
78-
# command: yarn start -host core -port 3000 -id spreadsheetGateway0
79-
# networks:
80-
# - sofie
81-
# depends_on:
82-
# - core
83-
84-
# mos-gateway:
85-
# image: sofietv/tv-automation-mos-gateway:release51
86-
# restart: always
87-
# ports:
88-
# - "10540:10540" # MOS Lower port
89-
# - "10541:10541" # MOS Upper port
90-
# # - "10542:10542" # MOS query port - not used
91-
# command: yarn start -host core -port 3000 -id mosGateway0
92-
# networks:
93-
# - sofie
94-
# depends_on:
95-
# - core
96-
97-
# inews-gateway:
98-
# image: tv2media/inews-ftp-gateway:1.37.0-in-testing.20
99-
# restart: always
100-
# command: yarn start -host core -port 3000 -id inewsGateway0
101-
# networks:
102-
# - sofie
103-
# depends_on:
104-
# - core
75+
spreadsheet-gateway:
76+
image: superflytv/sofie-spreadsheet-gateway:latest
77+
restart: always
78+
command: yarn start -host core -port 3000 -id spreadsheetGateway0
79+
networks:
80+
- sofie
81+
depends_on:
82+
- core
83+
profiles: [spreadsheet-gateway]
84+
85+
mos-gateway:
86+
image: sofietv/tv-automation-mos-gateway:release51
87+
restart: always
88+
ports:
89+
- "10540:10540" # MOS Lower port
90+
- "10541:10541" # MOS Upper port
91+
# - "10542:10542" # MOS query port - not used
92+
command: yarn start -host core -port 3000 -id mosGateway0
93+
networks:
94+
- sofie
95+
depends_on:
96+
- core
97+
profiles: [mos-gateway]
98+
99+
inews-gateway:
100+
image: tv2media/inews-ftp-gateway:1.37.0-in-testing.20
101+
restart: always
102+
command: yarn start -host core -port 3000 -id inewsGateway0
103+
networks:
104+
- sofie
105+
depends_on:
106+
- core
107+
profiles: [inews-gateway]
105108

106109
networks:
107110
sofie:
@@ -115,11 +118,19 @@ volumes:
115118
116119
Create a `Sofie` folder, copy the above content, and save it as `docker-compose.yaml` within the `Sofie` folder.
117120

118-
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. Visit [Rundowns & Newsroom Systems](installing-a-gateway/rundown-or-newsroom-system-connection/intro.md) to see which _Ingest Gateway_ is best suited for _your_ production environment.
121+
Once the installation is done, Sofie should be running on [http://localhost:3000](http://localhost:3000)
122+
123+
You can now choose if you are using the [Rundown Editor](rundown-editor.md) or an _ingest-gateway_. Visit [Rundowns & Newsroom Systems](installing-a-gateway/rundown-or-newsroom-system-connection/intro.md) to see which _Ingest Gateway_ is best suited for _your_ production environment.
119124

120-
Then open a terminal, `cd your-sofie-folder` and `sudo docker-compose up` \(just `docker-compose up` on Windows\).
125+
Select the ingest gateway by creating using docker compose profiles. Create a file called `.env` in the same folder as docker compose with the contents:
121126

122-
Once the installation is done, Sofie should be running on [http://localhost:3000](http://localhost:3000)
127+
```
128+
COMPOSE_PROFILES=ingest-profile-name
129+
```
130+
131+
But replacing `ingest-profile-name` with one of `spreadsheet-gateway`, `mos-gateway` or `inews-gateway`, or a comma separated list of more than one. For more information, see the [docker documentation on Compose profiles](https://docs.docker.com/compose/how-tos/profiles/).
132+
133+
Then open a terminal, `cd your-sofie-folder` and `sudo docker-compose up` \(just `docker-compose up` on Windows or MacOS\).
123134

124135
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.
125136

0 commit comments

Comments
 (0)