Zenfeed 开源项目使用教程

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

Zenfeed 是一个智能信息助手，它可以帮助用户收集、处理和分发来自可信数据源如 RSS 的个性化内容。以下是 Zenfeed 项目的目录结构及介绍：

zenfeed/
├── .github/             # GitHub 工作流配置目录
│   ├── workflows/
│   └── ...
├── docs/                # 文档目录
├── install/             # 安装脚本和配置模板
├── pkg/                 # 项目主要代码包
├── .gitignore           # Git 忽略文件
├── .golangci.yml        # golangci-lint 配置文件
├── Dockerfile           # Docker 构建文件
├── LICENSE              # 项目许可证文件
├── Makefile             # Makefile 文件
├── README.md            # 项目说明文件
├── go.mod               # Go 依赖管理文件
├── go.sum               # Go 依赖校验文件
└── main.go              # 项目主入口文件

• .github/: 包含 GitHub Actions 工作流文件，用于自动化项目的某些操作，如代码检查、构建等。
• docs/: 存放项目文档。
• install/: 包含项目安装所需的脚本和配置模板。
• pkg/: 包含项目的主要代码逻辑。
• .gitignore: 指定 Git 忽略的文件和目录。
• .golangci.yml: 配置 golangci-lint 的规则。
• Dockerfile: 用于创建项目的 Docker 容器镜像。
• LICENSE: 项目使用的许可证信息。
• Makefile: 用于定义项目的构建和安装过程。
• README.md: 项目说明文件，包含项目的简介、使用方法和功能特性等信息。
• go.mod 和 go.sum: Go 项目的依赖管理文件。
• main.go: 项目的主入口文件，包含了启动服务的逻辑。

2. 项目的启动文件介绍

项目的启动文件为 main.go，它包含了初始化和启动 Zenfeed 服务的逻辑。以下是 main.go 文件的主要内容：

package main

// 导入必要的包

func main() {
    // 初始化配置
    // 设置日志
    // 启动服务
}

在 main.go 文件中，首先会导入项目所需的包，然后定义 main 函数，它是程序的入口点。在 main 函数中，会进行配置的初始化、日志系统的设置以及服务的启动。

3. 项目的配置文件介绍

项目的配置文件位于 install/config-template.yaml，这是一个 YAML 格式的文件，用于定义 Zenfeed 运行时的各项配置。以下是配置文件的主要内容：

timezone: "Asia/Shanghai"
llms:
  - provider: "siliconflow"
    model: "Qwen/Qwen2.5-7B-Instruct"
    api_key: "your_api_key"
  - provider: "siliconflow"
    embedding_model: "Pro/BAAI/bge-m3"
    api_key: "your_api_key"
storage:
  feed:
    rewrites:
      - transform:
          to_text:
            prompt: "{{.summary_html_snippet}}使用中文回复"

配置文件中包含以下部分：

• timezone: 设置项目的时区。
• llms: 定义了语言模型的提供者、模型类型和 API 密钥。这里需要替换 your_api_key 为有效的 API 密钥。
• storage: 定义了存储相关的配置，包括内容重写的规则。

在实际部署项目之前，需要根据实际情况修改 config-template.yaml 文件中的配置，然后将其重命名为 config.yaml 并放置在相应的目录下。