is article applies to ScreenBeam CMS Enterprise product.
Sections in this document:
Section 2.1: CMS Server
Section 2.1.1: System Requirements
Section 2.1.2: Install ScreenBeam CMS Enterprise
Section 2.1.3: Check CMS Service Status
Section 2.1.4: Uninstall ScreenBeam CMS
Section 2.2: DNS Server and DHCP Server
Section 2.3: HTTP Server
2.1 CMS Server
ScreenBeam CMS Enterprise can be deployed directly on an X86 Windows device.
2.1.1 System Requirements
Designate an x86-based Windows device to host the CMS server. The device that hosts the CMS server should meet the following requirements:
Minimum Requirements
- Windows 10/11 (64-bit) Pro/Enterprise build 17763 or higher
- 2 Core I5 2 GHz or higher
- 8 GB Memory
- 30 GB available Hard Disk Space
- Network connectivity
Recommended Requirements
- Windows Server 2019 build 17763 or higher
- 4 Core Xeon 2 GHz or higher
- 16 GB Memory or higher
- 100 GB available Hard Disk Space
- Network connectivity
This device is to be configured based on the number of receivers deployed.
Ensure the following ports are opened on the PC hosting ScreenBeam CMS:
- CMS communication port: TCP 7237 (or the port specified during CMS installation), used to communicate with ScreenBeam receivers.
- Receiver log upload port: TCP 7238 (or the port specified during CMS installation), used for uploading receiver logs to the CMS server.
- CMS WebApp port: TCP 8888 (or the port specified during CMS installation), used for accessing CMS via a web browser.
- CMS Hub port: TCP 5001 (or the port specified during CMS installation), used for communication between web app and the CMS server.
- CMS Identity Server port: TCP 8890 (or the port specified during CMS installation), used for communication between the Identity server and CMS server.
- SQL server port: TCP 1433 (or the port specified during CMS installation), used for communication between SQL server and the CMS server.
Ensure that network policies allow TCP traffic on the CMS ports across the network routers and port forwarded accordingly.
|
Service |
Port (default) |
Protocol |
|
CMS communication |
7237 |
TCP |
|
CMS Receiver logging |
7238 |
TCP |
|
CMS WebApp |
8888 |
TCP |
|
CMS Hub |
5001 |
TCP |
|
CMS Identity Server |
8890 |
TCP |
|
SQL server |
1433 |
TCP |
Note the IP address, hostname, or fully qualified domain name belonging to the device hosting CMS server.
2.1.2 Install ScreenBeam CMS
ScreenBeam CMS Enterprise Installer version is a replacement for CMS Enterprise Docker 4.0 version or CMS V2.x. Therefore, if any of these versions is installed on the machine, be sure to remove it first. If Docker and Hyper-V are not used by other programs, uninstall them, as well.
To install ScreenBeam CMS, follow this procedure:
- Go to https://www.screenbeam.com/products/screenbeam-cms-enterprise/ and download the latest version of ScreenBeam CMS Enterprise software.
- Extract the downloaded software package and run the ScreenBeam CMS installer.
Note: A user with Administrator privilege is required to run the ScreenBeam CMS installer.
- The Microsoft Defender Smartscreen window may appear. Click More Info and then click Run Anyway to continue.
- During the installation, the software license agreement appears first. Read the agreement carefully. Select I accept the agreement and click Next to continue.
- The User Management Service Selection window appears. Select ScreenBeam CMS User Management and click Next.
- ScreenBeam CMS User Management. ScreenBeam CMS users will be managed locally with the Identity server.
- Azure Active Directory Service (AAD) (Beta). ScreenBeam CMS users will be managed using Azure Active Directory.
- (Optional) If you choose Azure Directory Service (AAD) (Beta), you need to specify the following parameters on the Azure Active Directory Configuration page that appears:
- Delegation: CMS needs a signed-in user to request data from AAD.
- Stand-Alone/Daemon: CMS can request permitted data without a signed-in user.
- Azure Active Directory (Tenant) ID: The ID of the tenant used to manage ScreenBeam CMS.
- Azure Active Directory Application (client) ID: It is the ID of the registered app for ScreenBeam CMS.
- Azure Active Directory Group ID: It is the ID of the Security group that is assigned to manage ScreenBeam CMS.
- Azure Active Directory Client Secret: It is the secret of the registered application for ScreenBeam CMS.
Note: For detailed setups about Azure AD and ScreenBeam CMS, refer to Appendix I.
- The SQL Server Database Setup window appears. Users are allowed to use an existing SQL server or install a new SQL Server instance.
It is highly recommended to install an SQL Server instance on the same machine. As an existing SQL server on a separate machine can result in network latency, which will slow down CMS functions.
Select Install a new SQL Server instance on your system (RECOMMENDED) and click Next.
- The SQL Server Instance Setup page appears. A new SQL Server instance will be installed on your system, and you must define an SQL Server port and a password. Microsoft SQL 2017 Express will be installed. Define these parameters and click Next to continue.
If you choose to use an existing SQL server, you must set up the following parameters: SQL server host, SQL server port, username and password.
- The ScreenBeam CMSv4 port configuration window appears.
- Your server IP or FQDN: The CMS installer will get the IP address of your server automatically. If not, type the IP address of your server in this field. Note: You must enter the FQDN of your server in this field if you plan to access the CMS using an FQDN.
- CMS WebApp port: This port is for accessing the CMS server via a web browser. The default port is 8888. If this port is already in use, specify a new one.
- CMS Identity Server Port: This port is for communication between the CMS and the Identity server. The default port is 8890. If this port is already in use, specify a new one.
- CMS Hub port: This port is for communication between the web app and the CMS server. The default port is 5001. If this port is already in use, specify a new one.
- CMS receiver port: This port is for communication between receivers and the CMS server. The default port is 7237. If this port is already in use, specify a new one.
- CMS receiver log port: This port is for uploading receiver logs to the CMS server. The default port is 7238. If this port is already in use, specify a new one.
Note: Valid port ranges from 1024 to 65535, provided these ports are not used by other devices on the network.
Ensure that any custom port numbers are noted for future reference.
Define these parameters and click Next to continue.
- The Ready to Install window appears. Click Install to continue.
The remaining installation process is automated. It may take some time to complete the installation.
Enable IIS features.
Install ScreenBeam CMS Enterprise.
Install SQL server, if you choose to install a new SQL server instance.
Note: Don’t click in the Windows PowerShell window during the installation. If you have done it, the installation may pause. In this case, you can press Enter to resume.
A message box that shows how to access the CMS WebApp appears. The CMS WebApp can be accessed via https://<your_server_ip>:WebApp_port
- ScreenBeam CMS Enterprise is successfully installed when the installation completion window appears. Click Finish.
If there is an existing CMS installation, then the message box below will appear. Select YES to upgrade CMS or NO to reconfigure settings in your current installation.
The Ready to Install window appears. Click Install. The remaining installation process is automated.
2.1.3 Check CMS Service Status
After the CMS is installed, you can check if the CMS services are running.
To check the CMS service status, follow this procedure:
- Open Internet Information Services (IIS) Manager on your server.
- On the Connections pane, navigate to Sites, and check the status of the following sites: CMSHubAppSite, CMSIdentityServerAppSite, and CMSWebAppSite.
- When these sites are started, the CMS is running.
- When one of these sites is stopped, the CMS is out of service.
- On the Connections pane, select Application Pools, and check the status of the following pools: ScreenBeamCMSHubPool, ScreenBeamCMSIdentityServerPool, and ScreenBeamCMSWebAppPool.
- When these pools are started, the CMS is running.
- When one of these sites is stopped, the CMS is out of service
2.1.4 Uninstall ScreenBeam CMS
Note: Ensure that all receivers are switched to the new CMS server before starting the uninstallation process. CMS data backup and restoration are currently not supported.
To uninstall ScreenBeam CMS, follow this procedure:
- Go to Control Panel > All Control Panel Items > Programs and Features, select ScreenBeam CMS Enterprise version 4.x.x.x and click Uninstall.
- The ScreenBeam CMS Enterprise Uninstall message box appears. Click Yes to uninstall ScreenBeam CMS Enterprise.
2.2 DNS Server and DHCP Server
A DNS server, while technically optional, is strongly recommended for discovery of ScreenBeam receivers. DNS Discovery allows all ScreenBeam receivers discovered by the CMS server, requiring very little user interaction once the network is configured properly. Additional details on this method can be found in Section 3.2 Provisioning Receivers Using DNS Discovery Method.
1.2 HTTP Server
An HTTP server should be deployed in parallel with CMS to host the firmware files and other miscellaneous files used for upgrading or customizing ScreenBeam Receivers.
For a large ScreenBeam deployment, the HTTP server should be of commercial-grade, capable of handling a large number of simultaneous connections and bandwidth as policy and network capabilities shall permit.
Generally, the HTTP server should meet these requirements:
Minimum Requirements (for 100 or less receivers):
- OS: Windows 10/11 Pro
- CPU: 1.4 GHz 64-bit Processor
- RAM: 8 GB
- Disk space: 40 GB of free space
- Network: PCI-E Ethernet adapter capable of at least 1 Gbps throughput
Recommended Requirements (for 1000 or more receivers):
- OS: Linux Server NGINX or equivalent Windows server 2019
- CPU: 8-Core @ 2.4 GHz or faster
- RAM: 16 GB or more
- Disk space: 100 GB of free disk space
- Network: PCI-E Ethernet adapter capable of 1 Gbps throughput or faster
Note: While the same CMS host can technically be used to host a web server, this may result in unpredictable CMS and/or HTTP server behavior. Use of a different server is highly recommended to ensure optimal performance.
2.3 HTTP Server
An HTTP server should be deployed in parallel with CMS to host the firmware files and other miscellaneous files used for upgrading or customizing ScreenBeam Receivers.
For a large ScreenBeam deployment, the HTTP server should be of commercial-grade, capable of handling a large number of simultaneous connections and bandwidth as policy and network capabilities shall permit.
Generally, the HTTP server should meet these requirements:
Minimum Requirements (for 100 or less receivers):
- OS: Windows 10/11 Pro
- CPU: 1.4 GHz 64-bit Processor
- RAM: 8 GB
- Disk space: 40 GB of free space
- Network: PCI-E Ethernet adapter capable of at least 1 Gbps throughput
Recommended Requirements (for 1000 or more receivers):
- OS: Linux Server NGINX or equivalent Windows server 2019
- CPU: 8-Core @ 2.4 GHz or faster
- RAM: 16 GB or more
- Disk space: 100 GB of free disk space
- Network: PCI-E Ethernet adapter capable of 1 Gbps throughput or faster
Note: While the same CMS host can technically be used to host a web server, this may result in unpredictable CMS and/or HTTP server behavior. Use of a different server is highly recommended to ensure optimal performance.