Lodestone 项目使用教程

1. 项目目录结构及介绍

Lodestone 是一个个人文档搜索和归档系统，其目录结构如下：

lodestone/
├── backend/            # 后端代码目录
├── data/               # 存储配置文件和文档数据目录
├── docker-compose.yml  # Docker 编排文件
├── docs/               # 文档目录
├── LICENSE             # 开源协议文件
├── REFERENCES.md       # 参考文档
├── README.md           # 项目说明文件
├── RESEARCH.md         # 研究文档
├── alternatives.csv    # 替代方案 CSV 文件
└── webapp/             # 前端代码目录

backend/

后端代码目录，包含了处理文档、生成缩略图、OCR 处理等服务的代码。

data/

存储配置文件和文档数据目录。其中包括：

• filetypes.json：定义了文件类型包含和排除的规则。
• tags.json：定义了标签结构，用于文档分类和搜索。
• mapping.json：定义了 Elasticsearch 容器的数据存储结构。

docker-compose.yml

Docker 编排文件，用于定义和启动项目中所需的容器服务。

docs/

文档目录，包含了项目的文档和截图。

LICENSE

开源协议文件，本项目遵循 GPL-3.0 许可。

REFERENCES.md

参考文档，包含了项目开发过程中的参考资料。

RESEARCH.md

研究文档，记录了项目开发过程中的研究内容。

alternatives.csv

替代方案 CSV 文件，用于记录文档模型的数据。

webapp/

前端代码目录，包含了项目的前端界面代码。

2. 项目的启动文件介绍

项目的启动主要通过 docker-compose.yml 文件来管理。以下是启动项目的步骤：

1. 确保已安装 Docker 和 Docker Compose。
2. 在项目根目录下运行 docker-compose up 命令。
3. 启动后，通过浏览器访问 http://localhost/ 查看界面。

3. 项目的配置文件介绍

项目的配置主要通过以下几个文件进行：

• filetypes.json：配置文件类型处理规则。
• tags.json：配置文档标签结构。
• mapping.json：配置 Elasticsearch 数据存储结构。

filetypes.json

{
  "includes": [
    "application/pdf",
    "application/msword",
    "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
    // 其他文件类型...
  ],
  "excludes": [
    "application/zip",
    "application/x-zip-compressed",
    // 其他排除的文件类型...
  ]
}

tags.json

{
  "tags": {
    "personal": {
      "name": "Personal",
      "children": [
        "finance",
        "health",
        // 其他子标签...
      ]
    },
    // 其他标签...
  }
}

mapping.json

{
  "mappings": {
    "properties": {
      "filename": { "type": "keyword" },
      "title": { "type": "text" },
      "content": { "type": "text" },
      // 其他字段...
    }
  }
}

通过修改这些配置文件，可以自定义项目的处理规则和存储结构，以满足不同的需求。