OryxPi
Brought to you by OSIBytes Group LLC

Self-hosted · Raspberry Pi

Install on a Pi

Summary of the INSTALL.md shipped inside OryxPi_Deploy.zip. Download the zip first, then follow these steps on Raspberry Pi OS.

What you get

  • Flask door controller (door_controller.py) on port 5001
  • Sample SQLite database with demo users and doors
  • systemd unit access-control.service
  • Optional nginx sample reverse-proxy config

Requirements

  • Raspberry Pi OS (Bookworm or later recommended)
  • Root/sudo access
  • Packages: python3, python3-pip, python3-venv, sqlite3, rsync, openssl
  • GPIO library gpiod (may be skipped on non-Pi hardware; web UI still runs)

Automated install

From the extracted OryxPi_Deploy folder:

sudo bash install.sh

This will:

  1. Copy files to /opt/access_control
  2. Generate fresh .secret and .api_token
  3. Create a Python venv and install Flask / Werkzeug / gpiod
  4. Install and enable access-control.service

First login checklist

  1. Open http://<pi-ip>:5001/
  2. Sign in as admin / sample password from the zip README
  3. Immediately change all three sample passwords (Users page)
  4. Rename/remap sample doors to your GPIO pins
  5. Optional: enable the nginx sample with TLS

Sample credentials ship only for first boot — change them before exposing the Pi on any network.

Roles

  • admin — full configuration
  • Standard — day-to-day control
  • Open 10s — timed unlock only

Site lock still allows Open 10s; admin lockdown blocks Open 10s. Logs: journalctl -u access-control -f

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

Brought to you by OSIBytes Group LLC · Hosted on BuildOryx · © 2026