Self-hosted · Raspberry Pi

Install on a Pi

Q: How do I install OryxPi on a Raspberry Pi?

Download the zip, extract it, then run sudo bash install.sh on Raspberry Pi OS. The controller listens on port 5001.

Q: Are hardware kits for sale?

Yes. Pre-built OryxPi kits checkout via accounts.osibytes.com using service_key oryxpi_kit. Pi 3 HAT/I2C kits and the Pi Zero DIN-rail kit include Raspberry Pi OS preloaded; the Pico kit includes a Raspberry Pi Pico with firmware loaded. Every kit also includes a 3D-printed enclosure and a 128GB SSD; the controller, enclosure, and SSD can be upgraded at extra cost. US shipping is included. Cloud subscribe uses oryxpi_app.

Matches the INSTALL.md inside OryxPi_Deploy.zip. One install path (/opt/access_control), one port (5001). Works on Raspberry Pi OS and on any Debian/Ubuntu Linux server (no GPIO = web UI only).

What's in the zip

install.sh — one-command installer
INSTALL.md, README.md, LICENSE.txt, MODEL.json
app/: Flask door controller (door_controller.py), templates, static/, Wiegand reader service, access-control.service, nginx-oryxpi.conf.sample, requirements.txt, export.sh backup
Starter oryx.db: Door1–Door8, one schedule, 3 sample users. No customer data, SMTP or tokens.

Requirements

Raspberry Pi 3B+/4/5 with Raspberry Pi OS Bookworm (64-bit recommended), or Debian 12 / Ubuntu 22.04+
sudo access and internet (the installer runs apt and pip)
Optional: Waveshare RPi Relay Board (B), 8 channels

The installer adds python3 python3-venv python3-pip python3-dev gcc sqlite3 curl and a venv with flask, requests, gpiod 2.x (libgpiod v2 API — not RPi.GPIO).

Install

# from your computer
scp OryxPi_Deploy.zip pi@<pi-ip>:~/
# on the Pi
sudo apt install -y unzip
unzip OryxPi_Deploy.zip && cd OryxPi_Deploy
sudo ./install.sh

install.sh will:

Install the apt packages above
Copy app/ to /opt/access_control (creates static/, keeps an existing oryx.db on re-install)
Create /opt/access_control/venv with flask, requests, gpiod
Seed the email/SMTP settings row (off) and create .secret + .api_token with mode 600
Install, enable and start access-control.service listening on 0.0.0.0:5001

Options: PREFIX=, ORYX_PORT=, ORYX_BIND=127.0.0.1 (behind nginx), SKIP_APT=1, SKIP_SYSTEMD=1. Logs: journalctl -u access-control -f

First sign-in

Open http://<pi-ip>:5001/ from any device on your LAN
Sign in as admin / CHANGE_ME_ON_INSTALL (sample users manager and opener use the same password)
Immediately change all three sample passwords (Users page, and Config → Admin web password), or delete the ones you don't need
Rename doors, set REX inputs in Config, add SMTP under Alerts if you want email alerts

Sample credentials are public — change them before anyone else is on your network. Never port-forward 5001 to the internet; use the nginx sample + TLS or an OryxPi cloud tunnel for remote access.

GPIO & hardware notes

Waveshare Relay Board (B) CH1–CH8 = BCM GPIO 5, 6, 13, 16, 19, 20, 21, 26 (active-low); fire-alarm input GPIO 4
GPIO chip auto-detected: Pi 5 /dev/gpiochip4, Pi 4 and earlier /dev/gpiochip0 (override with ORYX_GPIOCHIP)
No GPIO (VM or server)? The UI, users, schedules and API still run; relays are not driven
Optional nginx reverse proxy: app/nginx-oryxpi.conf.sample

Roles

admin — System Admin, full configuration
manager — Standard User, day-to-day control (doors 1–3)
opener — Open 10s only (door 1)

Site lock still allows Open 10s; admin lockdown blocks Open 10s. Back up any time with sudo /opt/access_control/export.sh.

Professional installation

We install it for you

Full installation is available across Utah, Idaho, Nevada, Montana, Colorado, and Wyoming.

Inside 50 miles of our Bountiful, Utah office: no travel charge. Outside 50 miles: $2.00 per mile (market-aligned; quoted on the estimate).

Line item	Price
Cable pulled (per door) Conditions apply. Cabling installed by ChoiceNetworX.	$270
Mag lock system installed (per door)	$750
Motion or IR sensor (per door) Request-to-exit / presence sensing.	$210
Card reader installed (each)	$750
Change to the system (each) When additional services are required after install.	$750

Conditions apply. Taxes, permits and specialty door hardware are quoted separately.

All cabling is pulled and terminated by our ChoiceNetworX brand. Through ChoiceNetworX we can also add interconnected cameras and an intercom system alongside your OryxPi doors — priced per site on your quote.

Site walk / photos reviewed before a written estimate
Prices are per door unless noted; door hardware conditions, wall/ceiling access and existing wiring can change scope
Final price is on your written quote — accept it online and pay through OSIBytes Accounts

Request an install quote See pricing

FAQ

Is OryxPi software free?

Yes. Self-hosted OryxPi software is free. Enter your email on the free download page to get OryxPi_Deploy.zip. Optional cloud tunnels are billed separately through OSIBytes Accounts.

How do I install OryxPi on a Raspberry Pi?

Download the zip, extract it, then run sudo bash install.sh on Raspberry Pi OS. The controller listens on port 5001.

Are hardware kits for sale?

Yes — pre-built kits are listed on the homepage and checkout through OSIBytes Accounts with service key oryxpi_kit (cloud remains oryxpi_app). Pi 3 and Pi Zero models include Raspberry Pi OS preloaded; the Pico model includes loaded firmware. Every kit also includes a 3D-printed enclosure and a 128GB SSD (controller, enclosure, and SSD upgradable at extra cost). US shipping is included.

What should I do with sample passwords?

Sample Admin / Standard / Open 10s accounts ship only for first boot. Change all sample passwords before exposing the Pi on any network.

Brought to you by OSIBytes Group LLC · Hosted on BuildOryx.

Get Free Zip (email) ← Back to site