novafabric.ai/docs

Documentation

Everything from a first capture to running NovaFabric at cluster scale.

New here? Start with Getting started, then Concepts.

Start here

Tutorials

Integrations

Operations

  • Air-Gapped / Offline Deployment Guide

    Install and run NovaFabric with no internet access: offline installation, no telemetry or phone-home, and which opt-in features need a network endpoint.

  • Backup & Restore Runbook

    How to back up and restore a NovaFabric deployment. The first half documents procedures that work today with standard tools; the second half covers the…

  • Cluster-Scale Migration Guide

    This guide walks through migrating a local-mode NovaFabric installation (SQLite + filesystem) to a cluster-scale deployment (Postgres + Object Capsule…

  • Dashboard scale gate — thresholds and how to run it

    The dashboard's latency posture is enforced by a seeded benchmark, not by hope: tests/bench/test_dashboard_scale_gate.py seeds a deterministic 100…

  • Data residency — jurisdiction-aware capsule placement

    A JurisdictionRoutingAdapter wraps your per-region WORM backends and routes each tenant's capsules to the backend registered for that tenant's…

  • Encryption at Rest (opt-in envelope encryption)

    This guide covers NovaFabric's optional application-layer envelope encryption for capsule payloads in the object capsule store (ADR-0185).

  • Incident Runbook (on-call)

    Symptom → diagnosis → action, for the operator on call for a NovaFabric deployment (nova server API, nova serve dashboard, or a local install).

  • Monitoring & Self-Observability

    This guide covers monitoring NovaFabric's own HTTP apps — the nova server REST API and the nova serve dashboard backend — with the self-observability…

  • API Rate Limiting & Storage Quotas

    This guide covers protecting a shared nova server deployment from noisy clients: in-process API rate limiting and warn-then-reject storage quotas…

  • Server Administration Guide (multi-user nova server)

    This guide is for the administrator of a shared, multi-user NovaFabric deployment — the nova server REST API (/v0), not the single-operator nova serve…

  • Server Deployment Guide

    This guide covers six deployment scenarios. Each scenario is labelled with its current implementation status per the docs honesty rule: works today…

  • Capacity Planning & Sizing Guide

    How to size storage, memory, and CPU for a NovaFabric deployment — from a single laptop to a shared Postgres server.

  • Upgrade Guide

    How to upgrade a NovaFabric deployment from one version to the next — local SQLite installs and Postgres server mode — and what is honestly supported…

Lineage

  • LineageStore Migration Guide

    The migration kit (nova lineage-store migrate) rebuilds a lineage graph in a target SQLite lineage store. One source works from the CLI today:

Governance

  • Design partners

    A design partner is an organization that adopts NovaFabric in a real workflow before v1.0 and trades regular feedback for direct influence over the spec.

  • Maintainer criteria

    How merge rights are earned, what they commit you to, and how to step back.

  • The RFC process

    NovaFabric uses a lightweight, Rust-style RFC process for non-trivial changes: GitHub-based, time-boxed comment windows, two approvers, and an…

RFCs

architecture