Wiki source code of VC-4 Setup

Version 21.1 by Alexander Mott on 2023/05/16 14:24

version	line-number	content
2.2	1	(% class="box errormessage" %)
	2	(((
	3	This page is for VC-4 deployments. For other processors, see our [[normal processor setup page>>doc:SHOWRUNNER™ Setup Guide.SHOWRUNNER™ Installation Guide.SHOWRUNNER™ Installation and Network Setup.Processor Setup.WebHome]].
	4	)))
	5
	6	(% class="box warningmessage" %)
	7	(((
9.1	8	ShowRunnerCLC™ on VC-4 requires version 4.000.0007 of VC-4
2.2	9	)))
	10
7.1	11	{{box cssClass="floatinginfobox" title="CONTENTS"}}
3.1	12	{{toc/}}
	13	{{/box}}
	14
2.2	15	Licensing tutorial:
	16
	17	//Note: Please use Chrome or Firefox to download the License from [[https:~~/~~/portal.chiefintegrations.com>>https://portal.chiefintegrations.com]]. Edge and Internet Explorer do not work properly.//
	18
	19	[[https:~~/~~/www.youtube.com/watch?v=H8CLZ7bp0eI>>url:https://www.youtube.com/watch?v=H8CLZ7bp0eI]]
	20
	21	Pre-Requisites
	22
	23	* VC-4 must have an SSL certificate
	24
3.1	25	= Program Install =
2.2	26
9.1	27	* Download //CI_ShowRunner_vx.xx.cpz// and //Redirect.zip// from the VC-4 folder on the ShowRunnerCLC™ releases site
2.2	28	* Connect to the VC-4 server [[https:~~/~~/(Your_VC-4_IPAddress)/VirtualControl/config/settings/>>https://(Your_VC-4_IPAddress)/VirtualControl/config/settings/]]
	29	* Load the Program
	30	** Go to the //Settings// tab
	31	** Go to the //Program Library// section
	32	** Add Program button
	33	*** Step 1 of 2
	34	**** Name: showrunner
	35	**** Program File: Select ShowRunnerLoadHelper.cpz
	36	[[image:1663089906147-492.png\|\|height="261" width="414"]]
	37	**** Hit //Next >//
	38	*** Step 2 of 2
	39	**** Configuration Pages: Select Redirect.zip
	40	[[image:1663090552845-124.png\|\|height="326" width="404"]]
	41	* Navigate to the "Device Info" section under the "Status Tab"
12.1	42	** Record the serial number and MAC address
	43	* Create a new room and load the ShowRunner™ License as the User File for the room
	44	** ShowRunner™ license requires the Room ID and Room Name, as well as the MAC address
18.1	45	** Room ID is always one word, all caps and is case-sensitive for the license
2.2	46
12.1	47	= Accessing the ShowRunner™ Console =
	48
	49	To access the ShowRunner™ console, connect to the VC-4 with PuTTY or another text console, log in to Linux, and then run the command ##telnet 127.0.0.1 50001##
	50
15.1	51	This command will open a telnet session with the ShowRunner™ program running on the VC-4, enabling the use of typical "sr" commands. To leave the ShowRunner™ console and close the telnet application, press the escape character '^]' ('ctrl+]'), type "quit", and then press enter.
12.1	52
19.1	53	The ShowRunner™ console can be used track normal Crestron console messages to the /var/log/messages log by setting up a VC-4 API token and registering it in ShowRunner™. To do this, navigate to the VC-4 configuration page, navigate to the "Settings" tab and open the "Tokens" section. Click "Add Token" and name it "showrunner". Copy the token to your clipboard and then go into the ShowRunner™ console. Run the command "##sradmin set vc4 api token [paste the api token]##" and then run the command "##sradmin restart##"
	54
	55	By running the command "##sudo tail -f /var/log/messages##", the Linux console will start tracking messages that you would normally see if you connected to an ordinary processor via Text Console.
	56
9.1	57	= Accessing the ShowRunnerHUB™ Web UI =
2.2	58
20.1	59	The ShowRunner™ configuration should be uploaded to the processor using the ShowRunnerHUB™ web UI. It is not possible to access the ShowRunnerHUB™ web UI by directly navigating to the IP address of the VC-4 server, instead it is necessary to navigate to the following URL: https:~/~/vc-4ip/VirtualControl/Rooms/ROOMID/cws/showrunner/app/ (Bold portions should be modified with your specific IP and Room ID [Room ID is case sensitive]; DO NOT OMIT THE LAST "/")
2.2	60
17.1	61	Prior to logging in to the ShowRunnerHUB™ UI, it is necessary to create a ShowRunner™ user. Open the ShowRunner™ console as described above and run the following command, replacing the "username", "name" and "password" with your desired credentials: ##sradmin add user username "name" Administrators password##
16.1	62
17.1	63	The username and password should be one word each and will be the credentials used to log in to the ShowRunnerHUB™ UI. The name can be multiple words as long as it is in quotes, and is simply a friendly name used to identify each user.
16.1	64
8.1	65	VC-4 Currently does NOT serve the XPANEL:
9.1	66	The XPanel does not launch from the ShowRunnerHUB webpage. To access the XPanel, extract the VTZ file from the ShowRunnerCLC™ puf file and launch. Select Options>Host Settings and input the Host IP, IPID, Port 41794, check SSL, enter the Room ID, and Open. Type in the username and password (if applicable) and wait for the XPanel to connect.