VPN Generator Distributor

Более детальная инструкция и скриншоты доступны на русском языке.

This is a Telegram bot to manage multiple VPN servers, which are provided by the VPN Generator project.

It centralizes management of separate VPNGen servers automating most of the cumbersome manual labor.

The bot has a public interface: it allows regular non tech-savvy users to request keys, delivers them automacially, and shares installation instructions with them.

In addition, the bot offers some admin conveniences via private interfaces:

• It cleans up the servers from inactive users on demand;
• The bot provides a simple support ticket system.
• When requesting support, user messages are redirected to the admin Telegram supergroup and back ensuring support agents don't have access to user's personal data
• It allows maintainers to unilaterally reach VPN key holders via mass message broadcasts;
• It lets maintainers to personalize some of the bot's public messages;
• Finally, the administrator can plainly issue keys without ever entering the server's admin panel.

For managing a single server via Telegram privately, VPN-Generator-Manager can be of help.

The bot communicates in Russian only.

Development

Prerequisites

• Ruby 4.0.1
• SQLite3

sudo apt update
sudo apt install sqlite3 libsqlite3-dev

• shadowsocks-libev

sudo apt update
sudo apt install shadowsocks-libev

• Populate your .env according to the example file
• Install dependencies via bundle i

Executables

To start the bot:

bin/start

To start the bot in the IRB mode without Telegram listener:

bin/console

To run the tests:

bin/test

Deploy

Deploy using docker-compose.yml. Consult the example file. Make sure the files in the mounted volumes - database, instructions, and slides - are persisted between deploys.