GenosDB Documentation
Welcome to the official technical documentation for GenosDB.API Reference & Advanced Documentation
- π GDB API Reference (Detailed API documentation)
- π€ Distributed Trust Model (P2P trust via cryptographic identity, signed ops, and RBAC enforcement)
- π Zero Trust Security Model (Understanding GenosDB Zero-Trust Security Model: From Guest to SuperAdmin)
- π§ͺ GenosDB Examples (Live demos and community projects)
- β¨ GenosDB Features (Comprehensive feature overview and architecture)
- π¨ GenosDB Design Guide (Opinionated UI patterns, design tokens, and page architectures for GenosDB applications β for humans and AIs)
- βοΈ Cursor-Based-Pagination (Efficient paging with before/$limit)
- π Resources (Helpful links: whitepaper, docs, wiki, npm, discussions)
- π οΈ CRUD Operation Guide (Overview of CRUD APIs with links to detailed guides)
- π€ PUT Guide (Insert/update nodes; auto ID, persistence, and events)
- π₯ GET Guide (Retrieve nodes by ID; optional real-time subscription)
- πΊοΈ MAP Guide (Query language, real-time subscriptions, and $edge traversal)
- ποΈ REMOVE Guide (Delete nodes and clean up edges; persistence and notifications)
- π LINK Guide (Create directed relationships between nodes)
API Reference (Modules)
- π Security Manager (SM API Reference) (RBAC, identity (WebAuthn/mnemonic), signing/verification)
- π‘ GenosRTC API Reference (P2P WebRTC API: rooms, data channels, audio/video)
- π°οΈ Own signaling relay: built into the Fallback Server (
--relayβ one flag, zero extra infrastructure) - βοΈ GenosRTC Architecture (A technical breakdown of GenosDBβs GenosRTC Module architecture, explaining its key components, including the decentralized signaling layer with Nostr, the P2P transport layer with WebRTC, and the communication abstractions for data and media.)
- π· GenosRTC Cells (Cellular mesh overlay: architecture, bridges, TTL, metrics, and scalability)
- π§ GenosRTC Guide (rtc) (Tutorials for data channels and media streaming)
- π΅οΈ Audit Option (audit) (Asynchronous moderation of the oplog with custom prompt)
- π€ NLQ Module (Natural Language for Queries in db.map using prompts)
- π GEO Query Module (geo) (Geo queries with bbox operators)
- π GenosDB SM ACLs Module (acls) (Node-level permissions and access control)
- ποΈ Governance (Role Promotion) (Rule-based promotion of users from guest to higher roles, driven by GenosDB queries and signed by a present superadmin)
- βοΈ GenosDB Worker Architecture (Technical overview of the persistence worker, covering its tiered storage strategy and data integrity mechanisms.)
- π GenosDB Hybrid Delta Protocol (Details the dual-mode engine ensuring real-time speed via delta updates and reliability via a full-state fallback.)
- π°οΈ GenosDB Hybrid Logical Clock (HLC) (An advanced timestamping system that blends physical time with a logical counter to ensure causal event ordering and enable robust, deterministic conflict resolution.)
- π§― GenosDB Fallback Server (Optional superpeer Node.js service to improve availability)
- π¦ Bundler Configuration (Vite, Webpack, Bun, esbuild, and CDN usage)
Roadmap & Whitepaper
- π§ ROADMAP.md (Planned features and milestones)
- π WHITEPAPER.md (Architecture and design paper)
- π PHILOSOPHY.md (Project philosophy, founder history, and coreprinciples)
Root Documentation
- π README.md (Project overview, installation, and docs)
- π§Ύ CHANGELOG.md (Release notes and version history)
- π€ CONTRIBUTING.md (How to contribute examples and guidelines)
- π MIGRATION.md (Migrate from βnew GDB()β to βawait gdb(β¦)β)
- π‘οΈ SECURITY.md (Security policy and vulnerability reporting)
- βοΈ THIRD_PARTY_LICENSES (Third-party and project licenses)