Skip to content

Latest commit

 

History

History

README.md

EntityDB Reference Documentation

This directory contains comprehensive technical reference documentation for EntityDB.

📚 Reference Categories

Technical Specifications

📋 Technical Specs - Detailed technical specifications

  • Binary Format Specification (EBF)
  • Unified File Format (EUFF)
  • Temporal Storage Implementation
  • Memory Optimization Architecture

Configuration

⚙️ Configuration Reference - Complete configuration options

  • Environment variables
  • CLI flags
  • Three-tier configuration hierarchy

API Reference

🔌 API Reference - Complete API documentation

  • REST endpoints
  • Request/response formats
  • Authentication requirements

Format Specifications

💾 Binary Format Spec - EntityDB file format details

  • Header structure
  • Entry format
  • Compression details

Security Reference

🔒 RBAC Reference - Permission system reference

  • Tag-based permissions
  • Role definitions
  • Security policies

Troubleshooting

🔧 Troubleshooting Guide - Common issues and solutions

  • Content format issues
  • Tag indexing problems
  • Temporal query troubleshooting

🎯 Quick Links

For Developers

For Operations

For Users


Purpose: Technical reference for developers and operations teams
Audience: Technical users needing detailed specifications
Last Updated: 2025-06-23