Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
yb committed Jul 14, 2022
1 parent 063ac37 commit c568b80
Showing 1 changed file with 21 additions and 2 deletions.
23 changes: 21 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,21 @@
uptime-status
=============
# uptime-status

一个基于 UptimeRobot API 的在线状态面板

## 事先准备

- 您需要先到 [UptimeRobot](https://uptimerobot.com/ "UptimeRobot") 添加站点监控,并在 My Settings 页面获取 API Key
- 您需要拥有一个网站空间,常见的 Nginx / PHP 等空间即可,甚至是阿里云的 OSS 等纯静态空间也行

## 如何部署:

- 下载并解压缩:[uptime-status.zip](https://github.com/yb/uptime-status/releases/latest/download/uptime-status.zip "uptime-status.zip")
- 修改 `config.js` 文件:
- `SiteName`: 要显示的网站名称
- `ApiKeys`: 从 UptimeRobot 获取的 API Key,支持 Monitor-Specific API Keys 和 Read-Only API Key
- `CountDays`: 要显示的日志天数,建议 60 或 90,显示效果比较好
- `ShowLink`: 是否显示站点链接
- `Navi`: 导航栏的菜单列表
- 将所有文件上传到网站空间

⚠️ 如果没有修改代码的需求,您不需要 git clone 本项目,只需要下载 Release 的文件包即可。

0 comments on commit c568b80

Please sign in to comment.