Cluster · разработчикам
Документация Cluster
Cluster содержит ядро Telegram-юзербота с модулями и HTTP API для отдельного сайта или Mini App. Профиль Cluster, подключение Telegram и экземпляры модулей имеют разные идентификаторы и права. С них удобно начать знакомство с устройством проекта.
Основы
- Руководства для пользователей: подключение Telegram, настройка команд и первый модуль.
- Знакомство с Cluster: назначение, подключение и работа модулей.
- Устройство: процессы, компоненты и границы доступа.
- Функционал: операции ядра и ограничения реализации.
- Параметры: профиль, тарифы и подписка.
- Права: разрешения модулей, овнеры и доверка.
- Администрирование и модерация: пользователи, версии маркета и проверка данных сервиса.
Разработка модулей
- Первый модуль и публикация: краткое руководство с двумя полными примерами.
- Для разработчиков: создание первого пакета, команды, данные, конфигурация, кнопки и страницы.
- Модули: класс, обработчики, кнопки, поля и страницы.
- API модуля: типы, аргументы, результаты и примеры.
- Telegram и боты: подключение, методы и ошибки.
- Конструкторы Telegram: Bot API, Telethon, вложенные объекты и личные формы.
- Вебшоп: пакет, версия, сборка, установка и обновление.
- Проверка перед выпуском: описание, права, запуск, обновление и диагностика ошибок.
- Обмен: договор, ресурс и передача между юзерботами.
Первый публикуемый модуль в examples/quickstart, рядом его описание. Расширенный Ping добавляет баннер и сведения о юзерботе. Команда, кнопка и страница с готовым описанием в examples/publish. Поля всех типов и страницы пульта в examples/showcase. Примеры examples/module и examples/tools используются также для операторских проверок и имеют отдельный формат описания.
Заметки объединяют команду, данные, настройку заголовка и действия страницы. Рядом находится описание пакета.
Составной модуль: кнопки, файлы, сеть, расписание и вызовы зависимости с двумя готовыми пакетами.
HTTP API
- Профиль и вход: почта, пароль, TOTP, Mini App и удаление.
- HTTP: форматы, сеанс, CSRF и методы сайта.
- Сайт: React, TypeScript, сборка и запуск рядом с API.
- Маршруты: полный перечень с параметрами.
Установка и обслуживание
- Ядро: локальный запуск, ключ, среды и ограничения.
- Хранилище: квота, файлы, терминал, копии и восстановление.
- Mekansm: владение базами и прикладная модель данных.
- Развёртывание: зависимости, systemd, HTTPS и проверка служб.
- Оплата: режимы Stripe, подтверждения, автопродление и возвраты.
Все примеры используют вымышленные адреса и идентификаторы. Для работы со своими службами нужны собственные параметры SMTP, Telegram и сервисного бота.
Профили и друзья: видимость, заявки, изображения и овнеры.