Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/uxumax/access_telebot
Access Telebot is a Telegram bot designed to facilitate the sale of subscriptions to private Telegram channels using your own cryptocurrency merchant. It allows you to accept USDT payments directly to your TRON address without any intermediaries.
https://github.com/uxumax/access_telebot
access-control crypto-merchant-bot seller-bot telegram-bot trc20pay
Last synced: about 2 months ago
JSON representation
Access Telebot is a Telegram bot designed to facilitate the sale of subscriptions to private Telegram channels using your own cryptocurrency merchant. It allows you to accept USDT payments directly to your TRON address without any intermediaries.
- Host: GitHub
- URL: https://github.com/uxumax/access_telebot
- Owner: uxumax
- License: gpl-3.0
- Created: 2024-01-18T05:49:35.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-11-09T15:07:32.000Z (2 months ago)
- Last Synced: 2024-11-09T15:19:22.308Z (2 months ago)
- Topics: access-control, crypto-merchant-bot, seller-bot, telegram-bot, trc20pay
- Language: Python
- Homepage:
- Size: 764 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Access Telebot
Access Telebot is a Telegram bot designed to facilitate the sale of subscriptions to private Telegram channels using your own cryptocurrency merchant. It allows you to accept USDT payments directly to your TRON address without any intermediaries.
## Features
- Sell subscriptions to private Telegram channels.
- Accept payments directly to your TRON address.
- No middlemen involved.
## Getting Started
This project is containerized using Docker, making it easy to build and start.
### Prerequisites
Ensure you have Docker Engine installed. If not, follow the installation guide [here](https://docs.docker.com/engine/install/). If you want to run Docker as a non-root user, do not forget about [this](https://docs.docker.com/engine/install/linux-postinstall/#manage-docker-as-a-non-root-user).
### Installation
1. **Generate the .env file:**
Ensure you have both the [Telegram Bot API key](https://t.me/botfather) and the [Tron Grid API key](https://www.trongrid.io/).
Run `create_dotenv.sh` to generate a `.env` file.
```
./create_dotenv.sh
```
The script will prompt you for `TELEBOT_KEY` and `TRONGRID_KEY`.
You can skip the interactive input setting empty and manually set them in the created `.env` file.
The generated `FIELD_ENCRYPTION_KEY` in `.env` file is very important. Copy it and store it in a safe place. Without this key, you could lose the funds you receive from merchant sales.
3. **Build the Docker containers:**
```sh
docker compose build
```
4. **Run the containers and start the bot:**
```sh
docker compose up
```
Wait approximately 30 seconds for all services to initialize. Once ready, you can start interacting with the bot for testing purposes. Note that Nginx port `8082` and Postgres port `5445` should be free on your docker host machine otherwise feel free change them to any in `.env`.
### Easy Setup AccessBot on System Startup
To start all Docker services start automatically when your system startup, simply run the following script:
```sh
./docker/start_on_os_startup.sh
```
### Admin Panel
The bot's Django admin panel should be available at `localhost:8082/secret_way/admin`. You can change `secret_way` to any secret phrase in the `.env` file. Also you can find default Django admin login and password there
### Add Chats and Create Subscriptions
A Chat model represents your private channel or group that you intend to sell access to. Do not manually create Chat instances. First, set your Telegram bot as an administrator of your private channel or group. Once added as an administrator, the channel or group will appear in the admin panel as a `Chat` model instance. After this, you can manually create `Subscription` instances with your preferred periods and prices. Trial periods supported.
### Tron Address Model
This table contains addresses and private keys of TRON chain wallets. New wallet creates automatically when all others are busy.
### Using Django Manage from the Host
You can execute Django management commands (`python3 manage.py`) directly from the Docker host without needing to access the web container's shell. Simply use the script `docker/manage.sh `. For example:
```bash
docker/manage.sh generate_field_encryption_key
```
Please ensure that all Docker Compose services are running. A list of all available commands can be found in `docs/commands.md`.
### Exporting Tron Wallets
To manage your USDT, you need to export your TRON wallets for use in a regular crypto app. Use the following command to export all wallets with their private keys:
```
docker/manage.sh export_tron_wallets
```
After exporting, you can copy the private keys and import them into the [TronLink Wallet](https://www.tronlink.org/) for management. You can continue to use these wallets to receive payments even after importing them into the that app.
### Changing Text of Bot Messages
Use can use Translations to change bot messages text. At first generate your first translation with name `easy`
```bash
docker/manage.sh make_translations easy
```
You can find the generated translations in the Django admin under the `messenger.Translation` instances. Here, you can modify them by filling in the `TO_TEXT` for each original `FROM_TEXT`. Set your `TRANSLATION_NAME` in the .env file, and restart the entire project or just the `web` service when you're finished.
## Note
This README is a work in progress. Additional details will be added later.