Skip to content

πŸŒ‰ Production-ready Matrix-Telegram bridge with flexible Docker deployment options

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

zyrakq/mautrix-telegram-stack

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸŒ‰ Mautrix Telegram Stack

A comprehensive Docker stack for running Mautrix Telegram bridge with certificate management solutions.

Mautrix Telegram is a Matrix-Telegram bridge that allows you to connect your Matrix homeserver to Telegram, enabling seamless communication between Matrix and Telegram users. Perfect for bridging Matrix rooms with Telegram chats and channels.

🧩 Components

πŸ” SSL Automation

Automatic SSL certificate management from Let's Encrypt for production deployments. Provides seamless HTTPS integration for Docker containers using nginx-proxy and acme-companion. Learn more about Let's Encrypt Manager configuration.

Local domain stack with trusted self-signed certificates for virtual network deployments. Includes private CA management and local DNS resolution for development environments. Learn more about Step CA Manager configuration.

🌐 Services

πŸŒ‰ Mautrix Telegram Bridge

Location: src/mautrix-telegram/

Matrix-Telegram bridge service that connects Matrix homeservers to Telegram. Supports bidirectional messaging, media transfer, user puppeting, and channel bridging. Includes automatic configuration generation and registration management.

🎯 Use Cases

  • 🌐 Production Deployment: Use Mautrix Telegram + Let's Encrypt Manager for public-facing Matrix-Telegram bridges
  • 🏠 Internal Networks: Use Mautrix Telegram + Step CA Manager for private/development environments
  • πŸ”§ Development: Use Mautrix Telegram standalone for local development and testing
  • πŸŒ‰ Personal Bridging: Connect your personal Matrix account to Telegram
  • 🏒 Organization Bridging: Bridge Matrix rooms with Telegram groups and channels
  • πŸ€– Bot Integration: Use Telegram bots through Matrix interface
  • πŸ“± Multi-Platform Communication: Seamless communication across Matrix and Telegram ecosystems

πŸš€ Quick Start

Each component has its own README with detailed setup instructions. Choose the certificate management solution that fits your deployment scenario.

For Mautrix Telegram Bridge

  1. Navigate to the mautrix-telegram directory:

    cd src/mautrix-telegram/
  2. Build configurations:

    ./build.sh
  3. Choose your desired configuration and follow instructions in src/mautrix-telegram/README.md

πŸ“‹ Prerequisites

  • Docker and Docker Compose
  • Matrix homeserver with application service support
  • Telegram API credentials (api_id and api_hash from https://my.telegram.org)
  • Domain name (for production deployments with SSL)

πŸ”§ Configuration Overview

The bridge requires:

  1. Matrix Homeserver: Configure your Matrix server to accept the bridge's application service
  2. Telegram API: Register your application at https://my.telegram.org to get API credentials
  3. Bridge Configuration: Set up the bridge with proper homeserver and Telegram settings
  4. SSL Certificates: Choose between Let's Encrypt or Step CA for secure connections

πŸ“„ License

This project is dual-licensed under:

About

πŸŒ‰ Production-ready Matrix-Telegram bridge with flexible Docker deployment options

Topics

Resources

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT

Stars

Watchers

Forks