DWS: Local Access

local access (i e , access over the local network) of the diagnostic web server (dws) 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, local access to the dws was enabled by default note that some specially configured players have the external microsd card port and usb storage disabled at the factory (sku svc internal storage only) for these players, local access to the dws remains enabled by default this page describes several methods to enable local access to the dws enable local access local access to the dws can be enabled using one of the methods described below brightauthor\ connected the easiest way to enable local access to the dws is to use the brightsign author app to create a setup file that enables and configures the 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 brightsign cloud network, the dws can also be turned on or off under network > properties 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 file to a file location or add the setup to the setup library docid\ hzy2w0meeeryiforz9xfr the player must then be provisioned which applies the setup file to the desired player for instructions, see this page provision docid\ cyl9kpm02co5rgcb9wqqv advanced methods local access to the 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 brightsign author app the full instructions and scripts to enable local access to the dws can be found here https //github com/brightsign/dev cookbook/blob/main/examples/enable ldws example/readme md#running the examples brightscript a custom script containing the ronetworkconfiguration docid\ u6zceyqddlz9xdakttmjs object can be used to enable local access to the dws include the following lines in a autorun brs script to enable access to the 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() registrysection = createobject("roregistrysection", "networking") 	registrysection write("dwse","yes") if rebootrequired then rebootsystem() end if // rest of the code end sub javascript api local access to the 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"); const registryclass = require("@brightsign/registry"); async function configureldws() { 	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 { const dwsconfig = new dwsconfiguration(); 	 await dwsconfig applyconfig(config); // also write networking dwse key const registry = new registryclass(); await registry write("networking", "dwse", "yes"); // reboot the player const system = new systemclass(); 	 system reboot(); 	} catch (error) { 	 console error("configuration failed ", error message); 	} } configureldws(); serial prompt local access to the dws can be enabled through the player's serial port using the brightsign shell docid\ fxxyu9jmocutc6xe2p7l2 the following commands enable local access to the dws by writing to the player's registry this is the least preferred method of enabling local access to the dws as it does not set a strong password; it sets the player's serial number as the password registry write networking dwse yes 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 local access to the dws has been enabled using one of the methods outlined above, you can access 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 example see this brightsign github page https //github com/brightsign/dev cookbook/tree/main/examples/browser/enable ldws which demonstrates three different methods to enable and configure the dws on your player