Release v0.7.0 documentation and version update
This commit is contained in:
thakares committed
1 parent
b66703082f
commit
2cd3c2d965
17 files changed
+146
-35
No files matched your search
Generated
+1
-1
@@ -345,7 +345,7 @@ checksum = "1e748733b7cbc798e1434b6ac524f0c1ff2ab456fe201501e6497c8417a4fc33"
|
||||
|
||||
[[package]]
|
||||
name = "bzod"
|
||||
version = "0.6.0"
|
||||
version = "0.7.0"
|
||||
dependencies = [
|
||||
"argon2",
|
||||
"askama",
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
[package]
|
||||
name = "bzod"
|
||||
description = "Self-hosted multi-user URL management, landing page and QR analytics platform"
|
||||
version = "0.6.0"
|
||||
version = "0.7.0"
|
||||
edition = "2021"
|
||||
license = "MIT OR Apache-2.0"
|
||||
repository = "https://github.com/thakares/nx9-url-shortener"
|
||||
|
||||
@@ -6,7 +6,7 @@
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
[](https://github.com/thakares/bzod)
|
||||
[](https://codeberg.org/thakares/bzod)
|
||||
@@ -35,6 +35,8 @@ Core capabilities include:
|
||||
- Multi-User Platform
|
||||
- REST API
|
||||
- Role-Based Access Control (RBAC)
|
||||
- Responsive UI (Desktop, Tablet, Mobile)
|
||||
- Dark/Light Theme Support
|
||||
- Global Namespace Registry
|
||||
- Registry Validation
|
||||
- Transaction-safe Registry Repair
|
||||
@@ -44,6 +46,7 @@ Core capabilities include:
|
||||
- User Backup & Restore
|
||||
- Disaster Recovery
|
||||
- Upgrade Validation
|
||||
- Build Metadata (Version & Git Commit)
|
||||
- Single Binary Deployment
|
||||
|
||||
The result is a platform that is easy to deploy, lightweight to operate, and entirely controlled by its owner.
|
||||
@@ -90,7 +93,7 @@ No recurring subscription fees.
|
||||
|
||||
---
|
||||
|
||||
## Runtime Efficiency (v0.6.0)
|
||||
## Runtime Efficiency (v0.7.0)
|
||||
|
||||
| Metric | Value |
|
||||
|---------|------:|
|
||||
@@ -1135,16 +1138,37 @@ Highlights include:
|
||||
- Upgrade Validation
|
||||
- Backup Manifest
|
||||
- Transaction-safe Maintenance
|
||||
- Modular Admin Architecture (v0.6.0)
|
||||
- Redirect Handler Hardening (v0.6.0)
|
||||
- Modular Admin Architecture (v0.5.3)
|
||||
- Redirect Handler Hardening (v0.5.3)
|
||||
|
||||
---
|
||||
|
||||
### v0.6
|
||||
|
||||
- Legacy Backup Restore Compatibility
|
||||
- CLI Version Reporting (`--version` / `-V`)
|
||||
- Deploy Script Modernization
|
||||
|
||||
---
|
||||
|
||||
### v0.7
|
||||
|
||||
Responsive UI and theme refactor.
|
||||
|
||||
Highlights include:
|
||||
|
||||
- Responsive Admin & User Registry Panels
|
||||
- Desktop, Laptop, Tablet, and Mobile Layouts
|
||||
- Dark/Light Theme Support with Persistence
|
||||
- Table-to-Card Responsive Behavior
|
||||
- Build Metadata (Version & Git Commit)
|
||||
- Root Landing Page Runtime/Embedded Fallback
|
||||
|
||||
---
|
||||
|
||||
# Future Roadmap
|
||||
|
||||
## v0.6
|
||||
|
||||
Planned features include:
|
||||
Planned features and improvements:
|
||||
|
||||
- Webhooks
|
||||
- OpenAPI Documentation
|
||||
@@ -1155,13 +1179,6 @@ Planned features include:
|
||||
- Bulk Export
|
||||
- Custom Domains
|
||||
- Better QR Styling
|
||||
|
||||
---
|
||||
|
||||
## v0.7
|
||||
|
||||
Planned improvements:
|
||||
|
||||
- Email Notifications
|
||||
- Team Workspaces
|
||||
- Shared Projects
|
||||
@@ -1320,7 +1337,7 @@ Community feedback helps guide future development.
|
||||
|
||||
**Current Version**
|
||||
|
||||
**v0.5.3**
|
||||
**v0.7.0**
|
||||
|
||||
Production Ready
|
||||
|
||||
@@ -1336,12 +1353,15 @@ Production Ready
|
||||
- ✅ Analytics
|
||||
- ✅ REST API
|
||||
- ✅ Role-Based Access Control
|
||||
- ✅ Responsive UI (Desktop, Tablet, Mobile)
|
||||
- ✅ Dark/Light Theme Support
|
||||
- ✅ Registry Validator
|
||||
- ✅ Registry Repair Framework
|
||||
- ✅ Health Diagnostics
|
||||
- ✅ Backup & Restore
|
||||
- ✅ Disaster Recovery
|
||||
- ✅ Upgrade Validation
|
||||
- ✅ Build Metadata (Version & Git Commit)
|
||||
- ✅ Extensive Automated Test Suite
|
||||
|
||||
---
|
||||
|
||||
@@ -4,7 +4,7 @@
|
||||
|
||||
set -euo pipefail
|
||||
|
||||
BZOD_VERSION="0.6.0"
|
||||
BZOD_VERSION="0.7.0"
|
||||
|
||||
SERVICE_USER="bzod"
|
||||
INSTALL_PATH="/usr/local/bin/bzod"
|
||||
|
||||
+1
-1
@@ -18,7 +18,7 @@ services:
|
||||
- PORT=8654
|
||||
- RUST_LOG=info
|
||||
hostname: bzod
|
||||
image: nx9-url-shortener:v0.6.0
|
||||
image: nx9-url-shortener:v0.7.0
|
||||
ports:
|
||||
- mode: ingress
|
||||
target: 8654
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
# BZOD Administrator Guide
|
||||
|
||||
Version: v0.6.0
|
||||
Version: v0.7.0
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# BZOD Architecture Guide
|
||||
|
||||
Version: v0.6.0
|
||||
Version: v0.7.0
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Backup & Restore Guide
|
||||
|
||||
Version: v0.6.0
|
||||
Version: v0.7.0
|
||||
Applies To: BZOD Multi-User Platform
|
||||
|
||||
---
|
||||
|
||||
@@ -6,6 +6,51 @@ The format is based on Keep a Changelog and this project follows Semantic Versio
|
||||
|
||||
---
|
||||
|
||||
# v0.7.0 — Responsive UI, Theme Support & Build Metadata
|
||||
|
||||
## Added
|
||||
|
||||
### Responsive UI
|
||||
|
||||
* Responsive layouts for admin and user URL registry panels
|
||||
* Responsive layouts for admin and user landing page registry panels
|
||||
* Desktop, laptop, tablet, and mobile layout support
|
||||
* Table-to-card responsive behavior for registry panels
|
||||
* Resolved horizontal scrolling issues in registry panels
|
||||
|
||||
### Theme Support
|
||||
|
||||
* Dark/light theme toggle
|
||||
* Theme persistence across sessions
|
||||
* Responsive theme behavior across device sizes
|
||||
|
||||
### Build Metadata
|
||||
|
||||
* Introduced `build.rs` build script for compile-time metadata
|
||||
* Introduced `src/build_info.rs` module exposing `APP_VERSION` and `GIT_COMMIT`
|
||||
* Application version derived from `Cargo.toml` via `env!("CARGO_PKG_VERSION")`
|
||||
* Git commit hash (12-char short) embedded at build time via `BZOD_GIT_COMMIT`
|
||||
* Graceful fallback to `"unknown"` when Git metadata is unavailable
|
||||
|
||||
### Public Landing Page
|
||||
|
||||
* Root `/` serves `www/index.html` with runtime file and embedded fallback behavior
|
||||
* Public/runtime www assets supported by the deployment layout
|
||||
|
||||
## Changed
|
||||
|
||||
* Documentation updated to reflect v0.7.0 current state
|
||||
* Version metadata updated across Cargo.toml, deploy.sh, and docker-compose.yml
|
||||
|
||||
## Notes
|
||||
|
||||
* No API behavior changes
|
||||
* No database schema changes
|
||||
* No authentication or security behavior changes
|
||||
* Existing redirect, routing, and tenant isolation behavior preserved
|
||||
|
||||
---
|
||||
|
||||
# v0.6.0 — Legacy Restore Compatibility & Version Reporting
|
||||
|
||||
- **Legacy Backup Restore**: Full backward-compatible restore support for `legacy_flat_backup` archives into the current multi-tenant database architecture
|
||||
|
||||
+1
-1
@@ -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.6.0 is:
|
||||
The current command list for BZOD v0.7.0 is:
|
||||
|
||||
```text
|
||||
$ bzod --help
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
# BZOD v0.6.0 vs Self-Hosted URL Management Platforms
|
||||
# BZOD v0.7.0 vs Self-Hosted URL Management Platforms
|
||||
|
||||
BZOD is a modern, privacy-focused, self-hosted URL Management Platform written in Rust and developed as part of the NX9 Platform.
|
||||
|
||||
|
||||
+1
-1
@@ -2,7 +2,7 @@
|
||||
|
||||
# BZOD Database Architecture
|
||||
|
||||
BZOD v0.6.0 uses SQLite exclusively.
|
||||
BZOD v0.7.0 uses SQLite exclusively.
|
||||
|
||||
Rather than using a single monolithic database, BZOD separates data into administrative and tenant-specific databases. This architecture improves security, isolation, backup flexibility, disaster recovery, and scalability.
|
||||
|
||||
|
||||
+3
-3
@@ -1,6 +1,6 @@
|
||||
# BZOD Installation Guide
|
||||
|
||||
Version: v0.6.0
|
||||
Version: v0.7.0
|
||||
|
||||
---
|
||||
|
||||
@@ -183,13 +183,13 @@ sudo pacman -S \
|
||||
Example:
|
||||
|
||||
```bash
|
||||
wget https://example.com/bzod-v0.6.0-linux-amd64.tar.gz
|
||||
wget https://example.com/bzod-v0.7.0-linux-amd64.tar.gz
|
||||
```
|
||||
|
||||
Extract:
|
||||
|
||||
```bash
|
||||
tar -xzf bzod-v0.6.0-linux-amd64.tar.gz
|
||||
tar -xzf bzod-v0.7.0-linux-amd64.tar.gz
|
||||
```
|
||||
|
||||
Install:
|
||||
|
||||
+1
-1
@@ -1,6 +1,6 @@
|
||||
# BZOD Multi-User Architecture Guide
|
||||
|
||||
Version: v0.6.0
|
||||
Version: v0.7.0
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,3 +1,49 @@
|
||||
# BZOD v0.7.0 — Responsive UI, Theme Support & Build Metadata
|
||||
|
||||
Release Date: 2026-08-11
|
||||
|
||||
## Highlights
|
||||
|
||||
- **Responsive UI**: Admin and user registry panels (URLs and landing pages) now adapt across desktop, laptop, tablet, and mobile viewports. Tables switch to card layouts on smaller screens, and horizontal scrolling issues in registry panels have been resolved.
|
||||
|
||||
- **Dark/Light Theme Support**: A dark/light theme toggle has been implemented with theme persistence across sessions and responsive behavior across device sizes.
|
||||
|
||||
- **Build Metadata**: The application now exposes its actual Cargo package version and, when available, the Git commit hash. This is powered by `build.rs` (compile-time Git commit extraction) and `src/build_info.rs` (exposing `APP_VERSION` and `GIT_COMMIT` constants). The version is derived from `Cargo.toml` via `env!("CARGO_PKG_VERSION")`, and the Git commit hash falls back gracefully to `"unknown"` when unavailable.
|
||||
|
||||
- **Public Landing Page Serving**: Root `/` now serves the public `www/index.html` with runtime file detection and embedded fallback behavior. Public/runtime www assets are supported by the deployment layout.
|
||||
|
||||
## User-Visible Changes
|
||||
|
||||
- Admin URL registry panel is responsive across all device sizes
|
||||
- Admin landing page registry panel is responsive across all device sizes
|
||||
- User URL registry panel is responsive across all device sizes
|
||||
- User landing page registry panel is responsive across all device sizes
|
||||
- Dark/light theme toggle available in the UI
|
||||
- Theme preference persists across sessions
|
||||
- Registry tables switch to card layouts on tablet and mobile viewports
|
||||
- Horizontal scrolling eliminated from registry panels
|
||||
|
||||
## Technical Changes
|
||||
|
||||
- Introduced `build.rs` build script for compile-time metadata extraction
|
||||
- Introduced `src/build_info.rs` module with `APP_VERSION` and `GIT_COMMIT` constants
|
||||
- Version and Git commit now available to system status and admin settings endpoints
|
||||
- Root `/` serves `www/index.html` with runtime/embedded fallback
|
||||
|
||||
## Breaking Changes
|
||||
|
||||
None.
|
||||
|
||||
## Upgrade Notes
|
||||
|
||||
- Direct upgrade from v0.6.0 with no migration required
|
||||
- No database schema changes
|
||||
- No API changes
|
||||
- No configuration changes
|
||||
- No breaking changes to existing functionality
|
||||
|
||||
---
|
||||
|
||||
# BZOD v0.6.0 — Legacy Restore Compatibility & Version Reporting
|
||||
|
||||
Release Date: 2026-08-09
|
||||
|
||||
+4
-4
@@ -1,6 +1,6 @@
|
||||
# BZOD Security Guide
|
||||
|
||||
Version: v0.6.0
|
||||
Version: v0.7.0
|
||||
|
||||
---
|
||||
|
||||
@@ -16,7 +16,7 @@ BZOD is designed as a self-hosted URL shortener and landing page platform with a
|
||||
* Disaster recovery
|
||||
* Operational simplicity
|
||||
|
||||
This document describes the security architecture, threat model, authentication mechanisms, authorization controls, and operational security recommendations for BZOD v0.6.0.
|
||||
This document describes the security architecture, threat model, authentication mechanisms, authorization controls, and operational security recommendations for BZOD v0.7.0.
|
||||
|
||||
---
|
||||
|
||||
@@ -620,7 +620,7 @@ If compromise is suspected:
|
||||
|
||||
# Security Testing
|
||||
|
||||
BZOD v0.6.0 includes tests covering:
|
||||
BZOD v0.7.0 includes tests covering:
|
||||
|
||||
* Authentication
|
||||
* Authorization
|
||||
@@ -665,7 +665,7 @@ These may be addressed in future releases.
|
||||
|
||||
# Summary
|
||||
|
||||
BZOD v0.6.0 provides:
|
||||
BZOD v0.7.0 provides:
|
||||
|
||||
* Centralized authentication
|
||||
* Secure session management
|
||||
|
||||
+2
-2
@@ -1,8 +1,8 @@
|
||||
# Upgrade Guide
|
||||
|
||||
Version: v0.6.0
|
||||
Version: v0.7.0
|
||||
|
||||
This document describes the upgrade process for existing BZOD deployments upgrading to BZOD v0.5.1.
|
||||
This document describes the upgrade process for existing BZOD deployments upgrading to BZOD v0.7.0.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in new issue
Block a user