Upgrade Guide

Before Upgrading

Back up the node before changing code or dependencies. Server backups protect public node state, not user private keys. Users must keep their own wallet backups.

curl -fsS https://vorliq.org/api/version/metadata
curl -fsS https://vorliq.org/api/storage/health
curl -fsS https://vorliq.org/api/audit/manifest

Public Node Deployment

The official public node is deployed through the Vorliq Deploy GitHub Actions workflow after CI passes. It fetches the latest main branch, updates the server checkout, and restarts the managed services.

Self-Hosted Node Update

Self-hosted operators should update from their server checkout and run the repository update script when available.

cd /path/to/vorliq
git fetch origin
git checkout main
git pull --ff-only origin main
sudo bash deployment/update_server.sh

If your install path differs, adjust the working directory. Do not print admin tokens, SSH keys, private keys, or wallet passwords while updating.

Verify After Upgrade

curl -fsS https://your-node.example/api/health
curl -fsS https://your-node.example/api/version/metadata
curl -fsS https://your-node.example/api/system/self-check
curl -fsS https://your-node.example/api/storage/health
curl -fsS https://your-node.example/api/audit/manifest

Confirm the deployment commit, API version, storage health, chain validity, and audit manifest before announcing an upgrade is complete.

Database Migration Preparation

Normal upgrades must not switch production storage to PostgreSQL. PostgreSQL files are preparation-only until a future migration window is planned, rehearsed, and rollback-approved.

python tools/postgres_schema_check.py
python tools/migration_dry_run.py --output migration-dry-run-report.json
python tools/simulate_postgres_import.py --input migration-dry-run-report.json --output import-simulation.json

Do not commit real production reports. Read PostgreSQL Readiness, Database Migration Plan, and Database Rollback Plan before any future adapter work.

If Upgrade Fails

• Stop and preserve logs; do not delete public chain or state files.
• Check service status with systemd and review safe application logs.
• Verify the latest backup before restoring anything.
• Use the recovery guide if a restore is required.
• Report the failing endpoint, timestamp, commit, and request ID. Never include private keys, admin tokens, raw user agents, IP addresses, or server paths.

Compatibility

Vorliq API v1 is stable at /api/v1, and unversioned /api remains supported for now. Use API Versioning, Developer Examples, and Operator Dashboard for related guidance.