amnezia-bot/README.upstream.md

AmneziaVPN Telegram Bot

Телеграм-бот на Python для управления AmneziaVPN. Этот бот позволяет легко управлять клиентами.

Используется библиотека aiogram версии 2.25.2.
Протестировано на Ubuntu, версии 20.04, 22.04, 24.04.

Оглавление

• Возможности
• Установка
• Запуск
• Заметки
• Поддержка

Возможности

• Добавление администраторов и модераторов для упралением VPN
• Добавление клиентов
• Удаление клиентов
• Получение информации об IP-адресе клиента (берется из Endpoint, используется API ресурса ip-api.com)
• Создание ключа в формате vpn:// при генерации нового клиента (так же, при получении конфигурации клиента), для использования в AmneziaVPN
• Создание резервной копии
• Инструкции по работе с VPN

Установка

1. Установите AmneziaVPN (без данного шага бот РАБОТАТЬ НЕ БУДЕТ).

2. Пройдите первоначальную инициализацию, выбрав протокол AmneziaWG, в клиенте AmneziaVPN.

3. Создайте бота в Telegram:

• Откройте Telegram и найдите бота BotFather.
• Начните диалог, отправив команду /start.
• Введите команду /newbot, чтобы создать нового бота.
• Следуйте инструкциям BotFather, чтобы:
  • Придумать имя для вашего бота (например, AmneziaWGBot).
  • Придумать уникальное имя пользователя для бота (например, AmneziaWGManagerBot_bot). Оно должно оканчиваться на _bot.
• После создания бота BotFather отправит вам токен для доступа к API. Его запросит бот во время первоначальной инициализации.

4. Получите ваш Telegram ID с помощью Get My ID, просто написав боту.

5. Загрузите и запустите скрипт install.sh, с помощью которого будет автоматически установлен бот, со всеми зависимостями, в том числе, в качестве системной службы (автозапуск):

   curl -O https://raw.githubusercontent.com/stevefoxru/amnezia-bot/main/install.sh && chmod +x install.sh && ./install.sh
   

Запуск

1. Добавьте бота в Telegram и отправьте команду /start или /help для начала работы.

Заметки

Для обновления бота, необходимо запустить скрипт install.sh. В меню, необходимо выбрать пункт Проверить обновления.

При создании резервной копии, в архив добавляется директория connections (создается и содержит в себе логи подключений клиентов), conf, png, и сам конфигурационный файл.

Поддержка

Поддержать разработчика можете следующими способами:

Если у вас возникли вопросы или проблемы с установкой и использованием бота, создайте issue в этом репозитории или обратитесь к разработчику.