Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • 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:

    Code Block
    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 called shutdown with the following command:

    Code Block
    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:

    Code Block
    <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 gumbandwith chmod +x gumband-os-monitor-linux-x64 executable when the machine boots and the user logs in:

  • Create a

    bash

    script

    with the following contents:

    to run the os monitor from systemd: vi startup.sh

Code Block
#!/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:

...

  • Create a systemd daemon for this user with

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

and edit the service to be:

Code Block
[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.

...

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:

Code Block
#!/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

View file
namegumband-os-monitor-linux-v0.0.7.zipx64