pytmbot

pyTMbot Docker Image

Welcome to the pyTMbot Docker Hub page! This guide will walk you through setting up and running pyTMbot step-by-step, ensuring a smooth experience from initial configuration to deployment.

🐋 Image Overview

• Image Name: orenlab/pytmbot
• Tags:
  • latest - The latest stable release image based on Alpine Linux.
  • 0.X.X - Specific stable release versions based on Alpine Linux.
  • alpine-dev - Latest development version based on Alpine Linux.

🚀 Step-by-Step Setup

1️⃣ Preparing for Deployment

Before we begin, ensure you have Docker and Docker Compose installed on your system. If not, please refer to the Docker documentation for installation instructions.

2️⃣ Generating the Authentication Salt

To securely configure the bot, you’ll need a unique salt value for Time-Based One-Time Passwords (TOTP). Run the following command to generate it:

sudo docker run --rm orenlab/pytmbot:latest --salt

Save the generated salt for later use in the pytmbot.yaml configuration.

3️⃣ Configuring the Bot

Create a pytmbot.yaml file to define your bot’s settings. Here’s how:

• Download the Configuration File:

sudo curl -o /root/pytmbot.yaml https://raw.githubusercontent.com/orenlab/pytmbot/refs/heads/master/pytmbot.yaml.sample

• Edit the Configuration File:

nano /root/pytmbot.yaml

Please follow the instructions provided in the sample configuration.

4️⃣ Creating the docker-compose.yml File

Now, create a docker-compose.yml file to define the container configuration:

services:
  pytmbot:
    image: orenlab/pytmbot:latest
    container_name: pytmbot
    restart: on-failure
    environment:
      - TZ=Asia/Yekaterinburg
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
      - /root/pytmbot.yaml:/opt/app/pytmbot.yaml:ro
    security_opt:
      - no-new-privileges
    read_only: true
    cap_drop:
      - ALL
    pid: host
    logging:
      options:
        max-size: "10m"
        max-file: "3"
    command: --plugins monitor,outline # if needed

5️⃣ Deploying the Container

Start the bot using Docker Compose:

docker-compose up -d

Alternatively, you can launch the container directly with the Docker CLI:

docker run -d \
--name pytmbot \
--restart on-failure \
--env TZ="Asia/Yekaterinburg" \
--volume /var/run/docker.sock:/var/run/docker.sock:ro \
--volume /root/pytmbot.yaml:/opt/app/pytmbot.yaml:ro \
--security-opt no-new-privileges \
--read-only \
--cap-drop ALL \
--pid=host \
--log-opt max-size=10m \
--log-opt max-file=3 \
orenlab/pytmbot:latest --plugins monitor,outline

🔌 Plugins Configuration

pyTMbot supports an extensive plugin system to extend its functionality. Below are examples for commonly used plugins:

Monitor Plugin

The Monitor Plugin tracks system metrics and Docker events.

Outline VPN Plugin

To monitor your Outline VPN

For more detailed plugin configurations, visit the plugins documentation.

🛠️ Updating the Image

Keep your pyTMbot image up to date by following these steps:

1. Stop and Remove the Current Container:

   sudo docker stop pytmbot
   sudo docker rm pytmbot
   

2. Pull the Latest Image:

   sudo docker pull orenlab/pytmbot:latest
   

3. Restart the Container:

   docker-compose up -d
   

👾 Support & Resources

• Support: GitHub Issues
• Source Code: GitHub Repository
• Discussions: GitHub Discussions

📜 License

This site is open source. Improve this page.