Documentation

Guides, references, and deep dives for the freeq IRC server and ecosystem.

Start here

What is freeq? newWhat this is, how it differs from IRC and Slack/Discord, and why it matters
Getting Started newConnect as a user, run your own server, build your first bot
Connection GuideEvery supported transport and client

Clients

Web Client newSlack-class web app — reactions, threads, media, search, and AT Protocol login
iOS App newNative SwiftUI app via Rust FFI with full feature parity
What's Different from IRCDID identity, persistent ops, modern features for newcomers

Identity & Security

Authentication newAT Protocol SASL, OAuth, web tokens, DID-based identity
Policy Framework newCryptographic channel governance, verifiable credentials, transparency logs
Credential Verifiers newGitHub verifier, building custom verifiers, decoupled architecture
Moderation newHalfop (+h), moderator credentials, building third-party moderation services
Encryption & Security newEvery data path mapped — what's encrypted, what's not, and the roadmap to fix it
Policy DemoInteractive walkthrough of the policy framework

Building

Building Agents newAgent-native primitives — identity, governance, coordination events, evidence, spawning — plus a research agent tutorial
SDK DocumentationRust SDK for clients, bots, and integrations
Bot Quickstart newBuild your first freeq bot in 10 minutes — commands, rate limiting, reconnect
Bot Framework newBuild IRC bots, webhooks, and LLM-powered chat personas
REST API Reference newHealth, channels, history, users, upload, policy, and credentials endpoints
Policy System newChannel policies, credential types, web UI guide, DID ops bypass

Infrastructure

Self-Hosting Guide newRun your own server with TLS, nginx, systemd, and credential verifiers
Federation newServer-to-server via iroh QUIC with CRDT convergence

Deep dives

Protocol Notes deepSASL ATPROTO-CHALLENGE mechanism, DID extensions, transport stack, plugin hooks
Feature Catalog deepComplete list of every implemented feature with status
Architecture Decisions deepDesign rationale, tradeoffs, and engineering choices
S2S Federation Audit deepServer-to-server protocol analysis and correctness audit
Known Limitations deepExplicit gaps and missing features
Future Direction deepPlanned features and long-term vision

Source

All documentation lives in the GitHub repository. Site docs are in freeq-site/docs/, technical docs in docs/.

Supported by
Powered by