OakRS is a JSON manifest format, a sandbox for JavaScript drivers, and the server that hosts them โ lights, thermostats, alarms, media, sensors, cameras โ behind one dashboard you control end to end, all in a single program for Linux, macOS and Windows. No vendor cloud, no subscription, nothing else to install.
# macOS and Linux: downloads oak-server, checks it, and starts it as a service curl -fsSL https://goldknighttech.ca/downloads/oak/install.sh | sh
No framework to learn beyond JSON and plain JavaScript. Each layer has one job and stays out of the others' way.
A JSON file describes a device integration โ its actions, states, roles (on/off/level/arm), and transport (TCP, HTTP, MQTT). No code required to declare what a driver can do.
Driver code runs in its own JavaScript sandbox (QuickJS, inside the one program), wired to a real TCP Connection or HttpClient depending on the manifest. One misbehaving driver can't take down the host.
Hosts every driver instance behind one REST + WebSocket API, and serves the admin panel, live dashboard, 3D scenes, and Layout builder that sit on top of it.
Not just a driver runtime โ a full admin + live control surface, built and battle-tested against real hardware.
Name a device once ("kitchen light"), pick its On/Off/Level functions from any driver instance, and it shows up everywhere โ Live, Layout, 3D โ automatically in sync.
Light, Switch, Climate, Security, Media, Sensor and Generic ship built in โ add your own categories alongside them and reorder the whole list to match how you think about your home.
Upload a .glb model of a room, bind meshes to devices, and watch doors swing, blinds roll, and lights glow in real time as the underlying device state changes.
A drag-and-drop, 12-column dashboard editor for building a custom page per room or per user, mixing device tiles, cameras, macros, and links โ or drag a device straight onto a 3D scene to bind it to that mesh, no separate step.
Speak a device's name and Live resolves it to the right zone on the right hub, even when several devices share one physical instance.
Chain actions across drivers into one macro, and trigger them on schedules, sunrise/sunset, or conditions โ no code, configured entirely from the admin panel.
RTSP feeds transcoded through ffmpeg to browser-native WebSocket/MSE โ no plugin, verified against real IP cameras.
Every driver instance is isolated in its own JS context with its own error boundary โ a crash in one driver never takes the orchestrator down.
Video and voice calls and chat between the screens and phones in the house; a phone whose page is closed is woken by a notification (Web Push) - no account with anyone.
Chosen on the first visit; two-step login with an authenticator app, and a lockout after wrong passwords - safe to reach from outside the house.
Covering security panels, hubs, Zigbee/Z-Wave/Tuya ecosystems, lighting, media, cameras, climate, and notifications โ plus a generic HTTP webhook driver for anything not on this list yet.
OakRS is one program, oak-server, with the 147 drivers, the pages and the login built in. Either way below sets it up as a service - started with the computer, restarted if it stops. Use one of them, not both. Then open http://<the computer's IP>:8090/admin: the first visit asks you to choose the admin's name and password.
macOS and Linux (including Raspberry Pi), in Terminal - Linux asks for your sudo password and starts OakRS at boot; macOS starts it when you log in:
curl -fsSL https://goldknighttech.ca/downloads/oak/install.sh | sh
Windows, in Terminal (Admin) - the service "oak-rs", started at boot, let through the firewall:
irm https://goldknighttech.ca/downloads/oak/install.ps1 | iex
No terminal: OakRS-Setup.exe (Windows) · OakRS.pkg (macOS) · oakrs_amd64.deb / oakrs_arm64.deb (Ubuntu, Debian, Raspberry Pi OS). Which one, and what each does: the download page.
http://<machine-ip>:8090/admin # drivers, devices, dashboard, layouts, automations http://<machine-ip>:8090/client # every day: rooms, devices, cameras, intercom - an app on a phone
To update, do the same again - your login, devices and drivers stay.
Removes the service and the built-in drivers; your login and devices stay for a later install, and drivers you changed are kept. --purge removes everything. (Installed with an installer: like any other program.)
"~/Library/Application Support/oak-rs/oak-server" uninstall # macOS sudo /opt/oak-rs/oak-server uninstall # Linux & "C:\ProgramData\oak-rs\oak-server.exe" uninstall # Windows, as Administrator
The installer only exposes OakRS on your local network, over plain HTTP. To reach it from outside โ with a real domain and a certificate โ put a reverse proxy in front. Caddy is the easiest option: it requests and renews Let's Encrypt certificates automatically.
# /etc/caddy/Caddyfile your-domain.com { reverse_proxy localhost:8090 }
That's the entire config. Point your domain's DNS A record at the
server's public IP, install Caddy, drop the block above into
/etc/caddy/Caddyfile, then:
sudo systemctl reload caddy
Caddy handles the certificate on first request โ no manual renewal, no
separate certbot step. If you want the dashboard
password-protected too, add a basic_auth directive โ
just remember to exclude the /ws path, since browsers
don't reliably send cached Basic Auth credentials on WebSocket
upgrade requests. OakRS's own login (with two-step login) is usually enough.
No domain of your own? We give your home an address,
https://<code>.goldknighttech.ca/oak/, through an encrypted tunnel -
no port forwarding; ask us for remote access.