Skip to content

INSTALLATION.md

Latest commit

 

History

History
161 lines (120 loc) · 3.87 KB

INSTALLATION.md

File metadata and controls

161 lines (120 loc) · 3.87 KB

Installation Guide 🛠️

This guide provides detailed instructions on how to set up, configure, and deploy QRBot.

Table of Contents

Prerequisites

Before you begin, ensure you have the following installed:

  • Python 3.9 or higher
  • Git
  • A Telegram account and a Bot Token (Get one from @BotFather)
  • libzbar: Required for reading QR codes (see OS-specific instructions below).

Local Installation

Windows

  1. Clone the Repository

    git clone https://github.com/zis3c/QRBot.git
cd QRBot

  2. Create a Virtual Environment (Recommended)

    python -m venv venv
.\venv\Scripts\Activate

  3. Install Dependencies

    pip install -r requirements.txt

    Note: On Windows, the pyzbar library usually includes the necessary DLLs. If you encounter errors, you may need to install the Visual C++ Redistributable.

  4. Configure Environment See the Configuration section.

  5. Run the Bot

    python bot.py

Linux (Ubuntu/Debian)

  1. Install System Dependencies

    sudo apt-get update
sudo apt-get install libzbar0

  2. Clone and Setup

    git clone https://github.com/zis3c/QRBot.git
cd QRBot
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

  3. Run

    python bot.py

macOS

  1. Install zbar via Homebrew

    brew install zbar

  2. Clone and Setup

    git clone https://github.com/zis3c/QRBot.git
cd QRBot
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Configuration

QRBot uses environment variables for configuration. You can set these in your terminal or use a .env file (if you install python-dotenv).

Required Variables

Variable Description
TELEGRAM_BOT_TOKEN Your Telegram Bot API Token obtained from @BotFather.

Optional Variables

Variable Description Default
ADMIN_IDS Comma-separated list of Telegram User IDs for admin access. None
PORT Web server port (for checking keep-alive status). 10000

Setting up .env (Local Development)

  1. Create a file named .env in the root directory.
  2. Add your variables: 
    TELEGRAM_BOT_TOKEN=123456789:ABCdefGhIjkLmnOpQrStUvWxYz
ADMIN_IDS=12345678,87654321

Docker Deployment

Docker is the easiest way to run QRBot in a consistent environment.

  1. Build the Image

    docker build -t qrbot .

  2. Run the Container

    docker run -d \
  -e TELEGRAM_BOT_TOKEN="your_token_here" \
  -e ADMIN_IDS="12345678" \
  --name qrbot_instance \
  qrbot

Cloud Deployment (Render)

This repository is configured for easy deployment on Render.

  1. Fork this repository to your GitHub account.
  2. Log in to Render and click New + -> Web Service.
  3. Select your forked QRBot repository.
  4. Render should automatically detect the render.yaml or Dockerfile.
    • Runtime: Docker
  5. Environment Variables:
    • Add TELEGRAM_BOT_TOKEN (Required)
    • Add ADMIN_IDS (Optional)
  6. Click Create Web Service.

The bot will start automatically and stay awake thanks to the built-in keep-alive server.