61 lines
3.0 KiB
Markdown
61 lines
3.0 KiB
Markdown
<p align="center">
|
|
<img src="public/logo.svg" alt="NaxOS Logo" width="140" height="140" />
|
|
</p>
|
|
|
|
<h1 align="center">NaxOS Web Dashboard</h1>
|
|
|
|
<p align="center">
|
|
<b>Modern, Responsive Web Interface for NaxOS Storage Appliance (NixOS 26.05 & OpenZFS)</b>
|
|
<br />
|
|
Built with React 18, TypeScript, Tailwind CSS, Lucide Icons, and Embedded CNCF Perses Analytics
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://git.lholz.de/naxos/naxos-ui/actions"><img src="https://git.lholz.de/naxos/naxos-ui/actions/workflows/ci.yaml/badge.svg" alt="Gitea Actions" /></a>
|
|
<a href="https://git.lholz.de/naxos/-/packages"><img src="https://img.shields.io/badge/package-gitea%20registry-blue.svg" alt="Gitea Packages" /></a>
|
|
<a href="https://git.lholz.de/naxos/naxos-ui"><img src="https://img.shields.io/badge/nixos-26.05-5277C3.svg?logo=nixos&logoColor=white" alt="NixOS 26.05" /></a>
|
|
</p>
|
|
|
|
---
|
|
|
|
The **NaxOS Web Dashboard** is a modern, responsive, non-technical web interface for managing the NaxOS storage appliance running on NixOS 26.05. Built with React, TypeScript, Tailwind CSS, Lucide Icons, and embedded CNCF Perses analytics.
|
|
|
|
## Dashboard Showcase
|
|
|
|
| Overview & Telemetry | OpenZFS Storage Engine |
|
|
| :---: | :---: |
|
|
|  |  |
|
|
| **CNCF Perses Analytics** | **App Store & Runtimes** |
|
|
|  |  |
|
|
| **Setup & Migration Wizard** | **File Shares Management** |
|
|
|  |  |
|
|
|
|
## Key Features
|
|
|
|
- **Intuitive Storage Management**:
|
|
- Visual OpenZFS pool topology and dataset browser
|
|
- Zero-data-loss **Foreign Pool Migration Wizard** (safe adoption of TrueNAS and raw NixOS setups like `nixos-lukas`, preserving Immich photo libraries)
|
|
- Snapshot timeline viewer and 1-click dataset rollback
|
|
- **Multi-Protocol Sharing**:
|
|
- Samba (SMB) management with macOS Time Machine integration (`vfs_fruit`) and custom backup quotas
|
|
- High-performance NFS export configurations with CIDR security filters
|
|
- **App Store & Service Runtime**:
|
|
- Curated catalog for self-hosted apps (Immich, Nextcloud, Jellyfin, Paperless-ngx, Vaultwarden, Home Assistant)
|
|
- Tri-tier runtime selector: Native Systemd (bare metal GPU acceleration), Rootless Docker Compose, or K3s
|
|
- **Embedded CNCF Perses Analytics**:
|
|
- Native dashboards replacing standalone Grafana for real-time ZFS ARC hit ratios, IOPS, pool throughput, and thermals
|
|
- **GitOps Management & Safe Rebuild**:
|
|
- Live commit audit trail with 1-click rollback
|
|
- Real-time streaming terminal modal during `nixos-rebuild switch`
|
|
- **Live Diagnostics**:
|
|
- Real-time journald log viewer with severity filtering and search
|
|
- **Onboarding Setup Wizard**:
|
|
- Streamlined 4-step wizard guiding new installations
|
|
|
|
## Development
|
|
|
|
```bash
|
|
npm install
|
|
npm run dev
|
|
npm run build
|
|
``` |