These are instructions on how to set up the Gumband OS Monitor on a linux host machine.
Setup
Download the Gumband OS Monitor
zip
file at the bottom of this page, and extract its contents to a place that is unlikely to be touched.Create an exhibit in the Gumband UI, and get an exhibit token and id.
Add a
.env
file to the same directory that thegumband-os-monitor-linux-x64
file is and add the exhibit token and id from the previous step:EXHIBIT_TOKEN=02b6903aece21b6sff520ac92dcba457 EXHIBIT_ID=1 # If the Gumband UI you're connecting to is not app.gumband.com, you'll # need to add two more environment variables here: # ENDPOINT=custom <----- indicates a custom IP # CUSTOM_IP=other.gmbnd.com <----- defines an endpoint that isn't app.gumband.com
Give the
gumband-os-monitor-linux-x64
file execution permission.The user profile that is running the OS Monitor will need to be granted administrator (sudo) privileges for the shutdown command, so that the OS Monitor can reboot the machine on demand. Create a new file in
/etc/sudoers.d
calledshutdown
with the following command:sudo visudo -f /etc/sudoers.d/shutdown
That command will ensure that the
shutdown
file is created with the correct permissions. Edit the file to be:<USER> ALL=NOPASSWD: /sbin/shutdown
Where
<USER>
should be the name of the user running the gumband os monitor. This whitelists the shutdown command for the user provided.Use the Startup Application to run the
gumband-os-monitor-linux-x64
executable when the machine boots and the user logs in:Create a bash script with the following contents:
#!/bin/sh cd ${path-to-gumband-os-monitor}; ./gumband-os-monitor-linux-x64
The script must
cd
to the appropriate directory so the OS Monitor has access to the.env
file.In the Startup Application, create a new startup program and set it to run the bash script:
bash ${path-to-gumband-os-monitor}/script.sh
Ensure that
scrot
is installed (a linux, command-line screenshot application). Runwhich scrot
to check if it is installed.
Testing
Reboot the PC. When it boots up, the OS Monitor should show as online in the Gumband UI:
Check that taking screenshots is functioning. Click the "Take Screenshot" button on the "Control" tab in Gumband. It should upload a screenshot to the "Files" tab.
Check that the reboot control is working. Click the "Reboot" button on the "Control” tab in Gumband. The host machine should reboot.
Zip Download