docs: enrich documentation and README with high-resolution application screenshots
Validate Documentation / lint-docs (push) Successful in 8s
Validate Documentation / lint-docs (push) Successful in 8s
This commit is contained in:
@@ -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.
|
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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### 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`).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### 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.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
### 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**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Table of Contents
|
## Table of Contents
|
||||||
|
|
||||||
### 1. Architecture & Internals
|
### 1. Architecture & Internals
|
||||||
@@ -25,9 +51,9 @@ Welcome to the comprehensive documentation repository for **NaxOS**, the declara
|
|||||||
|
|
||||||
## Ecosystem Repositories (`naxos` Organization)
|
## Ecosystem Repositories (`naxos` Organization)
|
||||||
|
|
||||||
| Repository | Description |
|
| Repository | Description | Gitea URL |
|
||||||
| :--- | :--- |
|
| :--- | :--- | :--- |
|
||||||
| [`naxos-os`](https://git.lholz.de/naxos/naxos-os) | Core NixOS distribution, declarative modules, Flake, and ISO builder |
|
| [`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 |
|
| [`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 |
|
| [`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 |
|
| [`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) |
|
||||||
@@ -2,6 +2,8 @@
|
|||||||
|
|
||||||
NaxOS features a tri-tier runtime engine that selects the best execution strategy for each application:
|
NaxOS features a tri-tier runtime engine that selects the best execution strategy for each application:
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
## 1. Native NixOS Systemd Services
|
## 1. Native NixOS Systemd Services
|
||||||
- **Best For**: High-throughput services requiring direct hardware device passthrough, minimal RAM overhead, and deep integration with OpenZFS.
|
- **Best For**: High-throughput services requiring direct hardware device passthrough, minimal RAM overhead, and deep integration with OpenZFS.
|
||||||
- **Example**: **Immich** Photo Hub.
|
- **Example**: **Immich** Photo Hub.
|
||||||
|
|||||||
@@ -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.
|
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.
|
5. **Modern Native Observability**: Replaces heavy standalone Grafana instances with embedded CNCF **Perses** dashboards that render natively inside the web UI.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Architectural Subsystems
|
## Architectural Subsystems
|
||||||
|
|||||||
@@ -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.
|
- Eliminates Grafana's multi-megabyte bundle overhead, auth barriers, and database schema migrations.
|
||||||
3. **Optimized for OpenZFS Metrics**:
|
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.
|
- Out-of-the-box panels monitor OpenZFS ARC hits, misses, ARC target sizing, IOPS, and disk latencies scraped from Prometheus and Node Exporter.
|
||||||
|
|
||||||
|

|
||||||
|
|||||||
@@ -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 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).
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
### 1. Default Pool Parameters
|
### 1. Default Pool Parameters
|
||||||
When creating pools through NaxOS, the engine enforces optimal pool attributes:
|
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.
|
- `ashift=12`: 4096-byte sector alignment to eliminate write amplification on modern Advanced Format HDDs and NVMe SSDs.
|
||||||
|
|||||||
@@ -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.
|
- `-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**.
|
6. The pool and all sub-datasets (`tank/media/photos`, `tank/backup`, etc.) will appear under **Active Datasets**.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 4. Automatic Declarative Configuration
|
## 4. Automatic Declarative Configuration
|
||||||
|
|||||||
Binary file not shown.
|
After Width: | Height: | Size: 494 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 440 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 617 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 554 KiB |
Reference in New Issue
Block a user