基于 Python 的适用于 ClassIsland 的集控服务器

加入讨论区

集控服务器分为三个部分，分别是apicommandgRPC，分别用于：

组件	api	command	gRPC
用途	向客户端分发配置文件	通过API以集控服务器为中介获取客户端状态、向客户端发送指令	与客户端建立gRPC链接
端口	50050	50052	50051

实验性 快速部署（适用于 Linux 平台）:

快速部署将始终安装在 /www/CIMS/backend 目录，你可以使用 rm -rf /www/CIMS/backend 来彻底移除使用部署脚本部署的 CIMS-backend

bash -c "$(curl -sSL https://raw.githubusercontent.com/MINIOpenSource/CIMS-backend/main/install.sh)"

启动

cd /www/CIMS/backend && source venv/bin/activate && python CIMS.py

如何使用？

以下是使用 ClassIsland 集控服务器的步骤：

1. 环境准备:
   • Python: 确保你的系统已安装 Python 3.8+，推荐 Python 3.12+，推荐自行编译完整的 Python 3.12 & OpenSSL 3 环境。
   • Node.js and npm: 如果你需要使用 WebUI，请确保已安装 Node.js (v22+) 和 npm。
   • Git (Optional): 如果你想从 GitHub 克隆仓库，则需要安装 Git。
2. 克隆代码:

   git clone https://github.com/MINIOpenSource/CIMS-backend.git
   cd CIMS-backend

   • 如果你不使用 Git，可以下载 ZIP 压缩包并解压。
3. 创建 venv 并安装依赖:

   python -m venv venv
   ./venv/Scripts/python.exe -m pip install -r requirements.txt
   # Windows 环境

   python3 -m venv venv
   ./venv/bin/python3 -m pip install -r requirements.txt
   # Linux 环境

   在 Linux 环境中，可能出现 venv / pip 不可用报错，请根据相关提示从命令行安装 venv 和 pip 后重新创建虚拟环境并安装依赖。
4. 构建 Protobuf 文件:

   ./venv/Scripts/python.exe -m grpc_tools.protoc --proto_path=. --python_out=. --grpc_python_out=. ./Protobuf/Client/ClientCommandDeliverScReq.proto ./Protobuf/Client/ClientRegisterCsReq.proto ./Protobuf/Command/HeartBeat.proto ./Protobuf/Command/SendNotification.proto ./Protobuf/Enum/CommandTypes.proto ./Protobuf/Enum/Retcode.proto ./Protobuf/Server/ClientCommandDeliverScRsp.proto ./Protobuf/Server/ClientRegisterScRsp.proto ./Protobuf/Service/ClientCommandDeliver.proto ./Protobuf/Service/ClientRegister.proto
   # Windows 环境

   ./venv/bin/python3 -m grpc_tools.protoc --proto_path=. --python_out=. --grpc_python_out=. ./Protobuf/Client/ClientCommandDeliverScReq.proto ./Protobuf/Client/ClientRegisterCsReq.proto ./Protobuf/Command/HeartBeat.proto ./Protobuf/Command/SendNotification.proto ./Protobuf/Enum/CommandTypes.proto ./Protobuf/Enum/Retcode.proto ./Protobuf/Server/ClientCommandDeliverScRsp.proto ./Protobuf/Server/ClientRegisterScRsp.proto ./Protobuf/Service/ClientCommandDeliver.proto ./Protobuf/Service/ClientRegister.proto
   # Linux 环境

   这将会构建 .proto 文件生成对应的 Python 代码，以用于 gRPC 通信。
5. 启动服务器:
   • 使用 CIMS.py :

     第一次启动时，会进行引导配置

     ./venv/Scripts/python.exe CIMS.py
     # Windows 环境

     ./venv/bin/python3 CIMS.py
     # Linux 环境

     生成集控预设文件（ManagementPreset.json）：

     ./venv/Scripts/python.exe CIMS.py -g
     # Windows 环境

     ./venv/bin/python3 CIMS.py -g
     # Linux 环境

     当出现一些意料之外的问题时，可以尝试使用-r参数清除本地的配置文件以尝试修复，在此之前，请手动备份数据：

     ./venv/Scripts/python.exe CIMS.py -r
     # Windows 环境

     ./venv/bin/python3 CIMS.py -r
     # Linux 环境

6. 访问 API:
   • 你可以在浏览器中访问 http://127.0.0.1:50050/docs (或你设置的端口)查看 API 文档.

功能清单

• [x]分发文件
• [x]发送通知
• [x]重启客户端
• [x]批量操作

下一个版本更新

• [ ]实验性的分用户管理能力

羊癫疯 Fossa

Star 历史