thakares/nx9-url-shortener
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update documentation for v0.5.3

Browse Source 
- 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
This commit is contained in:
thakares committed 2026-06-29 17:44:10 +05:30
1 parent 58c0af6510
commit 83218ba602
7 files changed
+22 -7
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

Cargo.lock
Generated
+1 -1
View File
@@ -345,7 +345,7 @@ checksum = "1e748733b7cbc798e1434b6ac524f0c1ff2ab456fe201501e6497c8417a4fc33"
[[package]] [[package]]
name = "bzod" name = "bzod"
version = "0.5.2" version = "0.5.3"
dependencies = [ dependencies = [
"argon2", "argon2",
"askama", "askama",
Cargo.toml
+1 -1
View File
@@ -1,7 +1,7 @@
[package] [package]
name = "bzod" name = "bzod"
description = "Self-hosted multi-user URL management, landing page and QR analytics platform" description = "Self-hosted multi-user URL management, landing page and QR analytics platform"
version = "0.5.2" version = "0.5.3"
edition = "2021" edition = "2021"
license = "MIT OR Apache-2.0" license = "MIT OR Apache-2.0"
repository = "https://github.com/thakares/nx9-url-shortener" repository = "https://github.com/thakares/nx9-url-shortener"
docker-compose.yml
+1 -1
View File
@@ -18,7 +18,7 @@ services:
- PORT=8654 - PORT=8654
- RUST_LOG=info - RUST_LOG=info
hostname: bzod hostname: bzod
image: nx9-url-shortener:v0.4.0 image: nx9-url-shortener:v0.5.3
ports: ports:
- mode: ingress - mode: ingress
target: 8654 target: 8654
docs/ADMIN_GUIDE.md
+1 -1
View File
@@ -1,6 +1,6 @@
# BZOD Administrator Guide # BZOD Administrator Guide
Version: v0.5.1 Version: v0.5.3
--- ---
docs/ARCHITECTURE.md
+1 -1
View File
@@ -1,6 +1,6 @@
# BZOD Architecture Guide # BZOD Architecture Guide
Version: v0.5.1 Version: v0.5.3
--- ---
docs/BACKUP_RESTORE.md
+1 -1
View File
@@ -1,6 +1,6 @@
# Backup & Restore Guide # Backup & Restore Guide
Version: v0.5.1 Version: v0.5.3
Applies To: BZOD Multi-User Platform Applies To: BZOD Multi-User Platform
--- ---
docs/CLI.md
+16 -1
View File
@@ -2,7 +2,7 @@
BZOD includes a comprehensive command-line interface for server administration, backups, migrations, diagnostics, validation, and multi-user management. 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 ```text
$ bzod --help $ bzod --help
@@ -30,6 +30,8 @@ Commands:
list-users List all standard/system users list-users List all standard/system users
backup-user Backup a standard user's databases to a .tar.zst package 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 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) help Print this message or the help of the given subcommand(s)
Options: Options:
@@ -119,6 +121,19 @@ Performs:
* Database availability checks * Database availability checks
* Storage verification * Storage verification
* System health diagnostics * 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 <slug>` to target a single missing entry.
--- ---