diff --git a/README.md b/README.md index 80a95ae..084e470 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,24 @@ -# NaxOS Documentation (`naxos-docs`) +

+ NaxOS Logo +

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

NaxOS Documentation

-Welcome to the comprehensive documentation repository for **NaxOS**, the declarative, appliance-like Network Attached Storage (NAS) operating system built on NixOS and OpenZFS. +

+ Comprehensive Technical Architecture & Operations Guide (NixOS 26.05 & OpenZFS) +
+ Architecture Specifications, API Reference, Migration Runbooks, and Bare-Metal Guides +

+ +

+ Documentation Validation + Gitea Packages + NixOS 26.05 +

+ +--- + +Welcome to the comprehensive documentation repository for **NaxOS**, the declarative, appliance-like Network Attached Storage (NAS) operating system built on **NixOS 26.05** and **OpenZFS**. --- diff --git a/docs/architecture/overview.md b/docs/architecture/overview.md index f1fd8df..78f92d7 100644 --- a/docs/architecture/overview.md +++ b/docs/architecture/overview.md @@ -1,8 +1,12 @@ +

+ NaxOS Logo +

+ # NaxOS Architecture Overview ## Design Philosophy -**NaxOS** is an appliance-like Network Attached Storage (NAS) operating system combining the mathematical immutability of **NixOS**, the enterprise data integrity of **OpenZFS**, and the modern observability of **CNCF Perses**. +**NaxOS** is an appliance-like Network Attached Storage (NAS) operating system combining the mathematical immutability of **NixOS 26.05**, the enterprise data integrity of **OpenZFS**, and the modern observability of **CNCF Perses**. Traditional NAS operating systems (like TrueNAS, Unraid, or Synology DSM) rely either on mutable root filesystems with hidden configuration databases, or proprietary management stacks that can be fragile to upgrade and difficult to replicate. diff --git a/docs/development/api-reference.md b/docs/development/api-reference.md index a76922e..3cb3052 100644 --- a/docs/development/api-reference.md +++ b/docs/development/api-reference.md @@ -23,7 +23,7 @@ Returns high-level appliance status, health metrics, and active generation. "zfsPoolsCount": 1, "activeSharesCount": 3, "runningAppsCount": 2, - "osVersion": "NaxOS 24.11 (NixOS Vicuna)", + "osVersion": "NaxOS 26.05 (NixOS)", "nixosGeneration": 42 } } diff --git a/docs/guides/installation.md b/docs/guides/installation.md index 39e1afa..7adb1a6 100644 --- a/docs/guides/installation.md +++ b/docs/guides/installation.md @@ -57,7 +57,7 @@ During Step 6, `naxos-installer`: 2. **Installs the NaxOS Web Dashboard (`naxos-ui`)**: Unpacks the compiled React SPA into `/mnt/opt/naxos/ui/dist`. 3. **Installs the NaxOS Management Daemon (`naxos-api`)**: Deploys the Node.js fastify backend daemon into `/mnt/opt/naxos/api`. 4. **Configures Appliance Systemd Services**: Enables `services.naxos.api` (port 8088), `services.naxos.ui` (Nginx reverse proxy on port 80/443), `services.naxos.perses` (CNCF Perses metrics on 8080), Samba SMB with Time Machine, and OpenZFS automated scrub/snapshots. -5. **Executes `nixos-install`**: Compiles and activates the complete appliance generation. +5. **Executes `nixos-install`**: Compiles and activates the complete appliance generation running **NixOS 26.05**. --- diff --git a/docs/images/app-store.png b/docs/images/app-store.png index b69e7e0..b5dccc4 100644 Binary files a/docs/images/app-store.png and b/docs/images/app-store.png differ diff --git a/docs/images/dashboard-overview.png b/docs/images/dashboard-overview.png index 4898f07..3df57f0 100644 Binary files a/docs/images/dashboard-overview.png and b/docs/images/dashboard-overview.png differ diff --git a/docs/images/gitops-sync.png b/docs/images/gitops-sync.png index 3130854..b71dc4e 100644 Binary files a/docs/images/gitops-sync.png and b/docs/images/gitops-sync.png differ diff --git a/docs/images/logo.svg b/docs/images/logo.svg new file mode 100644 index 0000000..8b59f1a --- /dev/null +++ b/docs/images/logo.svg @@ -0,0 +1,62 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/images/migration-wizard.png b/docs/images/migration-wizard.png index 2f55e6d..fc96472 100644 Binary files a/docs/images/migration-wizard.png and b/docs/images/migration-wizard.png differ diff --git a/docs/images/perses-analytics.png b/docs/images/perses-analytics.png index c0afc0c..7c8963d 100644 Binary files a/docs/images/perses-analytics.png and b/docs/images/perses-analytics.png differ diff --git a/docs/images/shares-management.png b/docs/images/shares-management.png index f7aa83e..1bebfb1 100644 Binary files a/docs/images/shares-management.png and b/docs/images/shares-management.png differ diff --git a/docs/images/storage-management.png b/docs/images/storage-management.png index 45dfe5e..6fbc729 100644 Binary files a/docs/images/storage-management.png and b/docs/images/storage-management.png differ diff --git a/docs/images/system-logs.png b/docs/images/system-logs.png index 12f2461..850e05d 100644 Binary files a/docs/images/system-logs.png and b/docs/images/system-logs.png differ