Get started
FAQ
Short answers to what people ask first. Each one points at the page that has the detail.
What is gunkslab Desk?
Fleet software for small ESP32 robots. It has a message broker, simulated bots, a station that runs the fleet, and a page in your browser to watch and drive from. Desk is the version that runs on your own computer. Start with the quickstart.
What does it cost?
Desk is free. gunkslab Lab, for real bots on a school’s or lab’s network, is planned and would be sold per site. That is all that’s decided.
What does it run on?
Your own computer, in containers. You need one container runtime and nothing else. Install covers it:
- macOS 26 or later on Apple silicon, with Apple’s
containeror Docker Desktop. - Ubuntu 24.04 with Docker or podman, and Rocky Linux 9 with podman.
- Debian 12 with podman, and Windows 11 with Docker Desktop on WSL2.
Windows 11 and Debian haven’t been run yet. See Known issues.
Do I need a robot?
No. Simulated bots stand in for real ones and talk the same way. ./gunkslab up starts two of them, and you drive
one from your browser.
Which robots does it work with?
Two have firmware, written and tested in CI: gl_zero, a small desk bot, and Pirate Stage, a bigger desk car. Neither has driven on a finished car yet. gl_zero is still being designed and Pirate Stage isn’t built. Your own ESP32 bot can use the same protocol. See Robots.
Is my data sent anywhere?
The quickstart keeps everything on your machine. It listens on 127.0.0.1 only, with no login. Bench mode opens the broker to your local network, for real bots, with logins. That is your network, not the internet. Nothing in Desk checks for updates for you. How it’s secured lists every way in.
Is it safe to put real bots on a table?
Read the safety sheet first. It fits on one page.
How do I get the code?
It’s in early access. Ask in the issue tracker with a free GitLab account, and tick Turn on confidentiality. Install has the steps.
Something doesn’t work. What do I do?
Run ./gunkslab doctor, then ./gunkslab down && ./gunkslab up. Then read Troubleshooting
and Known issues. If it’s still wrong, open an issue at
gitlab.com/gunkslab/desk-issues. Nobody promises how soon it’s
answered.
How do I report a security problem?
As a confidential issue in the same tracker. Tick Turn on confidentiality before you create it. Keep it private until it’s fixed, or for 90 days, whichever comes first. See SECURITY.md.
What’s the licence?
Apache 2.0, in the LICENSE file at the top of the repo. You can use it, change it and build on it, for anything,
and you don’t have to share what you make. If you do pass a copy on, keep the licence and the NOTICE file with it,
and mark the files you changed. The names gunkslab, Pirate Stage and
MI-1 aren’t licensed with it: you can say your work is built with gunkslab, but don’t call your own copy gunkslab.
How do I find out when a release is out?
Release notes lists the latest version, and has a link to the mailing list.