Merge pull request Sofie-Automation#1530 from SuperFlyTV/fix/package-manager-setup-docs

chore: fix package manager setup docs

Author: nytamin

packages/blueprints-integration/src/index.ts

@@ -30,3 +30,4 @@ export * from '@sofie-automation/shared-lib/dist/lib/JSONSchemaUtil'
 export * from '@sofie-automation/shared-lib/dist/core/model/StudioRouteSet'
 export * from '@sofie-automation/shared-lib/dist/core/model/StudioSettings'
 export * from '@sofie-automation/shared-lib/dist/core/model/CoreSystemSettings'
+export * from '@sofie-automation/shared-lib/dist/core/model/PackageContainer'

packages/documentation/docs/user-guide/installation/installing-connections-and-additional-hardware/casparcg-server-installation.md

@@ -1,6 +1,6 @@
 ---
 title: Installing CasparCG Server for Sofie
-description: Sofie specific fork of CasparCG Server 2.1
+description: CasparCG Server
 ---
 
 # Installing CasparCG Server for Sofie
@@ -9,28 +9,23 @@ Although CasparCG Server is an open source program that is free to use for
 
 ## Installing the CasparCG Server
 
-To begin, download the latest release of [CasparCG Server from GitHub](https://github.com/nrkno/sofie-casparcg-server/releases). There are multiple versions of CasparCG Server available to the public for download but, you specifically want the latest NRK version.
+To begin, download the latest release of [CasparCG Server from GitHub](https://github.com/casparcg/server/releases). While some Sofie users have their own fork of CasparCG, we recommend the official builds.
 
-Once downloaded, extract the files and navigate down the folders, _CasparCG Server_ then _Server_. This folder contains your CasparCG Server Configuration file, `casparcg.config`, and your CasparCG Server executable, `casparcg.exe`.
+Once downloaded, extract the files into a folder and navigate inside. This folder contains your CasparCG Server Configuration file, `casparcg.config`, and your CasparCG Server executable, `casparcg.exe`.
 
 How you will configure the CasparCG Server will depend on the number of DeckLink cards your machine contains. The first subsection for each CasparCG Server setup, labeled _Channels_, will contain the unique portion of the configuration. The following is the majority of the configuration file that will be consistent between setups.
 
 ```markup
 <?xml version="1.0" encoding="utf-8"?>
 <configuration>
   <log-level>debug</log-level>
-  <thumbnails>
-    <generate-thumbnails>false</generate-thumbnails>
-  </thumbnails>
   <!-- Paths to the Server Media -->
   <!-- Currently set to the same folder as this file -->
   <paths>
     <media-path>media/</media-path>
     <log-path>log/</log-path>
     <data-path>data/</data-path>
     <template-path>template/</template-path>
-    <thumbnail-path>thumbnail/</thumbnail-path>
-    <font-path>font/</font-path>
   </paths>
   <lock-clear-phrase>secret</lock-clear-phrase>
   <channels>
@@ -41,25 +36,21 @@ How you will configure the CasparCG&nbsp;Server will depend on the number of Dec
       <port>5250</port>
       <protocol>AMCP</protocol>
     </tcp>
-  <tcp>
-    <port>3250</port>
-    <protocol>LOG</protocol>
-  </tcp>
   </controllers>
+  <amcp>
+    <media-server>
+      <host>localhost</host>
+      <port>8000</port>
+    </media-server>
+  </amcp>
 </configuration>
 ```
 
 One additional note, the Server does require the configuration file be named `casparcg.config`.
 
-### Installing CasparCG Media Scanner
-
-You can use the CasparCG Media Scanner to locate and add all of your media to the _Sofie&nbsp;Core_. To install the Media Scanner, you will go to the [project's Release page](https://github.com/nrkno/sofie-media-scanner/releases) and download the `.zip` file under the latest release. Similar to the CasparCG&nbsp;Server, you want to use the NRK version.
-
-Once downloaded and extracted, move the `scanner.exe` file to the same folder as your `casparcg.exe` file.
-
 ### Installing the CasparCG Launcher
 
-You can launch both of your CasparCG applications with the[ CasparCG Launcher.](https://github.com/Sofie-Automation/sofie-casparcg-launcher) Download the `.exe` file in the latest release and once complete, move the file to the same folder as your `casparcg.exe` file.
+You can launch both of your CasparCG applications with the [CasparCG Launcher.](https://github.com/Sofie-Automation/sofie-casparcg-launcher) Download the `.exe` file in the latest release and once complete, move the file to the same folder as your `casparcg.exe` file.
 
 ## Configuring Windows
 
@@ -83,7 +74,7 @@ For _dual drives_, it is recommended to use a smaller 250gb NVMe SSD for the ope
 
 ### DeckLink Cards
 
-There are a few SDI cards made by Blackmagic Design that are supported by CasparCG. The base model, with four bi-directional input and outputs, is the [Duo 2](https://www.blackmagicdesign.com/products/decklink/techspecs/W-DLK-31). If you need additional channels, use the[ Quad 4](https://www.blackmagicdesign.com/products/decklink/techspecs/W-DLK-30) which supports eight bi-directional inputs and outputs. Be aware the BNC connections are not the standard BNC type. B&H offers [Mini BNC to BNC connecters](https://www.bhphotovideo.com/c/product/1462647-REG/canare_cal33mb018_mini_rg59_12g_sdi_4k.html). Finally, for 4k support, use the [8K Pro](https://www.blackmagicdesign.com/products/decklink/techspecs/W-DLK-34) which has four bi-directional BNC connections and one reference connection.
+There are a few SDI cards made by Blackmagic Design that are supported by CasparCG. The base model, with four bi-directional input and outputs, is the [Duo 2](https://www.blackmagicdesign.com/products/decklink/techspecs/W-DLK-31). If you need additional channels, use the [Quad 2](https://www.blackmagicdesign.com/products/decklink/techspecs/W-DLK-30) which supports eight bi-directional inputs and outputs. Be aware the BNC connections are not the standard BNC type. B&H offers [Mini BNC to BNC connecters](https://www.bhphotovideo.com/c/product/1462647-REG/canare_cal33mb018_mini_rg59_12g_sdi_4k.html). Finally, for 4k support, use the [8K Pro](https://www.blackmagicdesign.com/products/decklink/techspecs/W-DLK-34) which has four bi-directional BNC connections and one reference connection.
 
 Here is the Blackmagic Design PDF for [installing your DeckLink card \( Desktop Video Device \).](https://documents.blackmagicdesign.com/UserManuals/DesktopVideoManual.pdf)
 
@@ -207,7 +198,7 @@ Once you have setup the configuration file, you can use an online validator to c
 
 ### Launching the Server
 
-Launching the Server is the same for each hardware setup. This means you can run`casparcg-launcher.exe` and the server and media scanner will start. There will be two additional warning from Windows. The first is about the EXE file and can be bypassed by selecting _Advanced_ and then _Run Anyways_. The second menu will be about CasparCG&nbsp;Server attempting to access your firewall. You will need to allow access.
+Launching the Server is the same for each hardware setup. This means you can run `casparcg-launcher.exe` and the server and media scanner will start. There will be two additional warning from Windows. The first is about the EXE file and can be bypassed by selecting _Advanced_ and then _Run Anyways_. The second menu will be about CasparCG&nbsp;Server attempting to access your firewall. You will need to allow access.
 
 A window will open and display the status for the server and scanner. You can start, stop, and/or restart the server from here if needed. An additional window should have opened as well. This is the main output of your CasparCG&nbsp;Server and will contain nothing but a black background for now. If you have a DeckLink card installed, its output will also be black.
 

packages/documentation/docs/user-guide/installation/installing-package-manager.md

@@ -9,7 +9,7 @@ sidebar_position: 7
 - [Installed and running Sofie Core](installing-sofie-server-core.md)
 - [Initial Sofie Core Setup](initial-sofie-core-setup.md)
 - [Installed and configured Demo Blueprints](https://github.com/SuperFlyTV/sofie-demo-blueprints)
-- [Installed, configured, and running CasparCG Server](installing-connections-and-additional-hardware/casparcg-server-installation.md)
+- [Installed, configured, and running CasparCG Server](installing-connections-and-additional-hardware/casparcg-server-installation.md) (Optional)
 - [`FFmpeg` and `FFprobe` available in `PATH`](installing-connections-and-additional-hardware/ffmpeg-installation.md)
 
 Package Manager is used by Sofie to copy, analyze, and process media files. It is what powers Sofie's ability to copy media files to playout devices, to know when a media file is ready for playout, and to display details about media files in the rundown view such as scene changes, black frames, freeze frames, and more.
@@ -38,13 +38,7 @@ git clone https://github.com/Sofie-Automation/sofie-package-manager.git
 cd sofie-package-manager
 yarn install
 yarn build
-yarn start:single-app -- -- --basePath "C:\your\path\to\casparcg-server\media-folder (i.e. sofie-demo-media)"
-```
-
-Note: if Powershell throws `Unknown argument: basePath` error, add one more pair of dashes (`--`) before the basePath argument:
-
-```bash
-yarn start:single-app -- -- -- --basePath "C:\your\path\to\casparcg-server\media-folder (i.e. sofie-demo-media)"
+yarn start:single-app
 ```
 
 On first startup, Package Manager will exit with the following message:
@@ -175,8 +169,12 @@ Note that each appContainer needs to use a different resourceId and will need it
    - If you don't have a `casparcg0` device, add it to the Playout Gateway under the Devices heading, then restart the Playout Gateway.
    - If you are using the distributed setup, you will likely want to repeat this step for each CasparCG machine. You will also want to set `Resource Id` to match the `resourceId` value provided in the appContainer command line.
 1. Click the plus button under "Accessors", then click the edit icon to the right of the newly-created accessor.
-1. Give this accessor an ID of `casparcgHttpProxy0`, a Label of `CasparCG HTTP Proxy Accessor`, an Accessor Type of `HTTP_PROXY`, and a Base URL of `http://localhost:8080/package`. Then, ensure that both the "Allow Read access" and "Allow Write access" boxes are checked. Finally, click the done button (checkmark icon) in the bottom right.
-1. Scroll back to the top of the page and select "CasparCG Package Container" for both "Package Containers to use for previews" and "Package Containers to use for thumbnails".
+1. Give this accessor an ID of `local`, a Label of `Local`, an Accessor Type of `LOCAL`, and a Folder path matching your CasparCG `media` folder. Then, ensure that only the "Allow Read access" boxes are checked. Finally, click the done button (checkmark icon) in the bottom right.
+1. Click the plus button under the Package Containers heading, then click the edit icon (pencil) to the right of the newly-created package container.
+1. Give this package container an ID of `httpProxy0` and a label of `Proxy for thumbnails & preview`.
+1. Click the plus button under "Accessors", then click the edit icon to the right of the newly-created accessor.
+1. Give this accessor an ID of `http0`, a Label of `HTTP`, an Accessor Type of `HTTP_PROXY`, and a Base URL of `http://localhost:8080/package`. Then, ensure that both the "Allow Read access" and "Allow Write access" boxes are checked. Finally, click the done button (checkmark icon) in the bottom right.
+1. Scroll back to the top of the page and select `Proxy for thumbnails & preview` for both "Package Containers to use for previews" and "Package Containers to use for thumbnails".
 1. Your settings should look like this once all the above steps have been completed:
    ![Package Manager demo settings](/img/docs/Package_Manager_demo_settings.png)
 1. If Package Manager `start:single-app` is running, restart it. If not, start it (see the above [Installation instructions](#installation-quick-start) for the relevant command line).
@@ -191,11 +189,11 @@ By adding `--networkIds=pm-net` (a semi colon separated list) when launching the
 Then in the Sofie UI:
 
 1. Return to the Package Manager settings under the studio
-1. Expand the `casparcgContainer` container.
-1. Edit the `casparcgHttpProxy` accessor to have a `Base URL` that is accessible from the casparcg machines.
+1. Expand the `httpProxy0` container.
+1. Edit the `http0` accessor to have a `Base URL` that is accessible from the casparcg machines.
 1. Set the `Network ID` to `pm-net` (matching what was passed in the command line)
 1. Click the plus button under "Accessors", then click the edit icon to the right of the newly-created accessor.
-1. Give this accessor an ID of `casparcgHttpProxyThumbnails0`, a Label of `CasparCG Thumbnail HTTP Proxy Accessor`, an Accessor Type of `HTTP_PROXY`, and a Base URL that is accessible to your Sofie client network. Then, ensure that only the "Allow Write access" box is checked. Finally, click the done button (checkmark icon) in the bottom right.
+1. Give this accessor an ID of `publicHttp0`, a Label of `Public HTTP Proxy Accessor`, an Accessor Type of `HTTP_PROXY`, and a Base URL that is accessible to your Sofie client network. Then, ensure that only the "Allow read access" box is checked. Finally, click the done button (checkmark icon) in the bottom right.
 
 ## Usage