Skip to main content

Module Reference

How each part of the code works. Every page follows the same layout: what the module is responsible for (Owns), how other code reaches it (Entry points), and the rules it enforces and depends on (Boundaries). The pages link to source files rather than listing every function, so check the code for the finer details.

To run the system, see Operations. For exact settings and API contracts, see the Reference section. The end-to-end test system is covered under E2E Testing.

Server​

ModuleResponsibility
Server ApplicationThe OTP supervision tree and configuration.
Server DomainAsh resources, data-layer authorization, and the generated JSON:API.
Server WebRouting, request pipelines, operator permissions, LiveViews, and the terminal channel.
Server DevicesDevice identity, registration, groups, the command queue, and remote-access leases.
Server ProvisioningAtomixOS bootstrap delivery.
Server MonitoringHeartbeats, telemetry, alerts, offline detection, and notifications.
Server ScriptsThe Stary script workbench.
Server ReportingCustom telemetry reports.

Client​

ModuleResponsibility
Client CLIThe nixstasis command tree and configuration loading.
Client TransportHTTP calls to the server and the connection policy.
Client IdentityDevice identity detection and credential storage.
Client Starlark RuntimeStary script parsing, execution limits, and builtins.
Client Command HandlerRunning server commands and the command policy.
Client FRP ManagerStarting frpc and the client-owned route profiles.

Gateway​

ModuleResponsibility
Gateway CaddyPublic HTTPS, on-demand TLS, AuthCrunch, and gateway trust rules.
Gateway FRPThe FRPS tunnel server and device tunnel authorization.