Linux

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 the gumband-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 with chmod +x gumband-os-monitor-linux-x64

• Create a script to run the os monitor from systemd: vi startup.sh

#!/bin/sh
cd /path/to/gumband-os-monitor;
./gumband-os-monitor-linux-x64

• Create a systemd daemon for this user with

mkdir -p $HOME/.local/share/systemd/user;
vi $HOME/.local/share/systemd/user/gumband-os-monitor.service

and edit the service to be:

[Unit]
Description=Gumband OS Monitor
[Service]
Type=simple
TimeoutStartSec=0
ExecStart=bash /path/to/startup/script
[Install]
WantedBy=default.target

• Ensure that scrot is installed (a linux, command-line screenshot application). Run which 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.

Troubleshooting

Taking a screenshot isn’t working. I see the error: “Command failed: xrandr Can't open display”

This problem occurs because the os-monitor doesn’t have access to the $DISPLAY environment variable, since it is running as a daemon. To fix this, add the environment variable to the daemon through your startup.sh script:

#!/bin/sh

//This value may differ depending on the host machine
export DISPLAY=:0;

cd /path/to/gumband-os-monitor;
./gumband-os-monitor-linux-x64

Zip Download