# NaxOS Documentation (`naxos-docs`)

[![Documentation Validation](https://git.lholz.de/naxos/naxos-docs/actions/workflows/ci.yaml/badge.svg)](https://git.lholz.de/naxos/naxos-docs/actions)

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
- [High-Level Architecture & Philosophy](docs/architecture/overview.md)
- [Declarative Backend & GitOps Engine](docs/architecture/declarative-backend.md)
- [OpenZFS Storage Engine & Pool Migration](docs/architecture/storage-engine.md)
- [Workload App Engine & Tri-Tier Runtimes](docs/architecture/app-engine.md)
- [CNCF Perses Native Observability](docs/architecture/perses-analytics.md)

### 2. User & Administrator Guides
- [Installation & Live ISO Guide](docs/guides/installation.md)
- [Migration Guide: Transitioning from `nixos-lukas` to NaxOS](docs/guides/migration-from-nixos-lukas.md)

### 3. Developer Manual
- [Management Daemon REST & WebSocket API Reference](docs/development/api-reference.md)
- [Contributing & Development Workflow](docs/development/contributing.md)

---

## Ecosystem Repositories (`naxos` Organization)

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