**Docs currently under construction
These are instructions on how to set up the Gumband OS Monitor on a mac 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-macos-arm64
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. Should be set to the string, "custom" # CUSTOM_IP=other.gmbnd.com <----- defines an endpoint that isn't app.gumband.com
Give the
gumband-os-monitor-macos-arm64
file “Full Disk Access” under System Preferences → Security & Privacy. This is so it has permission to reboot the computer and write logs.Give the
gumband-os-monitor-macos-arm64
file “Screen Recording” permission under SystemPreferences → Security & Privacy. This is so it has permission to take screenshots.Create a new plist file in the
/System/LaunchAgents
directory calledcom.boot.osmonitor
. Add the following code (make sure to replace the WorkingDirectory with the location of thegumband-os-monitor-macos-arm64
file):
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE plist PUBLIC "-//Apple Computer//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> <plist version="1.0"> <dict> <key>Label</key> <string>com.boot.osmonitor</string> <key>ProgramArguments</key> <array><string>./gumband-os-monitor-macos-arm64</string></array> <key>RunAtLoad</key> <true/> <key>KeepAlive</key> <true/> <key>WorkingDirectory</key> <string>/my/working/directory</string> </dict> </plist>
Testing
Run the OS Monitor manually by running the
gumband-os-monitor-macos-arm64
executable:./gumband-os-monitor-macos-arm64
. It 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.
When the host machine boots up again, the OS Monitor should automatically launch and connect to Gumband.