开源项目常见问题解决方案

开源项目常见问题解决方案

sist2 Lightning-fast file system indexer and search tool 项目地址: https://gitcode.com/gh_mirrors/si/sist2

1. 项目基础介绍和主要编程语言

项目名称：sist2（Simple Incremental Search Tool）

项目介绍：sist2 是一个快速的文件系统索引器和搜索工具，它具有多线程、低内存使用等特点，支持通过简单的 Web 界面管理和调度扫描任务。项目支持多种文件类型，并能够提取文本和元数据，生成缩略图，支持 OCR 识别和命名实体识别等功能。

主要编程语言：Python

2. 新手使用时需特别注意的三个问题及解决步骤

问题一：如何部署和运行项目？

问题描述： 新手在使用项目时，可能不知道如何部署和运行。

解决步骤：

1. 确保系统中已安装 Docker。

2. 使用 Docker Compose 部署项目，创建一个名为 docker-compose.yml 的文件，并写入以下内容：

   version: "3"
   services:
     elasticsearch:
       image: elasticsearch:7.17.9
       restart: unless-stopped
       volumes:
         - /data/sist2-es-data/:/usr/share/elasticsearch/data
       environment:
         - "discovery.type=single-node"
         - "ES_JAVA_OPTS=-Xms2g -Xmx2g"
         - "PUID=1000"
         - "PGID=1000"
     sist2-admin:
       image: simon987/sist2:3.4.2-x64-linux
       restart: unless-stopped
       volumes:
         - /data/sist2-admin-data/:/sist2-admin/
         - /:/host
       ports:
         - 4090:4090
         - 8080:8080
       working_dir: /root/sist2-admin/
       entrypoint: python3
       command: - /root/sist2-admin/sist2_admin/app.py
   

3. 运行以下命令启动项目：

   docker-compose up -d
   

4. 在浏览器中访问 http://localhost:8080/ 配置 sist2-admin。

问题二：如何选择搜索后端？

问题描述： 项目支持多种搜索后端，新手可能不清楚如何选择和配置。

解决步骤：

1. 项目支持 Elasticsearch 和 SQLite 两种搜索后端。

2. 如果选择 Elasticsearch，确保已经有一个运行中的 Elasticsearch 实例（建议版本 >=7.14.0）。

3. 如果使用 Docker，可以运行以下命令启动 Elasticsearch 容器：

   docker run -d -p 9200:9200 -e "discovery.type=single-node" elasticsearch:7.17.9
   

4. 如果选择 SQLite，无需安装，直接下载最新的 sist2 发布版本，选择与 CPU 架构对应的文件，并使用 chmod +x 命令将二进制文件设置为可执行。

问题三：如何在项目中添加自定义文件类型处理？

问题描述： 新手可能不知道如何为项目添加自定义文件类型处理。

解决步骤：

1. 在项目目录中，找到 third-party 文件夹，其中包含了项目使用的第三方库和工具。
2. 根据需要，添加处理自定义文件类型的代码到相应的位置。
3. 如果需要添加新的文件类型解析器，可以在 src 目录下创建新的 Python 文件，并在其中实现文件解析的逻辑。
4. 确保在 CMakeLists.txt 文件中添加对新文件的引用，以便在编译时包含它们。

sist2 Lightning-fast file system indexer and search tool 项目地址: https://gitcode.com/gh_mirrors/si/sist2