Установка и настройка Telegram бота
Получить дополнительную информацию о требованиях к серверу и установке приложения можно на официальном сайте фреймворка.
Расположенный в корне файл ".env" является основным конфигом приложения.
Для редактирования его содержимого подходит любой текстовый редактор.
| Ключ | Описание |
|---|---|
| APP_NAME | Название приложения |
| APP_VERSION | Версия приложения |
| APP_ENV | Режим работы |
| APP_KEY | Секретный ключ приложения |
| APP_DEBUG | Отладка ошибок |
| APP_SHOW_MODE | Режим демонстрации |
| APP_URL | URL адрес приложения |
| APP_LOCALE | Язык приложения по умолчанию |
| CACHE_TIME | Время кеширования |
| EXCHANGER_URL | URL адрес обменника |
| EXCHANGER_DASHBOARD_API_TOKEN | Секретный ключ API панели управления |
| EXCHANGER_PRIVATE_API_TOKEN | Секретный ключ приватного API |
| EXCHANGER_WEBHOOKS_SECRET_KEY | Секретный ключ веб-хуков |
| TELEGRAM_BOT_TOKEN | Секретный ключ полученный после регистрации бота в Telegram |
| TELEGRAM_BOT_BANLIST | Список заблокированных Telegram аккаунтов |
| TELEGRAM_BOT_LOG | Логирование диалогов |
Прежде чем начинать настройку, необходимо зарегистрировать бота и получить его уникальный токен. Для этого в Telegram существует специальный бот "BotFather", при помощи которого меняются настройки у существующих ботов и создаются новые.
Напишите команду /newbot, чтобы создать нового бота. Бот спросит у вас название нового бота и предложит придумать его логин на латинице. Логин должен состоять из букв латинского алфавита, подчёркиваний и цифр и быть длиной от 5 до 32 символов. Также логин обязательно должен заканчиваться на "bot", например: "exchanger_bot" или "ExchangerBot".
По завершению регистрации вы получите токен, который нужно указать в файле конфигураций приложения.
Перейдите в панель управления, в раздел "Настройки приложения" — "Настройка API панели управления". Выпустите секретный ключ и активируйте API.
Перейдите в панель управления, в раздел "Настройки приложения" — "Настройка приватного API". Выпустите секретный ключ и активируйте API.
Перейдите в панель управления, в раздел "Настройки приложения" — "Настройка веб-хуков". Выпустите секретный ключ и активируйте API.
Используя командную строку на сервере и интерфейс Artisan, выполните команду для установки URL обработчика веб-хуков. Убедитесь при этом что вы находитесь в корневой директории приложения.
Команда для выполнения:
php artisan set-webhook-url
Пример вывода:
[success] Webhook handler URL: https://tbot.exchanger-cms.com/webhook-handler-3ehPCZrnY6QmCWP32VdFBAWNn
Если на хостинге нет доступа к командной строке, вы можете использовать URL адрес ./setup, убедитесь что во время перехода по нему, значение параметра APP_DEBUG в файле конфигураций установлено на true, после успешной настройки значение необходимо изменить на false.
Директория с языковыми каталогами расположена по пути /resources/lang, каждый каталог содержит ряд языковых файлов:
| Файл | Описание |
|---|---|
| buttons.php | Тексты кнопок |
| commands.php | Описания команд |
| keyboards.php | Тексты главного меню |
| languages.php | Названия языков |
| messages.php | Тексты сообщений |
| words.php | Прочие слова |
Для добавления дополнительной локализации достаточно скопировать один из существующих языковых каталогов, а так же внести изменения в языковый файл languages.php для всех языковых каталогов.
Для удаления локализации достаточно удалить языковый каталог целиком.
Отключение команд может быть произведено в файле по пути /config/telegram.php, при помощи комментирования с использованием двойного слеша.
Пример отключенной команды:
'commands' => [
...
// App\Commands\SoftwareCommand::class,
...
];
Для обеспечения наилучшей безопасности рекомендуется подключить приложение к CDN сервису CloudFlare и произвести настройку фаервола, это можно сделать даже на бесплатном тарифе. Для этого после подключения сайта перейдите в раздел "Firewall" — "Firewall Rules", нажмите кнопку "Create a Firewall rule". Заполните форму как показано на изображении используя свои данные.
Страница настроек правил фаервола CloudFlare
В результате доступ к приложению будет разрешен только по URL адресу обработчика веб-хуков, который использует Bot API. В остальных случаях доступ будет заблокирован.
При отправке API запросов на сайт обменника, приложение телеграм бота устанавливает собственный HTTP заголовок User-Agent: Exchanger-CMS-Telegram-Bot/1.0.0, это может быть полезно для отслеживания заявок на обмен, созданных с использованием телеграм бота.
APP_NAME=Exchanger-CMS-Telegram-Bot APP_VERSION=1.1.0 APP_ENV=production APP_KEY=bu5Ahbu6yai9vaibeeweiyeofie1phai APP_DEBUG=false APP_SHOW_MODE=false APP_URL=https://tbot.exchanger-cms.com APP_LOCALE=ru CACHE_TIME=60 EXCHANGER_URL=https://prod.exchanger-cms.com EXCHANGER_DASHBOARD_API_TOKEN=ioX7keu1peesi4junes0chaifaig2cha EXCHANGER_PRIVATE_API_TOKEN=ioX7keu1peesi4junes0chaifaig2cha EXCHANGER_WEBHOOKS_SECRET_KEY=xoohiiXohk3fohcheingieXie7mae5Ep TELEGRAM_BOT_TOKEN=1359008999:AAEx5MW94Ehneo6oCpM69U-VHG1oyD_YWVs TELEGRAM_BOT_BANLIST= TELEGRAM_BOT_LOG=true https://tbot.exchanger-cms.com/exchanger-webhook/bu5Ahbu6yai9vaibeeweiyeofie1phai/call-handler