Cronicle 项目使用教程

Cronicle 项目使用教程

Cronicle A simple, distributed task scheduler and runner with a web based UI. 项目地址: https://gitcode.com/gh_mirrors/cr/Cronicle

1. 项目的目录结构及介绍

Cronicle 是一个基于 Node.js 的分布式任务调度器和运行器，具有网页前端界面。项目目录结构如下：

• bin/: 存放项目的启动脚本。
• docs/: 包含项目文档。
• htdocs/: 网页前端文件所在目录。
• lib/: 包含项目的核心代码库。
• sample_conf/: 提供了配置文件的示例。
• .github/: 包含与 GitHub 交互的配置文件。
• CHANGELOG.md: 记录了项目的更新日志。
• CODE_OF_CONDUCT.md: 项目的行为准则。
• LICENSE.md: 项目的许可证信息。
• README.md: 项目的自述文件。
• package-lock.json: 记录了项目依赖的确切版本。
• package.json: 定义了项目的依赖和元数据。

2. 项目的启动文件介绍

项目的启动文件位于 bin/ 目录下。主要的启动脚本有：

• cronicle.js: 这是启动 Cronicle 服务的主要脚本。可以通过 Node.js 直接运行此脚本启动服务。

启动服务的基本命令如下：

node bin/cronicle.js

3. 项目的配置文件介绍

Cronicle 的配置文件通常位于 sample_conf/ 目录下，提供了一个名为 config.json 的示例配置文件。用户可以复制此文件并根据需要修改配置。

配置文件 config.json 的主要部分包括：

• primaryServer: 指定是否将当前服务器作为主服务器。
• backupServers: 列出了备份服务器的地址，用于自动故障转移。
• workerServers: 列出了工作服务器的地址，这些服务器将执行任务。
• serverGroups: 定义了服务器组，可以针对特定任务指定服务器组。
• apiKeys: API 密钥用于外部应用的身份验证。
• users: 定义了用户账户，用于登录 Web UI。

以下是一个配置文件的简化示例：

{
  "primaryServer": true,
  "backupServers": [],
  "workerServers": [],
  "serverGroups": {},
  "apiKeys": {},
  "users": {
    "admin": {
      "passwordHash": "hashed_password"
    }
  }
}

在实际部署时，需要根据具体需求调整 config.json 文件中的设置，并确保所有服务器上的配置是一致的。

请根据实际情况修改配置文件，然后重启 Cronicle 服务以使配置生效。

Cronicle A simple, distributed task scheduler and runner with a web based UI. 项目地址: https://gitcode.com/gh_mirrors/cr/Cronicle