Skip to content

Commit e87dd76

Browse files
committed
chore: update readme
1 parent 425b83a commit e87dd76

File tree

2 files changed

+46
-0
lines changed

2 files changed

+46
-0
lines changed

README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,13 @@ FanX 是一款基于 .NET 8 和 Blazor 的风扇控制与监控平台,能够
7676
- 默认管理员账号:
7777
- 账号:`admin`
7878
- 密码:`admin123`
79+
80+
### Docker 部署
81+
你可以使用项目中提供的 [docker-compose.yml](docker-compose.yml) 文件进行 Docker 部署,这样可以在容器化环境中运行 FanX,所有依赖都将自动管理。
82+
或者你也可以直接使用 Docker 命令部署:
83+
```bash
84+
docker run -d --name fanx -p 5136:5136 -v /docker/FanX/data:/app/data -v /docker/FanX/logs:/app/logs realswaggymacro/fanx:latest
85+
```
7986

8087
### 克隆并运行
8188
1. 克隆仓库:
@@ -108,6 +115,7 @@ FanX 是一款基于 .NET 8 和 Blazor 的风扇控制与监控平台,能够
108115
- 在 `/fan-control` 页面定义自定义或智能风扇控制规则。
109116
- 在 `/notifications` 页面配置通知渠道和规则,包括企业微信机器人、Webhook、Telegram 机器人、邮箱等。
110117
- 在 `/settings` 页面设置日志保留天数、传感器数据保留策略等。(默认30天)
118+
> 如果你需要手动调控风扇,可以在 `/fan-control` 页面设置为手动控制,然后前往 `/debug` 页面手动调节风扇转速,支持单个风扇手动调节。
111119

112120
## 配置说明
113121

@@ -116,6 +124,21 @@ FanX 是一款基于 .NET 8 和 Blazor 的风扇控制与监控平台,能够
116124
- `/notifications` 页面:配置通知渠道和规则,包括企业微信机器人、Webhook、Telegram 机器人、邮箱等
117125
- `/settings` 页面:设置日志保留天数、传感器数据保留策略等
118126

127+
128+
## 玩法
129+
130+
比如你可以设置一个智能规则,规则如下图,可实现内容:
131+
- CPU1 > 80度 给 123号风扇 80% 转速, CPU2 > 80度 给 456号风扇 80% 转速
132+
- CPU1 > 70度 给 123号风扇 50% 转速, CPU2 > 70度 给 456号风扇 50% 转速
133+
- CPU1 > 60度 给 123号风扇 30% 转速, CPU2 > 60度 给 456号风扇 30% 转速
134+
- CPU1 > 50度 给 123号风扇 20% 转速, CPU2 > 50度 给 456号风扇 15% 转速
135+
- 因为我这 CPU1 温度会比 CPU2 高,所以我设置了在 CPU1 侧的123号风扇转速更高
136+
- CPU1 < 50度 给 123号风扇 10% 转速, CPU2 < 50度 给 456号风扇 10% 转速
137+
138+
> 同时你也可以根据进风口温度和出风口温度来设置风扇转速,或者根据功率来设置风扇转速。
139+
140+
![玩法示例](Screenshot/screenshot_smart_rule_example.png)
141+
119142
## 已测试设备
120143
- Dell PowerEdge R720xd
121144

README_EN.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,13 @@ FanX is a fan control and monitoring platform built with .NET 8 and Blazor. It p
7979
- Username: `admin`
8080
- Password: `admin123`
8181

82+
### Docker Deployment
83+
For Docker deployment, you can use the provided [docker-compose.yml](docker-compose.yml) file. This allows you to run FanX in a containerized environment with all dependencies managed automatically.
84+
Or you can run it directly using Docker:
85+
```bash
86+
docker run -d --name fanx -p 5136:5136 -v /docker/FanX/data:/app/data -v /docker/FanX/logs:/app/logs realswaggymacro/fanx:latest
87+
```
88+
8289
### Clone and Run
8390
1. Clone the repository:
8491
```bash
@@ -103,13 +110,29 @@ FanX is a fan control and monitoring platform built with .NET 8 and Blazor. It p
103110
- Set up notification channels and rules on the `/notifications` page.
104111
- Adjust log retention days and sensor data policies on the `/settings` page (default is 30 days).
105112

113+
> If you need to manually control fans, you can set it to manual mode on the `/fan-control` page, then go to the `/debug` page to adjust fan speeds individually.
114+
106115
## Pages & Configuration
107116

108117
- `/ipmi-config`: Configure BMC(iDrac) endpoint, credentials
109118
- `/fan-control`: Define custom or intelligent fan control rules
110119
- `/notifications`: Configure notification channels and rules (WeChat, Webhook, Telegram, Email)
111120
- `/settings`: Adjust log retention days and sensor data policies
112121

122+
## Example Usage
123+
124+
For example, you can set an intelligent rule as shown in the screenshot, which achieves the following:
125+
- When CPU1 > 80°C, set Fan 123 to 80% speed, and when CPU2 > 80°C, set Fan 456 to 80% speed
126+
- When CPU1 > 70°C, set Fan 123 to 50% speed, and when CPU2 > 70°C, set Fan 456 to 50% speed
127+
- When CPU1 > 60°C, set Fan 123 to 30% speed, and when CPU2 > 60°C, set Fan 456 to 30% speed
128+
- When CPU1 > 50°C, set Fan 123 to 20% speed, and when CPU2 > 50°C, set Fan 456 to 15% speed
129+
- Since CPU1 temperature is usually higher than CPU2, I set the speed of Fan 123 on the CPU1 side to be higher
130+
- When CPU1 < 50°C, set Fan 123 to 10% speed, and when CPU2 < 50°C, set Fan 456 to 10% speed
131+
132+
> You can also set fan speeds based on inlet and outlet temperatures, or based on power consumption.
133+
![Example Rule](Screenshot/screenshot_smart_rule_example.png)
134+
135+
113136
## Tested Devices
114137
- Dell PowerEdge R720xd
115138

0 commit comments

Comments
 (0)