naxos/naxos-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: enrich documentation and README with high-resolution application screenshots
Validate Documentation / lint-docs (push) Successful in 8s
Details

Browse Source
This commit is contained in:
Lukas Holzner
2026-09-04 07:34:27 +02:00
parent ce7c125391
commit fcb92b0688
10 changed files with 42 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+32 -6
View File
@@ -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 |
| 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) |