pytmbot

pyTMbot

pyTMbot is a versatile Telegram bot designed for managing Docker containers, monitoring server status, and extending its functionality through a modular plugin system. The bot supports both polling and webhook modes, offering flexibility based on your deployment requirements. Additionally, pyTMbot can be deployed either directly on the host machine or within a Docker container, providing flexibility in infrastructure setup.

Security Rating Vulnerabilities Quality Gate Status Bugs Maintainability Rating Code Smells Duplicated Lines (%) Codacy Badge

pyTMbot leverages the pyTelegramBotAPI, psutil, and docker-py libraries to provide robust Docker and server management tools.

πŸ’‘ Key Features

🐳 Docker Management

πŸ–₯️ Local Server Monitoring

πŸ”Œ Plugin System

Refer to plugins.md for more information on adding and managing plugins.

πŸ”– Additional Features

πŸ•Έ Requirements

Starting from version 0.9.0, pyTMbot can run either directly on the host machine or in a Docker container. Both deployment methods provide full functionality, but there are slight differences in system access depending on the environment:

The bot supports two operational modes:

To simplify the installation process, we provide an install.sh script that handles the setup, regardless of whether you choose to run pyTMbot on a host machine or within a Docker container. For full instructions on installation and configuration, refer to the installation section.

πŸ”Œ Installation and Setup

Refer to installation.md for full instructions on setting up the bot in your environment.

πŸ›‘ Security

pyTMbot comes with security-first features, such as:

Learn more about the security measures in our detailed security guide.

πŸ“ˆ Roadmap

To learn more about planned features and future updates, check the roadmap.

πŸ‹ Docker Hub

You can find the official Docker image on Docker Hub:

GitHub Release Docker Pulls Docker Image Size Github last-commit

Head to the Docker Hub repository for more details.

πŸ“š Documentation

🧬 Contributors

πŸ“œ License

MIT License

This project is licensed under the MIT License – see the LICENSE file for details.