Code Monkey home page Code Monkey logo

guardianvpn's Introduction

GuardianVPN Telegram Bot

GuardianVPN

The GuardianVPN Telegram Bot allows users to connect to OpenVPN and WireGuard servers, generate configuration files, and purchase VPN access passes for a selected duration using their preferred payment method.

Features

• Generate VPN configuration files with ease via Telegram Bot
• Connect to OpenVPN and WireGuard servers
• Payment options to purchase VPN access passes for a selected duration
• Additional command handlers to provide information about the VPN service

Installation

  1. Create a new Telegram bot using BotFather:
    • Open Telegram and search for BotFather
    • Type /start to start the conversation with BotFather
    • Type /newbot and follow the instructions to create a new bot
    • BotFather will provide you with a TELEGRAM_API_TOKEN. Save it for later use
  2. Clone this repository and navigate to the project directory
  3. Install the required dependencies using pip install -r requirements.txt
  4. Create a config.py file and set the necessary environment variables (TELEGRAM_API_TOKEN)
  5. Run python bot.py script
  6. Start the bot in Telegram by searching for the bot name and clicking on the start button

Note: By default, this project uses PiVPN to configure a VPN server, however, you can modify the code to add your own desired options.

The Payment options feature enables users to purchase VPN access passes for a selected duration using their preferred payment method. The configuration file will be generated after payment. Please note that to enable payments in your bot, you will need to set up a payment provider and obtain a payment provider token. Telegram's BotFather provides instructions for setting up payments in your bot.

Usage

Once the bot is running, users can interact with it by sending commands via Telegram. The available commands are:
/about: Get information about the bot and its features
/generate_config: Generate a new configuration file
/getapp: Get a download link for both OpenVPN and Wireguard apps
/limitations: Learn about bot's limitations
/privacy: View privacy policy
/start: Start the bot and get a welcome message
/status: Check the status of VPN server
/support: Contact us
/terms: Read our terms and conditions
/tutorial: Instructions on how to use a VPN configuration files
/whatsnew: Latest updates and improvements

Future Development

Here are some ideas for potential future developments to this project:
Add support for the Wireguard VPN protocol (In progress)
• Allow users to choose a specific country for their VPN connection

Contributions

Contributions to this project are welcome. If you find a bug or have a feature request, please open an issue on the GitHub repository. If you'd like to contribute code, please fork the repository and submit a pull request.

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.