OpenCATS 技术文档

1. 安装指南

1.1 系统要求

• PHP: 7.2 或更高版本
• MariaDB: 10.6 或更高版本
• 其他依赖: antiword, html2text, unrtf 等工具（用于简历的全文索引）

1.2 安装步骤

1. 下载安装包: 从 GitHub Releases 页面下载最新的 *-full 安装包。
2. 解压文件: 将下载的压缩包解压到服务器的 web 根目录。
3. 配置数据库: 创建一个新的 MariaDB 数据库，并确保数据库用户有权限访问该数据库。
4. 运行安装脚本: 在浏览器中访问 http://your-server-domain/opencats/install，按照安装向导的提示完成安装。
5. 完成安装: 安装完成后，删除 install 目录以确保系统安全。

2. 项目使用说明

2.1 主要功能

• 职位管理: 创建、编辑和发布职位。
• 候选人管理: 管理候选人的简历、联系方式和申请记录。
• 招聘流程管理: 跟踪从职位发布到候选人筛选和提交的整个招聘流程。

2.2 用户界面

• 仪表盘: 显示当前的招聘活动和关键指标。
• 职位列表: 查看和管理所有发布的职位。
• 候选人列表: 查看和管理所有候选人及其申请记录。
• 报告: 生成和查看招聘活动的统计报告。

3. 项目API使用文档

3.1 API 概述

OpenCATS 提供了一套 RESTful API，允许开发者通过编程方式与系统进行交互。API 主要用于以下场景：

• 集成第三方系统
• 自动化招聘流程
• 数据导出和导入

3.2 API 认证

• 认证方式: 使用 API 密钥进行认证。API 密钥可以在系统设置中生成。
• 请求头: 在每个请求中包含 Authorization 头，值为 Bearer <API_KEY>。

3.3 常用 API 示例

• 获取职位列表:

  GET /api/v1/jobs
  

• 创建新职位:

  POST /api/v1/jobs
  Content-Type: application/json
  {
    "title": "Software Engineer",
    "description": "We are looking for a skilled software engineer..."
  }
  

• 获取候选人列表:

  GET /api/v1/candidates
  

4. 项目安装方式

4.1 手动安装

• 步骤: 按照 安装指南 中的步骤手动安装 OpenCATS。

4.2 Docker 安装

• 步骤:
  1. 拉取 OpenCATS Docker 镜像:

     docker pull opencats/opencats
     

  2. 运行容器:

     docker run -d -p 80:80 opencats/opencats
     

  3. 访问 http://localhost 完成安装。

4.3 自动化安装脚本

• 步骤:
  1. 下载自动化安装脚本:

     wget https://github.com/opencats/opencats/raw/master/install/auto_install.sh
     

  2. 运行脚本:

     bash auto_install.sh
     

  3. 按照提示完成安装。

通过以上步骤，您可以顺利安装并使用 OpenCATS 系统，管理您的招聘流程。