Home automation for your house: your lights, locks, alarm panels, thermostats, media, sensors and cameras - 147 drivers built in - behind one admin page and a live dashboard that works as an app on your phone. Everything runs on your own computer: no cloud account, no subscription.
Both ways end the same: OakRS installed and running, starting with the computer. Use one of them, not both. To update later, do the same again - your login, devices and drivers stay.
The command downloads the program for your system, checks it, and sets it up as a service. Nothing to download first.
Linux and macOS (Terminal):
curl -fsSL https://goldknighttech.ca/downloads/oak/install.sh | sh
Linux asks for your sudo password and starts OakRS at boot; macOS starts it when you log in, without sudo.
Windows (right-click Start → Terminal (Admin)):
irm https://goldknighttech.ca/downloads/oak/install.ps1 | iex
Instead of Way 1 - no terminal: click your system, open the downloaded file, follow the steps.
sudo apt install ./oakrs_amd64.deb.
⬇ oakrs_amd64.deb (PC)
⬇ oakrs_arm64.deb (Raspberry Pi)
| Way 1: terminal command | Way 2: installer | |
|---|---|---|
| How | Paste one line, press Enter | Download, double-click, Next → Finish |
| Good for | Over SSH, servers, a Raspberry Pi without a screen | Anyone at the computer |
| Remove | The commands in section 5 | Like any program (Settings → Apps; sudo apt remove oak-rs) |
| Result | The same OakRS, starting with the computer, at http://<the computer's IP>:8090 | |
Where it goes. Linux: /opt/oak-rs (a system user oak-rs, systemd: systemctl status oak-rs). macOS: ~/Library/Application Support/oak-rs, started when you log in. Windows: C:\ProgramData\oak-rs, the service oak-rs, port 8090 opened in the firewall. Cameras need ffmpeg (Linux: sudo apt install ffmpeg; macOS: brew install ffmpeg).
Just the program, to run it your own way: Linux x64 · Linux arm64 · macOS Apple silicon · macOS Intel · Windows · SHA256SUMS · version …. The installers and the Windows and Raspberry Pi builds are new: tell us how they go.
Open http://<the computer's IP>:8090/admin from any browser on the same network. The first visit asks you to choose the admin's name and password - do it right away. Then add your devices in the admin page: pick a driver, give it the device's address.
Nothing comes from an app store. OakRS serves its pages:
/client - for everyday use: rooms, devices, cameras, macros, your layouts and 3D scenes./admin - for setting up: drivers and devices, the dashboard, automations, layouts.The OakRS app for Android phones and tablets (Android 8 or later): the /client page, and the intercom as a phone's own - calls ring full screen (Answer / Decline, on the lock screen too), messages arrive as notifications, the earpiece or the speaker in a call - even with the app closed, without Google services.
Open the download on the phone; if Android asks, allow installing apps from your browser. The first time, the app asks for your Oak's address - an https one for calls (as https://<code>.goldknighttech.ca/oak/client, see 4 below): Android allows the microphone only there. Calls and notifications in the app need OakRS from November 2026 or later.
iPhone / iPad: open /client in Safari → Share → Add to Home Screen, and open it from that icon from then on: full screen, like an app.
Android (without the app above): Chrome → ⋮ menu → Add to Home screen (or Install app).
Computer: Chrome or Edge show an Install icon in the address bar; or keep a bookmark.
Out of the box OakRS is on your own network, over plain http. To use it from anywhere - and for the phone app's https-only features - give it an https address. Two ways:
With a domain of your own pointing to your home (port 443 forwarded to OakRS's computer), put Caddy in front - it gets and renews the certificate by itself:
oak.example.com {
reverse_proxy 127.0.0.1:8090
}
We give your home its own address, https://<code>.goldknighttech.ca/oak/, through an encrypted tunnel (WireGuard) from your home - no port forwarding, no domain. It can carry your OakNVR too, on the same address. Only the logins you make can get in; turn on two-step login for them. Ask us for remote access with the message form.
The live page has an intercom: video or voice calls between the screens and phones in the house, and chat to everyone or one person. A phone whose page is closed is woken by a notification (Web Push) for a call or a message - no account with us or anyone else.
The Android app rings and notifies by itself (its own connection to your Oak, no Web Push); its calls still need the https address.
Browsers allow notifications and calls only on https, so use one of the two ways above. On an iPhone: iOS 16.4 or later, and OakRS opened from its Home Screen icon (not a Safari tab); then allow notifications when it asks.
Update: the same way you installed - run the command again, or download and open the new installer.
Remove - installed with Way 2: like any other program (Windows: Settings → Apps → OakRS; Linux: sudo apt remove oak-rs, or purge to delete its data too). Installed with Way 1, or a Mac (your login and devices stay for a later install):
# Linux sudo /opt/oak-rs/oak-server uninstall # macOS "$HOME/Library/Application Support/oak-rs/oak-server" uninstall # Windows (Terminal as administrator) & "C:\ProgramData\oak-rs\oak-server.exe" uninstall
More about OakRS, its drivers and how they are made: goldknighttech.ca/oak.