Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bl4ckm45k/vpnbot
Telegram bot on Marzban for Free VPN access with Outline and Xray Core client support
https://github.com/bl4ckm45k/vpnbot
marzban outline vpnfree
Last synced: 9 days ago
JSON representation
Telegram bot on Marzban for Free VPN access with Outline and Xray Core client support
- Host: GitHub
- URL: https://github.com/bl4ckm45k/vpnbot
- Owner: bl4ckm45k
- Created: 2022-06-11T14:14:51.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-22T22:24:55.000Z (20 days ago)
- Last Synced: 2024-11-22T23:18:24.074Z (20 days ago)
- Topics: marzban, outline, vpnfree
- Language: Python
- Homepage: https://t.me/bl4ckm45k_vpn_bot
- Size: 85.9 KB
- Stars: 45
- Watchers: 4
- Forks: 11
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-freedom - VPNbot
- awesome-freedom - VPNbot
README
### [Русский язык](README_RU.md)
### Source code of the Telegram bot [bl4ckm45k_vpn_bot](https://t.me/bl4ckm45k_vpn_bot "bl4ckm45k_vpn_bot")
`For security purposes and easy setup, this bot supports only VLESS tcp or grpc protocols with REALITY
with automatic generation of private keys and ShortID.
For more reliable encryption, always install TLS certificates for the VLESS, VMESS and Trojan protocols
`
### If you need a bot for providing paid access:
#### [Description of the paid bot functionality](https://github.com/bl4ckm45k/vpnbot/blob/master/README_PAID_BOT.md "Description of the paid bot functionality")
#### [Contact on TG: pay4fallwall](https://pay4fallwall.t.me/ "pay4fallwall")
### Setup
- Clone this repository
- Navigate to the bot's directory
```bash
cd vpnbot
```
Rename the file `env.dist` to `.env`
```bash
cat env.dist > .env
```
Replace `BOT_TOKEN` with your token
In `ADMIN`, specify the Telegram user ID of the administrator.
You can find out your user ID through the [Get My ID bot](https://t.me/getmyid_bot "Get My ID bot")
Do not change the parameters `USE_WEBHOOK` and `False`, otherwise the bot will not work.
Other parameters are not used in the open-source version.
### Marzban Parameters
To set up the login and password, change the variables `SUDO_USERNAME` and `SUDO_PASSWORD` in the .env.marzban file.
### Launch
```bash
docker compose up --detach
```
Done. The bot will output all host keys from the Marzban panel.
### The Marzban panel will be accessible on port `8002`