Skip to content

ichinya/mtproxy-installer

Repository files navigation

mtproxy-installer

Bash-first installer для Telegram MTProto proxy deployments, где telemt сейчас является основным default path.

mtproxy-installer помогает быстро поднять Telemt-based MTProto proxy через Docker Compose и не терять operational context: стратегию по providers, выбор upstream-репозиториев, reverse-proxy topology и практические troubleshooting notes. Текущий основной путь - providers/telemt, а mtg и официальный MTProxy пока остаются запланированными вариантами.

Быстрый старт

curl -fsSL https://raw.githubusercontent.com/ichinya/mtproxy-installer/main/install.sh | sudo bash

Почему это полезно

  • Один рабочий install path - стартовая установка строится вокруг An0nX/telemt-docker и telemt/telemt
  • Готовый Docker Compose layout - installer создает структуру под providers/telemt и локальный Control API
  • Быстрый выход на tg://proxy - после запуска installer пытается получить готовую ссылку из API telemt
  • Практические deployment notes - в репозитории уже есть reverse-proxy примеры, provider strategy и troubleshooting

Что этот installer не обещает

  • голосовые звонки Telegram нельзя считать supported use case для MTProto proxy path;
  • успешная установка означает доступ к Telegram, media и локальному Control API, но не гарантию рабочих calls;
  • если calls являются жестким требованием, это нужно проверять отдельным сетевым путем, а не считать дефектом installer-а по умолчанию.

Пример

curl -fsSL https://raw.githubusercontent.com/ichinya/mtproxy-installer/main/install.sh | \
  sudo env PORT=8443 TLS_DOMAIN=habr.com PROXY_USER=public bash

Этот запуск оставляет основной путь на telemt, но меняет внешний порт, TLS-домен и имя пользователя для ссылки прокси.


Документация

Раздел Описание
Getting Started Установка, ручной запуск и первая проверка
Configuration Переменные окружения и ключевые параметры telemt.toml
Providers Стратегия по провайдерам и границы текущего default path
Upstream Repositories Карта внешних репозиториев и их роль
Installation Strategy План эволюции installer-а и будущего selector-а
Reverse Proxy Схемы с nginx stream и Traefik TCP
Troubleshooting Практические проблемы и рабочие обходы

Дополнительно

Операции

Скрипт Описание
install.sh Установка с нуля
update.sh Обновление образа и перезапуск (сохраняет конфиг)
uninstall.sh Удаление контейнера, образа и данных
# Обновление
curl -fsSL https://raw.githubusercontent.com/ichinya/mtproxy-installer/main/update.sh | sudo bash

# Удаление
curl -fsSL https://raw.githubusercontent.com/ichinya/mtproxy-installer/main/uninstall.sh | sudo bash

# Удаление с сохранением данных
curl -fsSL https://raw.githubusercontent.com/ichinya/mtproxy-installer/main/uninstall.sh | sudo env KEEP_DATA=true bash

Локальная разработка

Command Description
make setup создать локальные .env и telemt.toml из example-файлов
make dev поднять локальный Telemt stack через root docker-compose.yml
make test прогнать shell smoke-checks и проверить compose-конфиги
make lint проверить install.sh через shellcheck
make build провалидировать root/provider Compose manifests
make docker-logs посмотреть логи контейнера telemt

Запусти make help, чтобы увидеть полный список targets.

Лицензия

Лицензия в репозитории пока не указана.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages