Paperless-gpt 项目使用教程

Paperless-gpt 项目使用教程

paperless-gpt Use LLMs and LLM Vision (OCR) to handle paperless-ngx - Document Digitalization powered by AI 项目地址: https://gitcode.com/gh_mirrors/pa/paperless-gpt

1. 项目目录结构及介绍

Paperless-gpt 的目录结构如下：

paperless-gpt/
├── .github/
├── .vscode/
├── cline_docs/
├── demo/
├── ocr/
├── tests/
│   ├── pdf/
│   └── web-app/
├── .dockerignore
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── Dockerfile
├── LICENSE
├── README.md
├── app_http_handlers.go
├── app_llm.go
├── app_llm_test.go
├── background.go
├── background_test.go
├── build-and-run.sh
├── demo.mp4
├── docker-build-and-push.sh
├── docker-compose.yml
├── embedded_assets.go
├── go.mod
├── go.sum
├── jobs.go
├── local_db.go
├── main.go
├── main_test.go
├── ocr.go
├── paperless-gpt-screenshot.png
├── paperless.go
├── paperless_test.go
├── renovate.json
├── tokens.go
├── tokens_test.go
├── types.go
└── version.go

• .github/：包含 GitHub 的一些配置文件。
• .vscode/：Visual Studio Code 的项目配置文件。
• cline_docs/：可能包含项目的文档或相关文件。
• demo/：示例文件或演示视频。
• ocr/：与 OCR 功能相关的代码和文件。
• tests/：包含项目的测试文件。
  • pdf/：针对 PDF 文件处理的测试。
  • web-app/：针对 Web 应用程序部分的测试。
• 其他文件和目录包含项目的主要代码、构建脚本、配置文件和文档。

2. 项目的启动文件介绍

项目的启动文件是 main.go，这是 Go 语言的入口点。它负责初始化应用程序、设置 HTTP 处理器、启动服务器等。

package main

func main() {
    // 初始化应用程序逻辑
    // 设置 HTTP 处理器
    // 启动服务器
}

具体的启动逻辑和细节需要参考 main.go 文件中的代码。

3. 项目的配置文件介绍

项目使用 docker-compose.yml 作为主要的配置文件，用于定义和运行多容器 Docker 应用程序。

以下是一个基本的 docker-compose.yml 示例：

version: '3'
services:
  paperless-ngx:
    image: ghcr.io/paperless-ngx/paperless-ngx:latest
    # ... (其他 paperless-ngx 配置)

  paperless-gpt:
    image: icereed/paperless-gpt:latest
    environment:
      PAPERLESS_BASE_URL: "http://paperless-ngx:8000"
      PAPERLESS_API_TOKEN: "your_paperless_api_token"
      # ... (其他环境变量)
    volumes:
      - ./prompts:/app/prompts
    ports:
      - "8080:8080"
    depends_on:
      - paperless-ngx

在 docker-compose.yml 文件中，你可以配置服务使用的镜像、环境变量、卷、端口以及依赖关系等。确保根据你的实际需求替换占位符和默认值。

paperless-gpt Use LLMs and LLM Vision (OCR) to handle paperless-ngx - Document Digitalization powered by AI 项目地址: https://gitcode.com/gh_mirrors/pa/paperless-gpt