NestOS Technical Documentation

System Architecture

NestOS is built on Debian (bookworm) with the following core components:

  • System Service (Node.js backend with privilege separation)
  • Control Panel (React-based web interface)
  • Nest Launcher (Modern application launcher with frosted-glass UI)
  • Plugin System (Docker-based application management)
  • Storage Management System
  • Container Management System

Security Features

  • Privilege Separation
  • Secure System Updates
  • Docker Container Isolation
  • API Security Controls

Planned Features

  • Multi-user Authentication System
  • Role-based Access Control
  • Dynamic Theme Support
  • Enhanced Backup Solutions

API Reference

System

GET /api/system/info

Get detailed system information including CPU, memory, and OS details

Response: 
{
  "cpu": {
    "manufacturer": "Intel",
    "brand": "Intel(R) Core(TM) i7-10700K",
    "cores": 8,
    "physicalCores": 8,
    "speed": 3.8,
    "temperature": 45
  },
  "memory": {
    "total": 32212254720,
    "free": 16106127360,
    "used": 16106127360
  },
  "os": {
    "platform": "linux",
    "distro": "Debian",
    "release": "12",
    "hostname": "nestos"
  }
}
GET /api/system/plugins

List all installed plugins and their status

Response: 
[{
  "id": "nextcloud",
  "name": "Nextcloud",
  "version": "25.0.3",
  "status": "running",
  "url": "http://localhost:8080",
  "icon": "/icons/nextcloud.png"
}]
GET /api/system/updates

Check for available system and NestOS updates

Storage

GET /api/storage/devices

List all storage devices with SMART data and filesystem information

Response: 
{
  "devices": [{
    "name": "sda",
    "identifier": "/dev/sda",
    "type": "disk",
    "fsType": "ext4",
    "mount": "/",
    "size": 1000204886016,
    "smart": {
      "health": "OK",
      "temperature": 35
    },
    "filesystem": {
      "size": 1000204886016,
      "used": 421827387392,
      "available": 578377498624,
      "use": 42.1
    }
  }]
}

Docker

GET /api/docker/containers

List all Docker containers

Response: 
[{
  "Id": "abc123...",
  "Names": ["/nextcloud"],
  "Image": "nextcloud:latest",
  "State": "running",
  "Status": "Up 2 days",
  "Ports": [{"PrivatePort": 80, "PublicPort": 8080}],
  "Created": 1677721600
}]
POST /api/network/test

Run network speed and latency tests

Response: 
{
  "ping": {
    "host": "8.8.8.8",
    "latency": 15.4,
    "packetLoss": 0
  },
  "speedtest": {
    "download": 100.5,
    "upload": 40.2,
    "unit": "Mbps"
  }
}
GET /api/appearance/appearance

Get current appearance settings

Response: 
{
  "background": "abstract-dark"
}

Troubleshooting Guide

System Won't Boot

Common causes:

  • Corrupted boot sector
  • Missing GRUB configuration
  • Hardware compatibility issues

Solution:

  1. Boot from USB recovery media
  2. Run system diagnostics: nestos-recover --diagnose
  3. Repair boot sector: nestos-recover --repair-boot

RAID Array Degraded

Symptoms:

  • Reduced performance
  • Warning notifications
  • Storage health alerts

Solution:

  1. Check drive status: nestos-storage status
  2. Replace failed drive
  3. Rebuild array: nestos-storage rebuild

Container Management

  • Docker Container Management
    • Real-time container monitoring
    • Container logs and statistics
    • Integrated image search across:
      • Docker Hub Registry
      • GitHub Container Registry (GHCR)
    • Container creation and configuration
    • Volume and network management