Skip to content

Commit

Permalink
1. 修改部署文件
Browse files Browse the repository at this point in the history
2. 更新readme.md
  • Loading branch information
bboysoulcn committed Apr 10, 2024
1 parent af4b0f9 commit 83852af
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 10 deletions.
33 changes: 27 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,32 @@

TeleMonitor 是一个使用 Python 编写的系统监控工具,它可以监控 CPU、内存和磁盘的使用情况,并通过 Telegram 发送警告。

## 安装
## 使用

首先,你需要在你的系统上安装 Docker。然后,你可以使用以下命令来构建和运行 Docker 镜像:
首先,你需要创建一个 Telegram bot,然后获取 API token。你可以参考 [Telegram 官方文档](https://core.telegram.org/bots/features#botfather) 来创建一个 Telegram bot。

pass
然后,你需要获取你希望接收警告的 Telegram chat ID。你可以使用 [@userinfobot](https://t.me/userinfobot) 来获取你的 chat ID。

## 使用
接下来clone这个项目:

```bash
git clone https://github.com/bboysoulcn/telemonitor.git
```

你可以使用docker compose 来运行 Telemonitor:

你可以通过设置环境变量来配置 Telemonitor:
```bash
docker-compose up -d
```

或者你可以使用 k8s 来运行 Telemonitor:

```bash
kubectl apply -f deployment.yaml
```


下面是 Telemonitor 的环境变量:

- `TG_API_TOKEN`: 你的 Telegram bot 的 API token。
- `TG_CHAT_ID`: 你希望接收警告的 Telegram chat ID。
Expand All @@ -19,7 +36,11 @@ pass
- `DISK_PERCENT`: 磁盘使用率的阈值,超过这个阈值时,Telemonitor 会发送警告。
- `MONITOR_INTERVAL`: 监控的间隔时间(秒)。

在 Telegram 中,你可以使用 `/status` 命令来获取系统的当前状态。
下面是机器人的命令:

- /start - 获取帮助
- /help - 获取帮助
- /status - 获取系统状态

## 许可证

Expand Down
4 changes: 1 addition & 3 deletions deploymet.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,9 @@ spec:
spec:
hostNetwork: true
hostPID: true
imagePullSecrets:
- name: regcred
containers:
- name: serverstatus
image: serverstatus:latest
image: ghcr.io/bboysoulcn/telemonitor:latest
env:
- name: TG_CHAT_ID
value: your_chat_id
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: '3'
services:
serverstatus:
image: serverstatus:latest
image: ghcr.io/bboysoulcn/telemonitor:latest
restart: always
container_name: serverstatus
environment:
Expand Down

0 comments on commit 83852af

Please sign in to comment.