Setup & usage guides

QUICKSTART WIZARD

Zero to sealed in three moves

The fast path for engineers who read manuals last. Every block below is copy-ready; the full walkthroughs live in the setup guide.

1. Identify your PHP build

   ozguard ships one binary per PHP flavor. This one-liner prints the version, thread-safety and architecture you must match:

   Linux · bashWindows · PowerShellCopy

   Linux · bash

   php -v
   php -r "echo (PHP_ZTS ? 'TS' : 'NTS') . ' ' . (PHP_INT_SIZE === 8 ? 'x64' : 'x86') . PHP_EOL;"

   Windows · PowerShell

   php -v
   php -r "echo (PHP_ZTS ? 'TS' : 'NTS') . ' ' . (PHP_INT_SIZE === 8 ? 'x64' : 'x86') . PHP_EOL;"

2. Register ozguard with PHP

   Drop the extension file into PHP’s extension directory and point php.ini at it. Pick the tab that matches your platform:

   Linux · bashWindows · PowerShellphp.iniDockerfileCopy

   Linux · bash

   sudo cp ozguard.so "$(php -i | awk -F'=> ' '/extension_dir/{print $2}')/"
   echo "extension = ozguard.so" | sudo tee /etc/php/8.3/mods-available/ozguard.ini
   sudo phpenmod ozguard && sudo systemctl restart php8.3-fpm

   Windows · PowerShell

   Copy-Item .\ozguard.dll "C:\AppServ\php8\ext\"
   Add-Content "C:\AppServ\php8\php.ini" "`nextension = \"C:\AppServ\php8\ext\ozguard.dll\""
   httpd -k restart   # Apache — or: iisreset

   php.ini

   ; php.ini — enable the OnionZero runtime
   extension = ozguard.so
   
   ; Vendor public key is embedded in the extension — nothing else to set

   Dockerfile

   FROM php:8.3-fpm
   COPY ozguard.so /usr/local/lib/php/extensions/
   RUN echo "extension = ozguard.so" \
     > /usr/local/etc/php/conf.d/ozguard.ini

3. Verify the load

   The module list must contain an ozguard line — that is PHP confirming the vault is armed:

   Linux · bashWindows · PowerShellCopy

   Linux · bash

   php -m | grep ozguard

   Windows · PowerShell

   php -m | findstr ozguard

Requirements at a glance

Keep reading