matrix-axon

Axon documentation

The project README is the short introduction. This page indexes everything else.

Use Axon

Guide	What it covers
Installing Axon	Server and clients, per operating system
Docker guide	The Compose stack: quick start, Tailscale and Caddy profiles, volumes and backup
Administering the server	Sign-in, tokens, SSO, adding accounts, push, management API, TLS
Technical reference	Architecture, database encoding and deadlines, environment variables and config
axon-tui	The terminal client: commands, shortcuts, configuration
axon-web	The web client
Desktop app	The Tauri shell for macOS, Windows and Linux
Room metadata API	Cached room-state details exposed to clients
Support, Privacy policy	Getting help; what data Axon handles

Build and contribute

Guide	What it covers
Building from source	Prerequisites, first-time setup, running, troubleshooting
CONTRIBUTING	The pre-push gate, conventions, releasing
AGENTS.md	Working conventions and current state
Integration testing	Running Axon against a local Synapse
Packaging	.deb, .rpm, Homebrew and winget
Client parity	Which API capabilities each client exposes
Demo coverage	Which demo scene shows which capability
Brand assets	Logos and usage

Why it works this way

Document	What it covers
Product requirements	What we are building and why
Tech spec	Architecture decisions and tradeoffs
Implementation plan	Milestone-by-milestone build plan
ADRs	Decisions made during implementation
RFC 0001	Postgres versus SQLite for the store

Operator and platform notes

• Custom emoji and sticker packs
• Sending bundled link previews — server send/generation contracts, protected thumbnail retrieval, budgets and recovery
• Matrix OAuth browser sign-in
• Apple sign-in: browser, native, and the App Review response
• Web slow-link measurement
• Incoming mobile sharing design — iOS-first rich links, multi-file sharing and Android share-target plan
• Web client review, 2026-07
• Smoke-testing plan

This site is open source. Improve this page.