diff --git a/README.md b/README.md index 63ab643..a294df9 100644 --- a/README.md +++ b/README.md @@ -1 +1,82 @@ -# server-status-cv-py + +
+ +# server-status-client + +_✨ 服务器状态 - 客户端 ✨_ + + + + license + + + pypi + +python + +
+ +## 📖 介绍 + +服务器状态的客户端命令行工具 + +## 💿 安装 + +
+使用 pip 安装(确保包路径在环境变量下) + + pip install server-status + +
+ +Debian系请使用pipx安装 + +```bash +sudo apt install python3-pipx +pipx install server-status +``` + +## 🎉 使用 + +### 命令 + +- `server_status run` - 运行客户端 +- `server_status rm` - 从服务端移除主机 + +#### 可选项 +- `-n|--name` - 设置主机名称 +- `--labels` - 设置主机标签 +- `--interval` - 设置上报间隔 +- `--location` - 设置主机地域 +- `--link` - 设置前端点击跳转链接 + +#### 示例 +```shell +server_status https://status.liteyuki.icu 114514 myhost run -n "MyHost" --labels "标签1,标签2" --interval 5 --location "Chongqing" --link "https://example.com" +``` + +## 📝 其他 + +### 开机启动 +执行以下命令 +```shell +sudo touch /etc/systemd/system/server-status-client.service + +sudo bash -c 'cat < /etc/systemd/system/server-status-client.service +[Unit] +Description=Server Status Client +After=network-online.target + +[Service] +Type=simple +ExecStart=sudo server_status run # 请替换为实际参数 +Restart=on-failure +RestartSec=10 + +[Install] +WantedBy=multi-user.target +EOF' + +sudo systemctl enable server-status-client +sudo systemctl start server-status-client +``` \ No newline at end of file