https://github.com/frkn-dev/vpn-bot
TG Bot for FRKN
https://github.com/frkn-dev/vpn-bot
Last synced: 10 months ago
JSON representation
TG Bot for FRKN
- Host: GitHub
- URL: https://github.com/frkn-dev/vpn-bot
- Owner: frkn-dev
- License: gpl-3.0
- Created: 2025-06-25T23:00:42.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2025-08-08T12:24:28.000Z (10 months ago)
- Last Synced: 2025-08-08T14:30:29.838Z (10 months ago)
- Language: TypeScript
- Size: 152 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# VPN Telegram Bot
A Telegram bot for managing VPN connections, implemented in TypeScript.
Description
This bot allows users to create and retrieve VPN configurations (VlessGrpc, VlessXtls, Vmess, Wireguard, etc.) via interactive commands and inline buttons. It communicates with a backend API server that manages users, nodes, and connections.
Features, works with https://github.com/frkn-dev/pony
### Installation & Running
Clone the repository:
```git clone https://github.com/yourusername/vpn-telegram-bot.git
cd vpn-telegram-bot
```
Install dependencies:
`npm install`
Create a .env file with your environment variables:
```
API_BASE_URL=https://your-api-server.com/api
API_AUTH_TOKEN=your_api_token_here
BOT_TOKEN=your_telegram_bot_token_here
```
Start the bot:
npm run start
## Bot Commands
/start — Start interacting with the bot
/connect — Select VPN protocol and server
/sub — Get VPN subscription/configuration
/stat — View traffic statistics
/delete — Delete (deactivate) user
### License
GNU GENERAL PUBLIC LICENSE Version 3