Lodestone 项目安装与配置指南

Lodestone 项目安装与配置指南

lodestone Personal Document Archiving (DMS, EDMS for Personal/Home Office use) 项目地址: https://gitcode.com/gh_mirrors/lod/lodestone

1. 项目基础介绍

Lodestone 是一个开源的个人文档搜索与归档系统，旨在成为现代数字化的家庭文件柜。它支持全文文档搜索、丰富的标签管理、自动化的文档收集和 OCR 处理，以及保留原始文件的非破坏性处理。Lodestone 可以在家庭服务器上运行，实现 24x7 的网页访问。该项目主要用于个人文档管理，目前不支持用户管理。

主要编程语言：Go、Angular、ExpressJS

2. 项目使用的关键技术和框架

• Elasticsearch：用于全文搜索和文档索引。
• Go：用于文档处理器和缩略图处理器。
• Angular：用于前端用户界面。
• ExpressJS：用于后端 API。
• minio：作为存储解决方案，提供 S3 兼容的存储服务。
• RabbitMQ：作为消息队列，处理任务调度。
• Tika：用于 OCR 文档识别。

3. 项目安装和配置的准备工作

准备工作

• 确保你的系统已经安装了 Docker 和 Docker Compose。
• 准备一个可以访问的网络存储目录，用于存放文档。

安装步骤

1. 克隆项目仓库到本地：

   git clone https://github.com/LodestoneHQ/lodestone.git
   cd lodestone
   

2. 配置 Docker Compose。在 docker-compose.yml 文件中，你可以根据需要自定义配置，例如存储目录和端口映射。

3. 启动 Docker 容器：

   docker-compose up
   

4. 等待容器启动完成后，在浏览器中访问 http://localhost/，检查系统是否正常工作。

5. 将你的文档放置在项目目录中的 data/storage/documents 目录下。Lodestone 的文件系统收集器将自动开始处理这些文档。

6. 如果处理器没有自动拾取你的文件，你可能需要更改文件的最后修改时间来触发处理器。使用以下命令：

   find . -exec touch {} \;
   

7. 配置文件类型、标签和映射。在 backend/data 目录中，你可以编辑 filetypes.json、tags.json 和 mappings.json 来定制你的文档处理和搜索行为。

   • filetypes.json：指定哪些文件类型应该被处理和加载到数据库中。
   • tags.json：定义可用于在 Lodestone 网页 UI 中分组和搜索文档的标签结构。
   • mappings.json：确保 Elasticsearch 容器有一个一致的数据存储结构。

8. 重新启动 Docker 容器以应用配置更改：

   docker-compose down
   docker-compose up
   

现在，你应该可以开始使用 Lodestone 管理你的个人文档了。如果遇到问题，可以查看项目的文档或提交 issue 到项目的 GitHub 仓库。

lodestone Personal Document Archiving (DMS, EDMS for Personal/Home Office use) 项目地址: https://gitcode.com/gh_mirrors/lod/lodestone