Skip to content

exmanka/ksiVPN-telegram-bot

Repository files navigation

license python-version aiogram-version asyncpg-version apscheduler-version gpt4free-version aiomoney-version docker-compose-version telegram-channel telegram-bot

ksiVPN Telegram Bot

showcase-en showcase-ru

Multifunctional telegram bot for ksiVPN project based on aiogram framework and using modules: asyncpg2, apscheduler, aiomoney, gpt4free. Deployment is possible using Docker with docker-compose.

Features

  • aiogram2 support
  • PostgreSQL usage
  • P2P payments via YooMoney
  • ChatGPT integration
  • subscription mechanics: renewal, expiration notifications
  • promocodes mechanics
  • referral system mechanics
  • personal account mechanics
  • localizations support
  • panels for unauthorized users, authorized users and admin
  • rapid deployment via Docker
  • database backups via bot
  • asynchronous code
  • logging

Use Case diagram

Use Case diagram can be found here.

PostgreSQL database diagram

db-diagram

Installation

  1. Install Docker with Docker Compose according to the official instructions.
  2. Install git according to the official instructions.
  3. Register new telegram bot using BotFather and get bot's token.
  4. git clone https://github.com/exmanka/ksiVPN-telegram-bot.git — download the repository to your computer.
  5. cd ksiVPN-telegram-bot — move to project directory.
  6. Change text file .env according to your needs.
    Important: all environment variables marked with # ! sign MUST be entered!
  7. docker compose up — build images and run containers.

Usage

Now you can write to your bot and enjoy all its pre-installed features. You are free to play with functionality and database filling. Learn something new for yourself! 🎉

About ksiVPN project

🔥 ksiVPN — an open source student project that has become something more not only for its creator, but also for most customers .Thanks to hard work, the use of basic modern protocols and competent server rental, the project is able to provide the highest quality VPN connection for the minimum cost.

ksiVPN uses the following open-source solutions:

PROMO_GITHUB_2049