Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/t0mer/wolbot
Wolbot is a python powerd telegram bot for Wak On LAN tasks
https://github.com/t0mer/wolbot
bot python telegram-bot wake-on-lan wol
Last synced: 2 months ago
JSON representation
Wolbot is a python powerd telegram bot for Wak On LAN tasks
- Host: GitHub
- URL: https://github.com/t0mer/wolbot
- Owner: t0mer
- License: gpl-3.0
- Created: 2023-12-25T17:11:17.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-06-10T03:23:34.000Z (7 months ago)
- Last Synced: 2024-10-02T08:06:53.013Z (3 months ago)
- Topics: bot, python, telegram-bot, wake-on-lan, wol
- Language: Python
- Homepage: https://www.medium.com/@tomer.klein
- Size: 619 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wolbot
Wolbot is a python powerd telegram bot for Wak On LAN tasks.
## Features
- List devices (All/Online/Offline) with status.
- Send magic packet to wake up the devices.
## Components and Frameworks used in Certi
* [Loguru](https://pypi.org/project/loguru/) a library which aims to bring enjoyable logging in Python.
* [PyYAML](https://pypi.org/project/PyYAML/) a data serialization format designed for human readability and interaction with scripting languages.
* [pyTelegramBotAPI](https://pypi.org/project/pyTelegramBotAPI/) A simple, but extensible Python implementation for the Telegram Bot API.
* [wakeonlan](https://pypi.org/project/wakeonlan/) A small python module for wake on lan.
## Installing Wolbot
Wolbot can be installed and run as a system service or a Docker container.
1. Create new telegram bot and get the token
Open [Telegram messenger](https://web.telegram.org/), sign in to your account or create a new one.
Enter @Botfather in the search tab and choose this bot (Official Telegram bots have a blue checkmark beside their name.)
[](https://github.com/t0mer/voicy/blob/main/screenshots/scr1-min.png?raw=true "@Botfather")
Click “Start” to activate BotFather bot.
[](https://github.com/t0mer/voicy/blob/main/screenshots/scr1-min.png?raw=true "@start")
In response, you receive a list of commands to manage bots.
Choose or type the /newbot command and send it.
[](https://github.com/t0mer/voicy/blob/main/screenshots/scr3-min.png?raw=true "@newbot")
Choose a name for your bot — your subscribers will see it in the conversation. And choose a username for your bot — the bot can be found by its username in searches. The username must be unique and end with the word “bot.”
[](https://github.com/t0mer/voicy/blob/main/screenshots/scr4-min.png?raw=true "@username")
After you choose a suitable name for your bot — the bot is created. You will receive a message with a link to your bot t.me/, recommendations to set up a profile picture, description, and a list of commands to manage your new bot.
[](https://github.com/t0mer/voicy/blob/main/screenshots/scr5-min.png?raw=true "@bot_username")
2. Update the configuration file with the list of network objects. the file should be place under **config** folder:
```yaml
computers:
- name:
ip:
mac:
```
3. Set the following environment variables:
- BOT_TOKEN=#Telegram bot Token generated in the previous step.
- ALLOWED_IDS= #List of telegram id's allowed to communicate with the bot, comma-separated values.
4. If you want to run Wolbot as a ***docker container***, copy the following code into your docker-compose.yaml:
```yaml
version: "3.6"
services:
wolbot:
image: techblog/wolbot
container_name: wolbot
restart: always
environment:
- BOT_TOKEN= #Telegram bot Token.
- ALLOWED_IDS= #List of telegram id's allowed to communicate with the bot, comma-separated values.
```
**Make sure to set all the environment variables before running the *"docker-compose up -d"* command.
5. If you want to run Wolbot as a systemd service, clone the repository using the following command:
```bash
git clone https://github.com/t0mer/wolbot
```
enter the *wolbot* folder and install the dipendencies:
```bash
pip3 install -r requirements.txt
```
Next, create a file names **"wolbot.service"** under **/etc/systemd/system"** and paste the following content:
```bash
[Unit]
Description=Wake On Lan bot
After=network-online.target
Wants=network-online.target systemd-networkd-wait-online.service
StartLimitIntervalSec=5
StartLimitBurst=5
[Service]
EnvironmentFile=/etc/environment
KillSignal=SIGINT
WorkingDirectory=/opt/dev/wolbot/app/
Type=simple
User=root
ExecStart=/usr/bin/python3 /opt/dev/wolbot/app/app.py
Restart=always
[Install]
WantedBy=multi-user.target
```
***Make sure to adjust the path for "WorkingDirectory" and "ExecStart" accordingly to the path of the Wolbot location***
Next, run the following command to enable and start the service:
```bash
systemctl enable wolbot.service
systemctl start wolbot.service
```
To check the status of the service, run the following command:
```bash
systemctl status wolbot.servies
```
## Using Wolbot
To start using **Wolbot** send one of the following commands: **/start** ot **/help**.
A shortcut menu will be opened, with four options:
* Show all computers.
* Show online computers.
* Show offline computers.
* Cancel.
Click on one of the first three options, and a list of computers will be displayed:
Click on one of the computers to wake it up:
