synapse-admin/docs

📚 Documentation

Welcome to the Ketesa documentation! This is the central index for all guides covering configuration, supported APIs, and available features.

📝 Note: Documentation is actively evolving — PRs are greatly appreciated!

---

⚙️ Configuration

Full configuration reference →

Specific topics:

Guide	What it covers
Customizing CORS credentials	Fine-tune cross-origin request behavior
Restricting available homeservers	Lock down which homeservers users can connect to
System / Appservice-managed users	Protect bridge puppets from accidental edits
Custom menu items	Add your own links to the navigation menu
External auth provider	Adjust behavior when Synapse delegates auth externally

---

🔌 APIs

• Supported APIs — full list of Synapse and MAS endpoints used by Ketesa

---

✨ Features

• User badges — role indicators on user avatars (admin, bot, system-managed, etc.)
• Prefilling the login form — pre-populate login fields via URL parameters
• Configurable columns — show, hide, and reorder table columns per your workflow

👥 User Management

Guide	What it covers
User management	Login-as-user, shadow ban, rate limits, experimental features, account data, server notices, MAS user management, MAS policy data
User search	Normal and reverse (!) MXID/displayname search
Bulk CSV import	Import many users at once from a CSV file
Registration tokens	Create and manage invite tokens for Synapse and MAS

🏠 Room Management

Guide	What it covers
Room management	Block/unblock, purge history, delete, join users, assign admins, members/state/extremities tabs, messages viewer, Space hierarchy
Media management	Quarantine, protect, and delete media at file/user/room scope

🔍 Moderation

• Event reports — review abuse reports submitted by users, use the event lookup tool

📡 Federation

• Federation overview — monitor remote server connections, reconnect failed destinations

📊 Statistics & Tasks

• Server statistics & scheduled tasks — database room sizes, user media usage, background task monitoring

---

🌟 etke.cc exclusive features

⚠️ Note: The following features are only available for etke.cc customers. Due to the specifics of their implementation, they are not available for any other Ketesa deployment.

• Server Status icon
• Server Status page
• Server Actions page
• Server Commands Panel
• Server Notifications icon
• Server Notifications page
• Components page
• Billing page
• Support page
• Instance config

---

🚀 Deployment

• Availability — where to get Ketesa: official builds, distro packages, integrations, mirrors, and legacy compatibility links
• Serving Ketesa behind a reverse proxy