MiniSearch

一款极简的网页搜索应用，内置AI助手，直接在浏览器中运行。

在线演示：https://felladrin-minisearch.hf.space

截图

功能

• 注重隐私：不追踪、无广告、不收集数据
• 易于使用：极简却直观的界面，适合所有用户
• 跨平台：模型在浏览器内运行，无论桌面端还是移动端均可使用
• 集成化：通过将MiniSearch设为默认搜索引擎，即可从浏览器地址栏直接搜索
• 高效：模型仅在需要时加载并缓存
• 可定制：可调整搜索结果与文本生成的相关设置
• 开源：代码已在GitHub上公开，欢迎查看与贡献

先决条件

• Docker

快速入门

以下是开始使用MiniSearch的最简单方法，请选择最适合您的方式。

选项1 - 使用MiniSearch的Docker镜像，只需在终端运行：

docker run -p 7860:7860 ghcr.io/felladrin/minisearch:main

选项2 - 将MiniSearch的Docker镜像添加到您现有的Docker Compose文件中：

services:
  minisearch:
    image: ghcr.io/felladrin/minisearch:main
    ports:
      - "7860:7860"

选项3 - 从源码构建，先下载仓库文件（链接），然后运行：

docker compose -f docker-compose.production.yml up --build

容器启动后，在浏览器中打开http://localhost:7860，即可开始搜索！

常见问题

如何通过浏览器地址栏进行搜索？

您可以将MiniSearch设为浏览器地址栏的搜索引擎，使用模式：http://localhost:7860/?q=%s,其中您的搜索词将替换%s。

如何通过Raycast进行搜索？

您可以将此快捷链接添加到Raycast，输入查询后即可打开MiniSearch并显示搜索结果。您也可以将其修改为指向自己的域名。

能否通过OpenAI兼容API使用自定义模型？

可以！为此，请打开菜单，将“AI处理位置”改为远程服务器（API）。随后配置基础URL，并可选地设置API密钥和要使用的模型。

如何通过密码限制对MiniSearch实例的访问？

创建一个.env文件，并为ACCESS_KEYS设置值。随后重置MiniSearch的Docker容器。

例如，若您想将密码设为PepperoniPizza,则应在.env中添加如下内容：
ACCESS_KEYS="PepperoniPizza"

更多示例请参阅.env.example文件。

我想将自己的MiniSearch实例提供给其他用户使用，允许他们使用我的OpenAI兼容API密钥，但又不想让他们知道密钥本身。这可行吗？

当然！在MiniSearch中，我们把这一文本生成功能称为“内部OpenAI兼容API”。要使用它，需：

1. 在.env文件中配置以下环境变量，以搭建您的OpenAI兼容API端点：
   • INTERNAL_OPENAI_COMPATIBLE_API_BASE_URL：您的API基础URL
   • INTERNAL_OPENAI_COMPATIBLE_API_KEY：您的API访问密钥
   • INTERNAL_OPENAI_COMPATIBLE_API_MODEL：要使用的模型
   • INTERNAL_OPENAI_COMPATIBLE_API_NAME：在UI中显示的名称
2. 重启MiniSearch服务器。
3. 在MiniSearch菜单中，从“AI处理位置”下拉菜单中选择新选项（名称根据您设置的INTERNAL_OPENAI_COMPATIBLE_API_NAME命名）。

我该如何为这款工具的开发贡献力量？

我们非常欢迎贡献！请阅读我们的贡献指南，了解详细的入门信息。

快速入门：

1. Fork本仓库并克隆
2. 启动开发服务器：docker compose up
3. 进行修改并测试
4. 推送到您的fork并提交pull request

所有贡献均受欢迎！🎉

在哪里可以找到更多信息？

• 贡献指南——如何为MiniSearch贡献力量
• 行为准则——我们的社区规范
• 安全政策——如何报告安全漏洞
• 文档——项目的详细说明

MiniSearch 快速上手指南

环境准备

• 操作系统：Windows / macOS / Linux 均可
• 前置依赖：安装 Docker（国内用户可使用 DaoCloud 镜像 加速）

安装步骤（任选其一）

方案 1：一行命令启动（推荐）

docker run -p 7860:7860 ghcr.io/felladrin/minisearch:main

方案 2：Docker Compose（已有项目）

在 docker-compose.yml 追加：

services:
  minisearch:
    image: ghcr.io/felladrin/minisearch:main
    ports:
      - "7860:7860"

然后执行：

docker compose up -d

方案 3：源码构建

# 下载源码
git clone https://github.com/felladrin/MiniSearch.git
cd MiniSearch

# 构建并启动
docker compose -f docker-compose.production.yml up --build

基本使用

1. 容器启动后，浏览器访问 http://localhost:7860
2. 在输入框键入问题 → 回车，即可同时获得搜索结果与 AI 回答
3. 想更快？把浏览器地址栏搜索引擎设为：

   http://localhost:7860/?q=%s
   

   以后直接在地址栏输入关键词即可搜索。