← Registry OS

Installation Guide

A high-level walkthrough. The downloaded bundle carries the complete step-by-step guide, a preflight check, and a guided installer.

This overview summarizes deployment. The installer bundle includes the full INSTALL.md, a preflight check, and a guided install.sh. Read the system requirements first and run the preflight until it passes.

Steps

  • Prepare the server (PHP 8.4, PostgreSQL, PowerDNS, Node, Nginx).
  • Place your license key at /etc/borglayer/license.key.
  • Create the registry and PowerDNS databases.
  • Deploy the application and install PHP dependencies.
  • Configure .env (database, TLD, nameservers).
  • Run database migrations.
  • Configure PowerDNS and publish your TLD zone.
  • Configure Nginx + TLS.
  • Enable the background scheduler.
  • Complete the first-run setup wizard in the browser.

One-line install

After your license is active, the license page shows a one-line installer that downloads the bundle, verifies its checksum, extracts it, and runs the preflight check:

curl -fsSL https://api.borglayer.com/api/registry-license/install/<token> | sudo bash

Place your license key

sudo mkdir -p /etc/borglayer
sudo nano /etc/borglayer/license.key
sudo chmod 600 /etc/borglayer/license.key

Verify it validates offline:

php license/registry-license-guard.php && echo "LICENSE OK"

First-run setup

Open your registry domain in a browser. A guided wizard confirms your license, creates the first administrator account, configures your TLD (nameservers, pricing, policy), and enables DNSSEC. The wizard locks itself once setup completes, so it cannot be re-run against a live registry.

Verify

php license/registry-license-guard.php && echo "LICENSE OK"
dig @localhost <your-tld> SOA
curl -sk https://<your-domain>/up

Upgrades

When a new version is issued you receive a new installer bundle. Back up first, extract over the app directory, run composer install --no-dev and php artisan migrate --force, then restart services. Your license key and data are unaffected.

Ready to deploy Registry OS?

Request a license