Cloudillo Documentation

Welcome to Cloudillo

Cloudillo is an open-source, decentralized collaboration platform that empowers users to maintain complete control over their data while collaborating globally. Whether you’re building collaborative applications, hosting your own instance, or exploring decentralized architectures, this documentation guides you through every aspect of Cloudillo.

Choose your path below:

👥 For Everyone: Getting Started

New to Cloudillo? Start here to understand what it is and how to get up and running.

• What is Cloudillo? — Understand Cloudillo’s vision: global accessibility with local control, revolutionary authentication, and seamless interconnectivity
• Prerequisites — System requirements and what you need to know before getting started
• Getting Started — Quickstart guide to begin using Cloudillo
• Install Yourself — Self-hosting guide for those who want to run their own instance
• First Steps — Your first interactions and setup on Cloudillo
• Status Page — Service status and availability

💻 For Developers: API & Integration

Build applications on top of Cloudillo using our comprehensive API and client libraries.

Quick Start for Developers

• API Getting Started — Introduction to the Cloudillo API
• Quick Start — Hands-on examples and step-by-step tutorials

Client Libraries

• Client Libraries Overview — Available SDKs and packages
  • @cloudillo/base — Core SDK for initialization and API access
  • @cloudillo/react — React hooks and components
  • @cloudillo/types — TypeScript types with runtime validation

REST API Reference

• REST API Overview — Complete REST API documentation
  • Authentication — Login, registration, and token management
  • Profiles — User and community profiles
  • Actions — Social interactions and action tokens
  • Files — File upload, download, and management
  • Settings — User preferences and configuration
  • References — Bookmarks and shortcuts

Real-Time APIs

• WebSocket API — Real-time messaging and notifications
• Real-Time Database — Firebase-like structured data with subscriptions
• CRDT Collaboration — Conflict-free collaborative document editing

Developer Guides

• Authentication Guide — Token-based authentication and authorization
• Testing Guide — Unit, integration, and E2E testing strategies
• Error Handling — Error codes and handling strategies
• Microfrontends — Building apps for the Cloudillo shell

🏗️ Technical Deep Dives: Architecture

Understand Cloudillo’s technical architecture, data models, and how the system works internally.

Core Concepts & Fundamentals

• Core Concept & Architecture — High-level overview of Cloudillo’s design
• Architecture Fundamentals — Core principles and patterns
  • System Overview — Technical patterns, adapters, and task systems
  • DNS-Based Identity — Identity system and profile management
  • Content-Addressing & Merkle Trees — Cryptographic hashing for proof of authenticity
  • Network & Security — Network architecture and security considerations

Data Storage & Access

• Data Storage & Access Overview — How data is stored, organized, and accessed
  • Blob Storage — Content-addressed immutable files with variants and deduplication
  • Real-Time Database (RTDB) — Query-oriented JSON database with subscriptions
    • RTDB Overview — Architecture and design
    • RTDB Implementation (ReDB) — Storage engine details
  • Collaborative Editing (CRDT) — Conflict-free replicated data types
    • CRDT Overview — Architecture and algorithms
    • CRDT Implementation (ReDB) — Storage implementation
• Access Control — Resource protection and sharing
  • Access Control Mechanism — Token-based authentication
  • ABAC Permissions — Attribute-based access control

Actions & Federation

• Actions & Federation Overview — Event-driven interactions and decentralized federation
  • Action Tokens — Cryptographically signed events
    • User Relationships — Connection and follow tokens
    • Content Actions — Posts, comments, reactions, reposts, endorsements
    • Communication — Direct messages and conversations
    • Metadata — Statistics, acknowledgments, file sharing
  • Federation Architecture — Inter-instance communication and protocols

Runtime Systems

• Runtime Systems — Background processing and real-time features
  • Task Scheduler — Persistent task execution and scheduling
  • Worker Pool — CPU-intensive task processing
  • WebSocket Bus — Real-time notifications and presence tracking

🔧 Implementation & Operations

• Implementation — Developer-focused implementation details
  • Action Flow — How actions flow through the system

🚀 Next Steps

• Just exploring? Start with What is Cloudillo?
• Want to build an app? Head to API Getting Started
• Setting up a server? See Installing Cloudillo Yourself
• Need technical details? Dive into Architecture