diff --git a/README.md b/README.md index c45ae0d..44d7b39 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,11 @@ _✨ 服务器状态 - 服务端/后端 ✨_ ## 📖 介绍 -服务器状态的服务端 -![image](./img/sh.jpeg) +- 一个查看和监控主机们的状态的简易应用程序 + +- 点击查看[项目实例](https://status.liteyuki.icu/) + +- ![image](./img/sh.jpeg) ## 💿 安装 @@ -24,17 +27,24 @@ _✨ 服务器状态 - 服务端/后端 ✨_ ## 🎉 使用 ### 配置 -默认是通过传入环境变量来配置的,你可以通过创建 `.env` 文件来或者直接传入环境变量来配置 -```dotenv -PORT=8080 -TOKEN=114514 -``` +- 默认是通过传入环境变量来配置的,你可以通过创建 `.env` 文件来或者直接传入环境变量来配置 + ```dotenv + PORT=8080 + TOKEN=114514 + ``` ### 运行 -直接执行二进制文件即可 -```shell -./server-status-server -``` +- 直接执行二进制文件即可 +- 而后访问http://127.0.0.1:8080即可看到效果(默认端口8080) + + ```shell + ./server-status-server + ``` + + +### 被监控主机配置 + +请在需要监控的服务器主机上安装 [server-status-client](https://github.com/snowykami/server-status-client) ## 📝 其他 @@ -42,6 +52,7 @@ TOKEN=114514 - 手动安装请自行配置service通过systemd启动 -### 主机监控 +### 自定义前端 +- 前端源码在[server-status-web](https://github.com/snowykami/server-status-web) +- 接口定义请查看源代码的[api/router](./api/router.go) -- 请在需要监控的服务器主机上安装 [server-status-client](https://github.com/snowykami/server-status-client) \ No newline at end of file