Documentation: Matrix bridge setup and architecture #386

Closed
opened 2026-02-15 07:02:19 +00:00 by jason.woltje · 1 comment
Owner

Summary

Document the Matrix bridge integration — setup guide, architecture decisions, and operational notes.

Content

README / Setup Guide

  • Prerequisites (Synapse homeserver, bot account)
  • Environment variables reference
  • Quick start with docker-compose (dev)
  • Production deployment with external Synapse
  • Bot account creation and access token generation

Architecture Documentation

  • How Matrix bridge fits alongside Discord bridge
  • IChatProvider abstraction
  • Workspace → Room mapping
  • Herald multi-bridge broadcasting
  • Command flow diagram
  • Thread handling for job updates

Operational Notes

  • Running both bridges simultaneously
  • Migrating from Discord-only to Matrix
  • Troubleshooting connection issues
  • Synapse maintenance (database growth, media cleanup)

Acceptance Criteria

  • Setup guide in docs/ or README section
  • Architecture diagram showing bridge relationship
  • Environment variable reference complete
  • Troubleshooting section

Refs

## Summary Document the Matrix bridge integration — setup guide, architecture decisions, and operational notes. ## Content ### README / Setup Guide - Prerequisites (Synapse homeserver, bot account) - Environment variables reference - Quick start with docker-compose (dev) - Production deployment with external Synapse - Bot account creation and access token generation ### Architecture Documentation - How Matrix bridge fits alongside Discord bridge - IChatProvider abstraction - Workspace → Room mapping - Herald multi-bridge broadcasting - Command flow diagram - Thread handling for job updates ### Operational Notes - Running both bridges simultaneously - Migrating from Discord-only to Matrix - Troubleshooting connection issues - Synapse maintenance (database growth, media cleanup) ## Acceptance Criteria - [ ] Setup guide in docs/ or README section - [ ] Architecture diagram showing bridge relationship - [ ] Environment variable reference complete - [ ] Troubleshooting section ## Refs - EPIC: #377 - Depends on: all other M12 issues
jason.woltje added the docs label 2026-02-15 07:02:19 +00:00
jason.woltje added this to the M12-MatrixBridge (0.0.12) milestone 2026-02-15 07:02:56 +00:00
Author
Owner

Completed in commit 68808c0 on branch feature/m12-matrix-bridge.

  • Created docs/MATRIX-BRIDGE.md (537 lines)
  • Quick start guide for dev environment
  • Architecture overview with service responsibilities
  • Command reference with examples
  • Configuration reference
  • Streaming response architecture
  • Deployment considerations
Completed in commit 68808c0 on branch feature/m12-matrix-bridge. - Created docs/MATRIX-BRIDGE.md (537 lines) - Quick start guide for dev environment - Architecture overview with service responsibilities - Command reference with examples - Configuration reference - Streaming response architecture - Deployment considerations
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: mosaic/stack#386