⚖

Gold Knight Tech

Home automation · Runs on your own computer

OakRS Home Automation

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.

147 driversBuilt in, editable
Linux · macOS · WindowsRaspberry Pi too
One fileNothing else to install

1What it does

2Install - choose one of two ways

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.

Way 1 · One command in a terminal

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

Way 2 · Download the installer and double-click it

Instead of Way 1 - no terminal: click your system, open the downloaded file, follow the steps.

🪟 Windows

Windows 10/11, x64. Windows may say "Windows protected your PC": click More info → Run anyway (the installer isn't signed yet). ⬇ OakRS-Setup.exe

 macOS

macOS 11+, Apple silicon and Intel. If macOS won't open it: System Settings → Privacy & Security → Open Anyway (not signed yet). ⬇ OakRS.pkg

🐧 Linux

Ubuntu 20.04+, Debian 10+, Raspberry Pi OS (64-bit). Open it with Software Install, or sudo apt install ./oakrs_amd64.deb. ⬇ oakrs_amd64.deb (PC) ⬇ oakrs_arm64.deb (Raspberry Pi)

Which one?

Way 1: terminal commandWay 2: installer
HowPaste one line, press EnterDownload, double-click, Next → Finish
Good forOver SSH, servers, a Raspberry Pi without a screenAnyone at the computer
RemoveThe commands in section 5Like any program (Settings → Apps; sudo apt remove oak-rs)
ResultThe 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.

Then

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.

3The app: Android, a browser, or on the Home Screen

Nothing comes from an app store. OakRS serves its pages:

Android app

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.

⬇ OakRS.apk (Android)

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.

As an app on a phone, from the page

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.

4From outside the house, notifications: https

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:

A. Your own https

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
}

B. Through goldknighttech.ca

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.

Intercom and notifications

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.

5Update and remove

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.