Minima 项目使用教程

Minima 项目使用教程

minima On-premises conversational RAG with configurable containers 项目地址: https://gitcode.com/gh_mirrors/mini/minima

1. 目录结构及介绍

Minima 项目是一个开源的 RAG（ Retrieval Augmented Generation）系统，它可以在本地或云环境中运行。以下是项目的目录结构及各部分的简要介绍：

minima/
├── assets/               # 存储项目资源文件
├── chat/                 # 包含聊天界面相关的代码
├── electron/             # 电子应用相关的代码
├── indexer/              # 索引器代码，用于索引本地文件
├── linker/               # 链接器代码，用于整合不同组件
├── llm/                  # 包含语言模型相关的代码
├── mcp-server/           # 用于集成 Anthropic Claude 应用的服务器代码
├── .gitignore            # 指定 Git 忽略的文件和目录
├── .gitmodules           # 指定包含子模块的文件
├── LICENSE               # 项目的许可协议文件
├── README.md             # 项目的自述文件
├── docker-compose-chatgpt.yml  # ChatGPT 集成用的 Docker 配置文件
├── docker-compose-mcp.yml    # Anthropic Claude 集成用的 Docker 配置文件
├── docker-compose-ollama.yml  # Ollama 模型集成用的 Docker 配置文件
├── run.sh                # 项目启动脚本
└── .env.sample           # 配置文件示例

2. 项目的启动文件介绍

项目的启动主要通过 run.sh 脚本进行，该脚本会根据配置文件 docker-compose-*.yml 和 .env 文件来启动整个系统。以下是启动命令的基本使用方法：

• 对于完全本地的安装，使用以下命令：

  docker compose -f docker-compose-ollama.yml --env-file .env up --build
  

• 对于启用 ChatGPT 的安装，使用以下命令：

  docker compose -f docker-compose-chatgpt.yml --env-file .env up --build
  

• 对于集成 MCP（Anthropic Desktop 应用）的安装，使用以下命令：

  docker compose -f docker-compose-mcp.yml --env-file .env up --build
  

启动后，可以通过访问 http://localhost:3000 来使用聊天界面。

3. 项目的配置文件介绍

项目的配置文件主要包括 .env.sample 文件，它是 .env 文件的示例，用户需要根据自己的需求进行修改并创建一个 .env 文件。以下是配置文件中可能包含的一些关键环境变量：

• LOCAL_FILES_PATH: 指定本地文件的根目录，该目录下的文件将会被索引。
• EMBEDDING_MODEL_ID: 指定使用的嵌入模型 ID。
• EMBEDDING_SIZE: 定义嵌入模型的维度。
• OLLAMA_MODEL: 指定使用的 Ollama 模型 ID。
• RERANKER_MODEL: 指定重排器模型的 ID。
• USER_ID: 用户的邮箱地址，用于 ChatGPT 集成。
• PASSWORD: 任意密码，用于创建 Firebase 账户。

在 .env 文件中配置好这些变量后，就可以通过上述的启动命令来启动项目了。

minima On-premises conversational RAG with configurable containers 项目地址: https://gitcode.com/gh_mirrors/mini/minima