forked from hornet/lainmonitor
Compare commits
19 commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
8515e9c4a3 | ||
|
|
b09798cada | ||
|
|
e52703fe44 | ||
|
|
1b52ceb881 | ||
|
|
88b678da3b | ||
| 93fb4f93d0 | |||
|
|
e68739966a | ||
|
|
0afffee697 | ||
|
|
f28f291a49 | ||
|
|
7e3acb68ce | ||
|
|
29cc8aedd4 | ||
|
|
c0d02bb69a | ||
|
|
f45bffd25e | ||
|
|
5d0ce49d0c | ||
|
|
edb0641889 | ||
|
|
da49859b9d | ||
|
|
a007405b4f | ||
|
|
7d157e5136 | ||
|
|
186134db0c |
5 changed files with 115 additions and 84 deletions
2
.authorized_users
Normal file
2
.authorized_users
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
AUTHORIZED_USER_ID_1
|
||||
AUTHORIZED_USER_ID_2
|
||||
1
.env
Normal file
1
.env
Normal file
|
|
@ -0,0 +1 @@
|
|||
YOUR_TOKEN_HERE
|
||||
2
.gitignore
vendored
Normal file
2
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
test.py
|
||||
venv/
|
||||
126
README.md
126
README.md
|
|
@ -1,54 +1,71 @@
|
|||
# LainMonitor
|
||||
# lainmonitor
|
||||
|
||||
LainMonitor is a Telegram bot designed to monitor your system by providing real-time information about the system's status, services, and disk usage. It can also check connectivity to a specific Tailscale IP address.
|
||||
LainMonitor is a Telegram bot designed to monitor your system, providing real-time updates on the system’s status, essential services, and disk usage. It can also verify connectivity to a specific Tailscale IP address.
|
||||
Current version: v1.2
|
||||
|
||||
## Features
|
||||
- Retrieve system hostname, uptime, and status of essential services such as:
|
||||
- Zerotier
|
||||
- Prosody
|
||||
- PostgreSQL
|
||||
- Tailscale
|
||||
- Check disk usage
|
||||
- Ping a Tailscale IP to verify connectivity
|
||||
- Use via Telegram commands like `/status`, `/ping`, and `/help`
|
||||
### Key Features:
|
||||
|
||||
## Dependencies
|
||||
- [Telebot](https://github.com/eternnoir/pyTelegramBotAPI) - A Python library for Telegram bot API.
|
||||
Retrieve system information:
|
||||
Hostname
|
||||
Uptime
|
||||
Status of critical services:
|
||||
Zerotier
|
||||
Prosody
|
||||
PostgreSQL
|
||||
Tailscale
|
||||
nginx
|
||||
Check disk usage
|
||||
Ping a Tailscale IP for connectivity verification
|
||||
Restart critical services
|
||||
Reboot the host
|
||||
Accessible via Telegram commands
|
||||
|
||||
### Prerequisites:
|
||||
|
||||
Python 3
|
||||
Telebot — Python library for interacting with the Telegram bot API.
|
||||
|
||||
### Installation Guide:
|
||||
|
||||
Clone the repository:
|
||||
|
||||
## Installation
|
||||
1. Clone this repository:
|
||||
```bash
|
||||
git clone https://git.lainlounge.xyz/hornet/lainmonitor.git
|
||||
cd lainmonitor
|
||||
```
|
||||
2. Install the required Python library:
|
||||
```bash
|
||||
pip install pyTelegramBotAPI
|
||||
```
|
||||
3. Replace the placeholder in the code with your Telegram bot token:
|
||||
```python
|
||||
TOKEN = 'PLACE_YOUR_TOKEN_HERE'
|
||||
```
|
||||
|
||||
4. Set up permissions for the bot to check system services (run as a user with `sudo` access).
|
||||
RECOMMENDED: Create a virtual environment for python with:
|
||||
```
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
Install dependencies:
|
||||
|
||||
## Usage
|
||||
|
||||
### Running Directly
|
||||
You can run the bot directly using Python:
|
||||
|
||||
```bash
|
||||
python3 lainmonitor.py
|
||||
```
|
||||
pip3 install -r requirements.txt
|
||||
```
|
||||
|
||||
### Running as a Service
|
||||
To run LainMonitor as a service, follow these steps:
|
||||
1. Create a systemd service file:
|
||||
```bash
|
||||
Configure your bot token: Open the .env file and replace the placeholder with your Telegram bot token.
|
||||
|
||||
Configure authorized users: Open the .authorized_users file and replace the placeholders with Telegram user ID(s).
|
||||
|
||||
Set up service access: Ensure the bot can check system services by running it with sudo or appropriate permissions.
|
||||
|
||||
### Usage:
|
||||
#### Running the Bot Manually:
|
||||
|
||||
You can run LainMonitor directly from the command line:
|
||||
|
||||
python3 lainmonitor.py
|
||||
|
||||
#### Running as a Systemd Service:
|
||||
|
||||
To run the bot as a systemd service, follow these steps:
|
||||
|
||||
Create a service file:
|
||||
|
||||
sudo nano /etc/systemd/system/lainmonitor.service
|
||||
```
|
||||
2. Add the following configuration:
|
||||
```ini
|
||||
|
||||
Add the following configuration:
|
||||
|
||||
[Unit]
|
||||
Description=LainMonitor Telegram Bot
|
||||
After=network.target
|
||||
|
|
@ -59,21 +76,24 @@ To run LainMonitor as a service, follow these steps:
|
|||
|
||||
[Install]
|
||||
WantedBy=multi-user.target
|
||||
```
|
||||
3. Enable and start the service:
|
||||
```bash
|
||||
|
||||
Enable and start the service:
|
||||
|
||||
sudo systemctl enable lainmonitor
|
||||
sudo systemctl start lainmonitor
|
||||
```
|
||||
|
||||
## Telegram Bot Commands
|
||||
- `/start`: Initialize the bot and receive a welcome message.
|
||||
- `/help`: Display available commands.
|
||||
- `/status`: Get the system hostname, status, uptime, and the status of monitored services.
|
||||
- `/ping`: Ping a Tailscale IP and return the connectivity status.
|
||||
- `/reboot`: (Work in progress) Placeholder for a reboot command.
|
||||
### Available Commands:
|
||||
|
||||
## Author
|
||||
Created by **hornetmaidan**
|
||||
/start — Initialize the bot and receive a welcome message.
|
||||
/help — Display a list of available commands.
|
||||
/status — Retrieve system hostname, uptime, and status of monitored services.
|
||||
/ping — Ping a Tailscale IP and return connectivity status.
|
||||
/restart hostname- Restart a specific service on a specified machine.
|
||||
/reboot hostname — Placeholder for a system reboot command.
|
||||
|
||||
Feel free to contribute or suggest features!
|
||||
### Contributions:
|
||||
|
||||
Created by hornetmaidan.
|
||||
With Contributions from h@x.
|
||||
|
||||
Any new features and suggestions are welcome!
|
||||
|
|
@ -4,7 +4,7 @@
|
|||
# usage: python3 lainmonitor.py | or run it as a service
|
||||
# author: hornetmaidan
|
||||
# contributors: h@x
|
||||
# version: 1.1.6
|
||||
# version: 1.2
|
||||
import os
|
||||
import subprocess
|
||||
import threading
|
||||
|
|
@ -32,7 +32,7 @@ except FileNotFoundError:
|
|||
|
||||
# Load the authorized users
|
||||
try:
|
||||
authorized_users = [line.strip() for line in open(auth_users_path, 'r').readlines()]
|
||||
authorized_users = [str(line.strip()) for line in open(auth_users_path, 'r').readlines()]
|
||||
except FileNotFoundError:
|
||||
logging.error('Authorized users file not found. Exiting...')
|
||||
exit(1)
|
||||
|
|
@ -72,7 +72,7 @@ def get_service_status(service):
|
|||
subprocess.run(['sudo', 'systemctl', 'is-active', '--quiet', service], check=True)
|
||||
return f'{service} is active'
|
||||
except subprocess.CalledProcessError:
|
||||
return f'{service} is inactive'
|
||||
return f'{service} is inactive/not present'
|
||||
|
||||
# Function to ping a Tailscale node
|
||||
def ping_node(node, hostname):
|
||||
|
|
@ -150,39 +150,45 @@ def reboot():
|
|||
logging.info('Rebooting system...')
|
||||
subprocess.run(['sudo', 'reboot'], check=True)
|
||||
|
||||
# Populate teh variables on first start
|
||||
get_system_info()
|
||||
|
||||
# Message handlers
|
||||
@bot.message_handler(commands=['start', 'help', 'status', 'restart', 'reboot', 'ping'])
|
||||
def handle(message):
|
||||
user_id = str(message.from_user.id)
|
||||
if message.text == '/start':
|
||||
bot.reply_to(message, 'lainmonitor v1.0 --- standing by...')
|
||||
elif message.text == '/help':
|
||||
bot.reply_to(message, 'commands: /start, /help, /status, /restart, /reboot, /ping')
|
||||
elif message.text == '/status':
|
||||
get_system_info()
|
||||
status_message = (
|
||||
f'hostname: {hostname}\n'
|
||||
f'system status: {status}\n'
|
||||
f'uptime: {uptime}\n'
|
||||
f'zerotier: {zerotier}\n'
|
||||
f'prosody: {prosody}\n'
|
||||
f'postgres: {postgres}\n'
|
||||
f'tailscale: {tailscale}\n'
|
||||
f'nginx: {nginx}'
|
||||
)
|
||||
bot.reply_to(message, status_message)
|
||||
bot.reply_to(message, f'Filesystem info for {hostname}:\n\n{disk}')
|
||||
elif message.text == f'/restart {hostname}' and user_id in authorized_users:
|
||||
bot.send_message(message.chat.id, 'Select a service to restart:', reply_markup=restart_menu())
|
||||
elif message.text == f'/reboot {hostname}' and user_id in authorized_users:
|
||||
bot.reply_to(message, f'Rebooting {hostname}...')
|
||||
reboot()
|
||||
elif message.text == '/ping' and user_id in authorized_users:
|
||||
reach = check_tailscale_nodes()
|
||||
bot.reply_to(message, f'Ping status:\n\n{"\n".join(reach)}')
|
||||
else:
|
||||
if user_id not in authorized_users:
|
||||
bot.reply_to(message, 'You are not authorized for this action')
|
||||
|
||||
else:
|
||||
if message.text == '/start':
|
||||
bot.reply_to(message, 'lainmonitor v1.2 --- standing by...')
|
||||
elif message.text == '/help':
|
||||
bot.reply_to(message, 'commands: /start, /help, /status, /restart, /reboot, /ping')
|
||||
bot.reply_to(message, 'commands: /start, /help, /status, /restart, /reboot, /ping')
|
||||
elif message.text == '/status':
|
||||
get_system_info()
|
||||
status_message = (
|
||||
f'hostname: {hostname}\n'
|
||||
f'system status: {status}\n'
|
||||
f'uptime: {uptime}\n'
|
||||
f'zerotier: {zerotier}\n'
|
||||
f'prosody: {prosody}\n'
|
||||
f'postgres: {postgres}\n'
|
||||
f'tailscale: {tailscale}\n'
|
||||
f'nginx: {nginx}'
|
||||
)
|
||||
bot.reply_to(message, status_message)
|
||||
bot.reply_to(message, f'Filesystem info for {hostname}:\n\n{disk}')
|
||||
elif message.text == f'/restart {hostname}':
|
||||
bot.send_message(message.chat.id, 'Select a service to restart:', reply_markup=restart_menu())
|
||||
elif message.text == f'/reboot {hostname}':
|
||||
bot.reply_to(message, f'Rebooting {hostname}...')
|
||||
reboot()
|
||||
elif message.text == '/ping':
|
||||
reach = check_tailscale_nodes()
|
||||
bot.reply_to(message, f'Ping status:\n\n{"\n".join(reach)}')
|
||||
else:
|
||||
pass
|
||||
# Polling with timeout and error handling
|
||||
try:
|
||||
bot.polling(none_stop=True, timeout=60, long_polling_timeout=60)
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue