GitHunt
SV

SvM79/matrix-synapse-hosting

Home-lab Matrix-Synapse deployment on Synology with secure federation, Git-based automation, and CI/CD practices.

๐Ÿงฑ Matrix-Synapse Hosting on Synology

This repository documents a self-hosted Matrix-Synapse deployment on a Synology NAS, designed for secure, federated communication using Docker, Git-based deployment, and a CI/CD-assisted development workflow.


๐ŸŒ Project Goals

  • Enable secure Matrix federation for private and trusted peers
  • Self-host Matrix-Synapse on Synology DS224+ using Docker
  • Use local development (WSL) for safe, testable configuration
  • Mirror reusable code and docs to GitHub without exposing secrets
  • Apply devops practices like Git workflows, CI/CD, and infrastructure-as-code

๐Ÿ” Development & Deployment Flow

This project uses a structured Git-based deployment model involving three environments:

Role Environment Purpose
๐Ÿงฉ Production Synology NAS Hosts live Matrix-Synapse container and persistent volume
๐Ÿ’ป Development WSL (Ubuntu on Windows) Safe local editing, Git commits, file sync
โ˜๏ธ Backup/CI GitHub Mirrors templates, documentation, and automation โ€” no secrets

๐Ÿง  Why This Architecture?

This flow provides the right balance of privacy, traceability, and professional devops practices:

  • Synology stores sensitive configs and secrets but is isolated from public access.
  • WSL enables safe local editing without touching the live container.
  • GitHub acts as an offsite mirror with CI/CD for linting, scanning, and backup โ€” while exposing only public-safe material.

๐Ÿ“ฆ What This Repo Contains

  • docs/ โ€” Federation architecture, trust model, and security hardening
  • templates/ โ€” Redacted homeserver.yaml, Docker Compose, .env examples
  • scripts/ โ€” Automation hooks (e.g., deploy on push, health checks)
  • .github/workflows/ โ€” Linting and secret scanning via GitHub Actions

๐Ÿ›ก๏ธ See Hardening Checklist for applied and planned security practices.


๐Ÿ“„ License

This project is licensed under the Apache License 2.0, matching the Matrix Synapse project's license.


Note: No private keys, production configurations, or secret tokens are stored in this repository.

SvM79/matrix-synapse-hosting | GitHunt