docs(branding): update logo, adopt NixOS 26.05 across docs and refresh screenshots
Validate Documentation / lint-docs (push) Successful in 9s
Lukas Holzner
@@ -1,8 +1,24 @@
|
||||
# NaxOS Documentation (`naxos-docs`)
|
||||
<p align="center">
|
||||
<img src="docs/images/logo.svg" alt="NaxOS Logo" width="140" height="140" />
|
||||
</p>
|
||||
|
||||
[](https://git.lholz.de/naxos/naxos-docs/actions)
|
||||
<h1 align="center">NaxOS Documentation</h1>
|
||||
|
||||
Welcome to the comprehensive documentation repository for **NaxOS**, the declarative, appliance-like Network Attached Storage (NAS) operating system built on NixOS and OpenZFS.
|
||||
<p align="center">
|
||||
<b>Comprehensive Technical Architecture & Operations Guide (NixOS 26.05 & OpenZFS)</b>
|
||||
<br />
|
||||
Architecture Specifications, API Reference, Migration Runbooks, and Bare-Metal Guides
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://git.lholz.de/naxos/naxos-docs/actions"><img src="https://git.lholz.de/naxos/naxos-docs/actions/workflows/ci.yaml/badge.svg" alt="Documentation Validation" /></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-docs"><img src="https://img.shields.io/badge/nixos-26.05-5277C3.svg?logo=nixos&logoColor=white" alt="NixOS 26.05" /></a>
|
||||
</p>
|
||||
|
||||
---
|
||||
|
||||
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**.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,8 +1,12 @@
|
||||
<p align="center">
|
||||
<img src="../images/logo.svg" alt="NaxOS Logo" width="120" height="120" />
|
||||
</p>
|
||||
|
||||
# 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.
|
||||
|
||||
|
||||
@@ -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
|
||||
}
|
||||
}
|
||||
|
||||
@@ -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**.
|
||||
|
||||
---
|
||||
|
||||
|
||||
|
Before Width: | Height: | Size: 168 KiB After Width: | Height: | Size: 168 KiB |
|
Before Width: | Height: | Size: 207 KiB After Width: | Height: | Size: 206 KiB |
|
Before Width: | Height: | Size: 116 KiB After Width: | Height: | Size: 116 KiB |
@@ -0,0 +1,62 @@
|
||||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 700 700" width="100%" height="100%">
|
||||
<!-- NaxOS Logo with Transparent Background -->
|
||||
|
||||
<!-- 1. Snowflake (Background Layer) -->
|
||||
<g id="snowflake" stroke="#0cb3e5" stroke-width="28" stroke-linecap="round" stroke-linejoin="round">
|
||||
<!-- Center Vertical Stem -->
|
||||
<line x1="350" y1="336.5" x2="350" y2="162" />
|
||||
<line x1="350" y1="336.5" x2="350" y2="530" />
|
||||
|
||||
<!-- Top Chevron (inside doorway) -->
|
||||
<line x1="350" y1="202" x2="305" y2="162" />
|
||||
<line x1="350" y1="202" x2="395" y2="162" />
|
||||
|
||||
<!-- Bottom Chevron (inside doorway plinth) -->
|
||||
<line x1="350" y1="475" x2="315" y2="510" />
|
||||
<line x1="350" y1="475" x2="385" y2="510" />
|
||||
|
||||
<!-- Upper Left Arm -->
|
||||
<line x1="350" y1="336.5" x2="145" y2="258" />
|
||||
<line x1="145" y1="258" x2="93" y2="215" />
|
||||
<line x1="145" y1="258" x2="93" y2="301" />
|
||||
<line x1="176" y1="242" x2="158" y2="165" />
|
||||
|
||||
<!-- Lower Left Arm -->
|
||||
<line x1="350" y1="336.5" x2="145" y2="416" />
|
||||
<line x1="145" y1="416" x2="93" y2="373" />
|
||||
<line x1="145" y1="416" x2="93" y2="459" />
|
||||
<line x1="176" y1="432" x2="158" y2="510" />
|
||||
|
||||
<!-- Upper Right Arm -->
|
||||
<line x1="350" y1="336.5" x2="555" y2="258" />
|
||||
<line x1="555" y1="258" x2="607" y2="215" />
|
||||
<line x1="555" y1="258" x2="607" y2="301" />
|
||||
<line x1="524" y1="242" x2="542" y2="165" />
|
||||
|
||||
<!-- Lower Right Arm -->
|
||||
<line x1="350" y1="336.5" x2="555" y2="416" />
|
||||
<line x1="555" y1="416" x2="607" y2="373" />
|
||||
<line x1="555" y1="416" x2="607" y2="459" />
|
||||
<line x1="524" y1="432" x2="542" y2="510" />
|
||||
</g>
|
||||
|
||||
<!-- 2. Portara (Middle Layer) -->
|
||||
<g id="portara">
|
||||
<!-- Dark Navy Outer Frame & Stepped Plinth -->
|
||||
<path d="M 180 56 H 520 V 460 L 525 465 V 540 H 380 V 442 H 420 V 162 H 280 V 442 H 320 V 540 H 175 V 465 L 180 460 Z" fill="#0e4079" />
|
||||
<!-- Royal Blue Inset Fill -->
|
||||
<path d="M 200 76 H 500 V 460 L 505 465 V 540 H 400 V 462 H 440 V 142 H 260 V 462 H 300 V 540 H 195 V 465 L 200 460 Z" fill="#2462b3" />
|
||||
</g>
|
||||
|
||||
<!-- 3. Snow Hills (Foreground Layer) -->
|
||||
<g id="snow">
|
||||
<!-- Right Hill Body -->
|
||||
<path d="M 335 536 C 430 508, 600 510, 665 618 H 180 L 335 536 Z" fill="#acc4db" />
|
||||
<!-- Left Hill Body -->
|
||||
<path d="M 35 618 C 80 545, 220 480, 335 536 L 180 618 Z" fill="#acc4db" />
|
||||
|
||||
<!-- White Crests & Dividing Ridge -->
|
||||
<path d="M 335 536 C 430 508, 600 510, 665 618" fill="none" stroke="#ffffff" stroke-width="20" stroke-linecap="round" stroke-linejoin="round" />
|
||||
<path d="M 35 618 C 80 545, 220 480, 335 536 L 180 618" fill="none" stroke="#ffffff" stroke-width="20" stroke-linecap="round" stroke-linejoin="round" />
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 2.6 KiB |
|
Before Width: | Height: | Size: 100 KiB After Width: | Height: | Size: 100 KiB |
|
Before Width: | Height: | Size: 139 KiB After Width: | Height: | Size: 138 KiB |
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 92 KiB After Width: | Height: | Size: 92 KiB |
|
Before Width: | Height: | Size: 99 KiB After Width: | Height: | Size: 99 KiB |