Tools & Utilities
Diagnostic Web Server (DWS)
Access the Local DWS
8 min
the local diagnostic web server (local dws or ldws) is disabled by default as of brightsignos 9 0 218 (on the 9 0 branch) and brightsignos 9 1 75 (on the 9 1 branch) in brightsignos versions prior to these, the local dws was enabled by default to enable the local dws, see access the local dws docid\ iafcherljfjdjtwttkpk5 when the diagnostic web server (dws) docid\ qxt4yhey7iej m9dh73wm is accessed over the local network, it is referred to as the local dws or ldws the local dws is accessible over the local network with a web browser or the brightsign shell several access methods exist as described below enable the local dws the local dws can be enabled using one of the methods described below brightauthor\ connected the easiest way to enable the local dws is to use the brightauthor\ connected app to create a setup that enables and configures the local dws go to the admin tab and select setup docid\ xnnxywmv09iegziit7rwa under player settings > player configuration , click the checkbox next to enable local diagnostic web server for players that are already set up and connected to a bsn cloud network, the dws can also be turned on or off under network docid\ uba8sfkmsajsibrbv4a6n enter a password for the dws password must be at least 8 characters long and include at least one uppercase letter, one lowercase letter, one number, and one special character the username will always be “admin” specify other player settings as desired and either save the setup to a file location or add the setup to the setup library docid\ hzy2w0meeeryiforz9xfr the player must then be provisioned which applies the setup to the desired player for instructions, see this page provision docid\ cyl9kpm02co5rgcb9wqqv advanced methods t he player's local dws can also be enabled using brightscript, the javascript api, or the brightsign serial command prompt these methods require more technical expertise than using the brightauthor\ connected app the full instructions and scripts to enable the local dws can be found here brightscript a custom script containing the ronetworkconfiguration docid\ u6zceyqddlz9xdakttmjs object can be used to enable the local dws include the following lines in a autorun brs script to enable the local dws on ethernet port 80 this example script also sets the password (replace "your password here" with a strong password) brightscript sub main() 	' create network configuration object (0 = eth0, 1 = wlan0, 2 = ppp0, usb0 and usb1 can be input as well) 	nc = createobject("ronetworkconfiguration", 0) 	dwsconfig = { port 80, open "your password here" } 	rebootrequired = nc setupdws(dwsconfig) 	nc apply() end sub javascript api the local dws can be enabled through the javascript api by using the script below this example script also sets the password (replace "your password here" with a strong password) const dwsconfiguration = require("@brightsign/dwsconfiguration"); const systemclass = require("@brightsign/system"); async function configureldws() { 	const system = new systemclass(); 	const dwsconfig = new dwsconfiguration(); 	const config = { 	 port 80, // http port for web interface 	 password { 	 value "your password here", 	 obfuscated false // password stored as plain text 	 }, 	 authenticationlist \["digest"] // use digest http authentication 	}; 	try { 	 dwsconfig applyconfig(config); 	 system reboot(); 	} catch (error) { 	 console error("configuration failed ", error message); 	} } configureldws(); serial prompt the local dws can be enabled through the player's serial port using the brightsign shell docid\ fxxyu9jmocutc6xe2p7l2 the following commands enable the local dws by writing to the player's registry this is the least prefered method of enabling the local dws as it does not set a strong password; it sets the player's serial number as the password registry write networking http server 80 registry flush a registry flush is necessary if you plan to power cycle the unit after executing the registry command registry writes will buffer for a few seconds because the eeprom and nand have a limited number of writes (and thus need to protect against carrying out too many writes too quickly) access the dws once the local dws has been enabled using one of the methods outlined above, you can access the local dws by entering the player's local ip address into your web browser note that there will be a redirect to a secure web connection (i e , https //{player ip}) if the player's ip address is not known, brightsign ${serial} local can be entered into the browser's address bar where {serial} is the serial number of the player as with entering the ip address, there will be a redirect to a secure web connection your browser may display a security warning to the effect of "your connection is not private" or "this connection is not secure" this occurs because the player is using a self signed ssl certificate which browsers do not automatically recognize as trusted this warning is expected and safe to bypass self signed certificates, while lacking third party validation, provide the same encryption protection as trusted certificates