WarningThis documentation is currently a work in progress and should not be fully trusted yet. Information may be incomplete, outdated, or subject to change.

Documentation

Comprehensive guides and references for Matrix server connectivity and configuration

Documentation Sections

Getting Started

Learn how to set up and configure your Matrix server for federation and connectivity testing.

Configuration

Configure CORS, TLS certificates, and server settings for optimal Matrix server operation.

API Endpoints

Understand the various API endpoints required for Matrix server operation and client connectivity.

Troubleshooting

Diagnose and resolve common connectivity issues, network problems, and configuration errors.

Compliance (Unofficial)

Unofficial compliance suites for Matrix applications (not vetted by SCT).

Quick Links

About This Documentation

This documentation covers everything you need to know about setting up, configuring, and troubleshooting your Matrix homeserver for optimal connectivity and federation.

What You'll Find Here

Setup Guides - Step-by-step instructions for configuring federation, TLS, and delegation
Configuration Reference - Detailed configuration options and best practices
Troubleshooting - Solutions to common problems and diagnostic procedures
API Documentation - Understanding Matrix APIs and endpoints
Performance Optimization - Tips for improving server performance

Getting Started

If you're new to Matrix server administration, we recommend starting with:

Federation Setup - Configure your server for federation
TLS Certificates - Set up secure connections
Well-Known Delegation - Configure discovery
CORS Configuration - Enable web clients

Need Help?

Use the connectivity tester to diagnose issues automatically
Check Server Logs for error messages
Review Troubleshooting guides
Visit Getting Help for community support

Contributing

Found an error or want to improve this documentation? Contributions are welcome! Check the project repository for contribution guidelines.