diff --git a/README.md b/README.md index 17d55ec..ba106b6 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,32 @@ Welcome to the comprehensive documentation repository for **NaxOS**, the declarative, appliance-like Network Attached Storage (NAS) operating system built on NixOS and OpenZFS. +--- + +## Visual Tour & Web Dashboard Showcase + +### 1. Dashboard Overview +Sleek glassmorphism interface featuring circular storage capacity gauges, real-time ZFS ARC cache telemetry, active workloads, and safe declarative system rebuild triggers. + +![NaxOS Dashboard Overview](docs/images/dashboard-overview.jpg) + +### 2. OpenZFS Storage Management & Foreign Pool Migration Wizard +Declarative OpenZFS pool topology browser, dataset quota manager, snapshot timeline rollback, and the zero-data-loss **Foreign Pool Migration Wizard** (safely importing TrueNAS or `nixos-lukas` pools while preserving Immich photo libraries in `tank/media/photos`). + +![NaxOS Storage Management](docs/images/storage-management.jpg) + +### 3. Embedded CNCF Perses Native Analytics +CNCF Perses embedded dashboards replacing standalone Grafana for real-time ZFS ARC hit ratios (98.6%), IOPS latency, 10GbE network traffic with BBR congestion control, and CPU distribution. + +![NaxOS Perses Analytics](docs/images/perses-analytics.jpg) + +### 4. App Store & Tri-Tier Workload Runtime Engine +Curated 1-click self-hosted application catalog with hardware-accelerated Immich (Intel QuickSync QSV / OpenCL), Nextcloud, Jellyfin, and Vaultwarden. Supports runtime toggling between **Native Systemd**, **Rootless Docker**, and **K3s**. + +![NaxOS App Store](docs/images/app-store.jpg) + +--- + ## Table of Contents ### 1. Architecture & Internals @@ -25,9 +51,9 @@ Welcome to the comprehensive documentation repository for **NaxOS**, the declara ## Ecosystem Repositories (`naxos` Organization) -| Repository | Description | -| :--- | :--- | -| [`naxos-os`](https://git.lholz.de/naxos/naxos-os) | Core NixOS distribution, declarative modules, Flake, and ISO builder | -| [`naxos-api`](https://git.lholz.de/naxos/naxos-api) | Management Daemon, REST/WebSocket API, GitOps synchronization, ZFS engine | -| [`naxos-ui`](https://git.lholz.de/naxos/naxos-ui) | Modern web dashboard, embedded Perses metrics, pool manager, app store | -| [`naxos-docs`](https://git.lholz.de/naxos/naxos-docs) | System architecture, migration tutorials, developer guides, and API specs | \ No newline at end of file +| Repository | Description | Gitea URL | +| :--- | :--- | :--- | +| [`naxos-os`](https://git.lholz.de/naxos/naxos-os) | Core NixOS distribution, declarative modules, Flake, and ISO builder | [git.lholz.de/naxos/naxos-os](https://git.lholz.de/naxos/naxos-os) | +| [`naxos-api`](https://git.lholz.de/naxos/naxos-api) | Management Daemon, REST/WebSocket API, GitOps synchronization, ZFS engine | [git.lholz.de/naxos/naxos-api](https://git.lholz.de/naxos/naxos-api) | +| [`naxos-ui`](https://git.lholz.de/naxos/naxos-ui) | Modern web dashboard, embedded Perses metrics, pool manager, app store | [git.lholz.de/naxos/naxos-ui](https://git.lholz.de/naxos/naxos-ui) | +| [`naxos-docs`](https://git.lholz.de/naxos/naxos-docs) | System architecture, migration tutorials, developer guides, and API specs | [git.lholz.de/naxos/naxos-docs](https://git.lholz.de/naxos/naxos-docs) | \ No newline at end of file diff --git a/docs/architecture/app-engine.md b/docs/architecture/app-engine.md index dfb8074..1c644fa 100644 --- a/docs/architecture/app-engine.md +++ b/docs/architecture/app-engine.md @@ -2,6 +2,8 @@ NaxOS features a tri-tier runtime engine that selects the best execution strategy for each application: +![NaxOS App Store & Workload Runtimes](../images/app-store.jpg) + ## 1. Native NixOS Systemd Services - **Best For**: High-throughput services requiring direct hardware device passthrough, minimal RAM overhead, and deep integration with OpenZFS. - **Example**: **Immich** Photo Hub. diff --git a/docs/architecture/overview.md b/docs/architecture/overview.md index ce6ee3c..13418ea 100644 --- a/docs/architecture/overview.md +++ b/docs/architecture/overview.md @@ -13,6 +13,8 @@ NaxOS introduces an opinionated, cloud-native paradigm: 4. **Data Safety First**: Existing OpenZFS pools from legacy systems (such as `nixos-lukas` or TrueNAS) are imported read-safe without formatting, preserving critical application storage such as Immich photo libraries. 5. **Modern Native Observability**: Replaces heavy standalone Grafana instances with embedded CNCF **Perses** dashboards that render natively inside the web UI. +![NaxOS Web Dashboard Overview](../images/dashboard-overview.jpg) + --- ## Architectural Subsystems diff --git a/docs/architecture/perses-analytics.md b/docs/architecture/perses-analytics.md index 1d42e2d..33b1f9e 100644 --- a/docs/architecture/perses-analytics.md +++ b/docs/architecture/perses-analytics.md @@ -14,3 +14,5 @@ NaxOS takes a pioneering approach by integrating **Perses** (a Cloud Native Comp - Eliminates Grafana's multi-megabyte bundle overhead, auth barriers, and database schema migrations. 3. **Optimized for OpenZFS Metrics**: - Out-of-the-box panels monitor OpenZFS ARC hits, misses, ARC target sizing, IOPS, and disk latencies scraped from Prometheus and Node Exporter. + +![Embedded CNCF Perses Analytics](../images/perses-analytics.jpg) diff --git a/docs/architecture/storage-engine.md b/docs/architecture/storage-engine.md index b8ae6cc..a09ff27 100644 --- a/docs/architecture/storage-engine.md +++ b/docs/architecture/storage-engine.md @@ -4,6 +4,8 @@ NaxOS leverages upstream OpenZFS on Linux with specific architectural choices optimized for mixed workloads (streaming media, small-file databases, photo indexing, and Apple Time Machine backups). +![NaxOS OpenZFS Storage Management](../images/storage-management.jpg) + ### 1. Default Pool Parameters When creating pools through NaxOS, the engine enforces optimal pool attributes: - `ashift=12`: 4096-byte sector alignment to eliminate write amplification on modern Advanced Format HDDs and NVMe SSDs. diff --git a/docs/guides/migration-from-nixos-lukas.md b/docs/guides/migration-from-nixos-lukas.md index 83abbe0..9809b97 100644 --- a/docs/guides/migration-from-nixos-lukas.md +++ b/docs/guides/migration-from-nixos-lukas.md @@ -60,6 +60,8 @@ Before shutting down or booting the NaxOS installer on the NAS machine: - `-N` imports the pool **without mounting**, allowing NaxOS to audit and map dataset mountpoints safely. 6. The pool and all sub-datasets (`tank/media/photos`, `tank/backup`, etc.) will appear under **Active Datasets**. +![NaxOS Pool Migration Wizard and Dataset Browser](../images/storage-management.jpg) + --- ## 4. Automatic Declarative Configuration diff --git a/docs/images/app-store.jpg b/docs/images/app-store.jpg new file mode 100644 index 0000000..579e5e4 Binary files /dev/null and b/docs/images/app-store.jpg differ diff --git a/docs/images/dashboard-overview.jpg b/docs/images/dashboard-overview.jpg new file mode 100644 index 0000000..6a78b4e Binary files /dev/null and b/docs/images/dashboard-overview.jpg differ diff --git a/docs/images/perses-analytics.jpg b/docs/images/perses-analytics.jpg new file mode 100644 index 0000000..a50311f Binary files /dev/null and b/docs/images/perses-analytics.jpg differ diff --git a/docs/images/storage-management.jpg b/docs/images/storage-management.jpg new file mode 100644 index 0000000..c3fdb4e Binary files /dev/null and b/docs/images/storage-management.jpg differ