From 83218ba6028c697b78a5abefedec568ab30d4924 Mon Sep 17 00:00:00 2001 From: Sunil Thakare Date: Mon, 29 Jun 2026 17:44:10 +0530 Subject: [PATCH] docs: update documentation for v0.5.3 - Refresh administrator guide - Update architecture documentation - Document Registry Validator - Document Registry Repair Framework - Update backup and restore guide - Refresh CLI documentation - Update Docker deployment example - Bump version to v0.5.3 --- Cargo.lock | 2 +- Cargo.toml | 2 +- docker-compose.yml | 2 +- docs/ADMIN_GUIDE.md | 2 +- docs/ARCHITECTURE.md | 2 +- docs/BACKUP_RESTORE.md | 2 +- docs/CLI.md | 17 ++++++++++++++++- 7 files changed, 22 insertions(+), 7 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 91043a2..2f263e6 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -345,7 +345,7 @@ checksum = "1e748733b7cbc798e1434b6ac524f0c1ff2ab456fe201501e6497c8417a4fc33" [[package]] name = "bzod" -version = "0.5.2" +version = "0.5.3" dependencies = [ "argon2", "askama", diff --git a/Cargo.toml b/Cargo.toml index ead2e68..3b162bb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "bzod" description = "Self-hosted multi-user URL management, landing page and QR analytics platform" -version = "0.5.2" +version = "0.5.3" edition = "2021" license = "MIT OR Apache-2.0" repository = "https://github.com/thakares/nx9-url-shortener" diff --git a/docker-compose.yml b/docker-compose.yml index b5863fb..3a24cef 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -18,7 +18,7 @@ services: - PORT=8654 - RUST_LOG=info hostname: bzod - image: nx9-url-shortener:v0.4.0 + image: nx9-url-shortener:v0.5.3 ports: - mode: ingress target: 8654 diff --git a/docs/ADMIN_GUIDE.md b/docs/ADMIN_GUIDE.md index 2215d85..29451f1 100644 --- a/docs/ADMIN_GUIDE.md +++ b/docs/ADMIN_GUIDE.md @@ -1,6 +1,6 @@ # BZOD Administrator Guide -Version: v0.5.1 +Version: v0.5.3 --- diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 8574d31..f2f6c56 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -1,6 +1,6 @@ # BZOD Architecture Guide -Version: v0.5.1 +Version: v0.5.3 --- diff --git a/docs/BACKUP_RESTORE.md b/docs/BACKUP_RESTORE.md index 4b7e9e7..c74fb89 100644 --- a/docs/BACKUP_RESTORE.md +++ b/docs/BACKUP_RESTORE.md @@ -1,6 +1,6 @@ # Backup & Restore Guide -Version: v0.5.1 +Version: v0.5.3 Applies To: BZOD Multi-User Platform --- diff --git a/docs/CLI.md b/docs/CLI.md index 329186b..d9af8be 100644 --- a/docs/CLI.md +++ b/docs/CLI.md @@ -2,7 +2,7 @@ BZOD includes a comprehensive command-line interface for server administration, backups, migrations, diagnostics, validation, and multi-user management. -The current command list for BZOD v0.5.1 is: +The current command list for BZOD v0.5.3 is: ```text $ bzod --help @@ -30,6 +30,8 @@ Commands: list-users List all standard/system users backup-user Backup a standard user's databases to a .tar.zst package restore-user Restore a standard user's databases from a .tar.zst package + admin-migrate FUTURE: Migrate legacy admin content to a specific admin tenant database + repair Repair registry and database inconsistencies help Print this message or the help of the given subcommand(s) Options: @@ -119,6 +121,19 @@ Performs: * Database availability checks * Storage verification * System health diagnostics +* Global registry integrity validation + +## Registry Repair + +```bash +bzod repair registry --dry-run +``` + +Provides a transaction-safe repair utility for fixing global slug registry inconsistencies detected by `bzod doctor`. + +* Use `--dry-run` to preview changes safely. +* Use `--force` to execute changes and remove orphaned entries. +* Use `--slug ` to target a single missing entry. ---