Read the design, then the code.
Documentation lives alongside the source in the main repository, so it is versioned with the code it describes.
Start here
For anyone exploring or contributing to the project.
Quickstart
Build NexisOS from source and boot the installer in a virtual machine.
Architecture overview
How configuration becomes a running system, and what each program is and is not responsible for.
Source code
nexis, nexis-init,
nexis-guard, the TUI installer and the ISO
build, all written in Nim.
Discussions
Ask questions, propose ideas and talk about the design with the maintainer and other users.
Design documents
Each records a decision, the reasoning and what was rejected. The full list is in docs/.
Architecture
The overall system model.
Configuration
The /etc/nexis tree: hosts, features, files, users, wrappers.
nexis-init
Every service key, the sandbox and scheduled services.
CLI
The nexis commands.
Package format
How packages are defined.
Package security
Trust, the checks, scanners, quarantine and nexis scan.
Security
How the security layers fit together.
SELinux
Policy, labels and readable denials.
Firewall
The nftables model.
Intrusion prevention
What nexis-guard detects and bans.
Store, index and GC
Why there is no optimise step, and how collection works.
Compared with NixOS
What a host can declare today, and the gaps.
Libraries and tools
What is linked, what is run, and why.
ISO build system
How the installer medium is built.
Coming with the first release
User guides will be written once the system manager is usable end to end.
| Guide | Covers | Status |
|---|---|---|
| Installation | Booting the ISO and walking through the TUI installer | Planned |
| Configuration | Writing hosts and features, and managing your own config files | Planned |
| Packaging | Adding sources and writing definitions for software outside them | Planned |
| Services | Declaring, sandboxing and scheduling services with nexis-init |
Planned |
| Security | Choosing a security level, scanners and what to do with quarantined packages | Planned |
| Generations | Switching, rolling back and cleaning up generations | Planned |