Files
naxos-ui/README.md
T
2026-09-04 09:04:40 +02:00

45 lines
2.3 KiB
Markdown

# NaxOS Web Dashboard (`naxos-ui`)
[![Gitea Actions](https://git.lholz.de/naxos/naxos-ui/actions/workflows/ci.yaml/badge.svg)](https://git.lholz.de/naxos/naxos-ui/actions)
The **NaxOS Web Dashboard** is a modern, responsive, non-technical web interface for managing the NaxOS storage appliance. Built with React, TypeScript, Tailwind CSS, Lucide Icons, and embedded CNCF Perses analytics.
## Dashboard Showcase
| Overview & Telemetry | OpenZFS Storage Engine |
| :---: | :---: |
| ![Dashboard Overview](public/screenshots/dashboard-overview.png) | ![Storage Management](public/screenshots/storage-management.png) |
| **CNCF Perses Analytics** | **App Store & Runtimes** |
| ![Perses Analytics](public/screenshots/perses-analytics.png) | ![App Store](public/screenshots/app-store.png) |
| **Setup & Migration Wizard** | **File Shares Management** |
| ![Migration Wizard](public/screenshots/migration-wizard.png) | ![Shares Management](public/screenshots/shares-management.png) |
## 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
```