LibreAuth Nut.exe Visit Website

Installation

Deploy LibreAuth on XAMPP, VPS, or shared hosting.

Requirements

ComponentMinimum
PHP8.1+ with pdo_mysql, openssl, sodium, json, mbstring
DatabaseMySQL 5.7+ or MariaDB 10.3+
Web serverApache + mod_rewrite (or nginx equivalent)
RedisOptional — rate limiting cache
WARN
The sodium extension is required for Ed25519 response signing. Without it, C++ clients will fail with "Missing signature headers".

Local (XAMPP)

  1. Clone or copy files to htdocs/libreauth/
  2. Copy config.example.php → config.php
  3. Copy config.local.example.php → config.local.php and set DB credentials
  4. Create MySQL database, import install/schema.sql
  5. Open http://localhost/libreauth/install/
  6. Login at /panel/ — default admin created on first install

Production

  1. Upload files to web root (exclude .git)
  2. Copy config.production.example.php → config.production.php
  3. Set site.url to your domain (HTTPS)
  4. Import schema or run /install/upgrade.php
  5. Lock down install/ — keep only upgrade.php + .installed
TIP
Use deploy/upload.bat on Windows for one-click SFTP sync. See the deploy/ folder in your installation.

Upgrading

After pulling new code, visit:

https://libreauth.nutexe.dev/install/upgrade.php

Safe to run multiple times — only adds missing columns and tables.

Verify installation

Check https://libreauth.nutexe.dev/health — expect:

{
  "db": "ok",
  "sign": "ok",
  "sign_public": "..."
}