Skip to content

README.md

Latest commit

 

History

History
67 lines (48 loc) · 2.49 KB

README.md

File metadata and controls

67 lines (48 loc) · 2.49 KB
Raw

FortOS

A modern, security-first Linux NAS operating system, built on .NET 10.

Platform .NET 10 License

FortOS runs bare-metal via a Debian 12 ISO or inside Docker for evaluation. All management surfaces expose a unified REST/gRPC API and a terminal CLI; Docker containers are first-class citizens alongside native services (SMB, NFS, rsync, snapshots).

✨ Features

Pillar Capabilities
🗄️ Storage Disk discovery, RAID (mdadm), ext4/XFS/Btrfs/ZFS, SMART monitoring, per-share quotas
🔗 Sharing SMB, NFS, FTP, recycle bin with retention policies
🛡️ Protection Snapshots (btrfs/LVM thin), rsync backup, cloud backup, point-in-time restore
🔐 Security NasToken capability tokens, fine-grained NAbility permissions, data classification, HMAC-chained audit
🐳 Containers Agent Catalog, Token Broker, hardened Compose generation
📈 Observability Metrics (host/SMART/RAID/Docker), 5-stage log pipeline with Loki, alert engine, Prometheus /metrics

🚀 Quick Start

Option A — Docker (evaluation)

git clone https://github.com/GeneralLibrary/fortOS.git
cd fortOS
docker compose up -d --build

Option B — Bare metal

Download the Debian 12 ISO (amd64 / arm64) built by the FortOS ISO workflow and flash it onto your NAS hardware.

💻 CLI examples

fortos status --watch --interval 5                    # TUI dashboard & live metrics
fortos disk list --output json                        # disk inventory
fortos share create media --path /srv/nas/media --protocols smb,nfs
fortos agent deploy nginx-basic --image nginx:alpine  # container agent
fortos backup task set media-backup --source /srv/nas/media --cron interval:60
fortos audit verify --output json

🔌 Interfaces

Interface Endpoint
REST API http://localhost:5000/api/
gRPC (HTTP/2) port 5001
Web dashboard /dashboard

📄 License

Open-source under the LICENSE file.