**Docs currently under construction
These are instructions on how to set up the Gumband OS Monitor on a mac host machine.
...
Download the Gumband OS Monitor
zip
file at the bottom of this page, and extract its contents. Copy its contents to a place that is unlikely to be touched.asroot
to/Library/LaunchDaemons
. You must copy them asroot
so they are owned by theroot
user, which will allow the OS Monitor to reboot the computer:Code Block sudo cp ~/Downloads/gumband-os-monitor-macos-arm64/gumband-os-monitor-macos-arm64 /Library/LaunchDaemons sudo cp ~/Downloads/gumband-os-monitor-macos-arm64/launch-os-monitor.plist /Library/LaunchDaemons
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/Library/LaunchDaemons
directory 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. Should be set to the string, "custom" # CUSTOM_IP=other.gmbnd.com <----- defines an endpoint that isn't app.gumband.com |
Give the
/Library/LaunchDaemons/gumband-os-monitor-macos-arm64
file “Full Disk Access” “Screen Recording” access under System Preferences → Security & Privacy . This is so it has permission to reboot the computer and write logs.Give thegumband-os-monitor-macos-arm64
file “Screen Recording” permission under SystemPreferences → Security & Privacy. This is so it has permission to take screenshots.Create a new Load the 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)as theroot
user:
Testing
- Run the OS Monitor manually by running
Code Block
...
<?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>
sudo launchctl load -w /Library/LaunchDaemons/launch-os-monitor.plist
Once you try to load the plist file, you’ll receive a warning that the
gumband-os-monitor-macos-arm64
executable cannot be run, because it is from an unverified developer. You will need to make an exception to allow it to run. Go to System Preferences → Security & Privacy → General and select “Allow apps downloaded from:./gumband-os-monitor-macos-arm64
. It should show as App Store and identified developers”, then click the “Open Anyway” button.
You should see the Gumband OS Monitor come online in the Gumband UI:
...
Testing
Check that taking screenshots is functioningthe screenshot functionality is working. Click the "Take Screenshot" button on the "Control" tab in Gumband. It should upload a screenshot one or more screenshots to the "Files" tab depending on how many monitors are connected to the computer.
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.
Troubleshooting
Expand | ||
---|---|---|
| ||
Ensure that the plist file is located in |
Expand | ||
---|---|---|
| ||
FireVault prevents the operating system from starting before a user logs in. To start the OS Monitor before login, you’ll need to disable FireVault. |
Expand | ||
---|---|---|
| ||
Run
|
Expand | ||
---|---|---|
| ||
This is because the OS Monitor needs “Screen Recording” permissions. See installation instructions above. |
Expand | ||
---|---|---|
| ||
This is because the OS Monitor is not being run as the |
Zip Download
View file | ||
---|---|---|
|