wehub/itzcrazykns--vane
1
0
Fork 0
Code Issues Pull Requests Actions Deployments Models Agent Notes Packages Projects Releases Wiki Activity

docs: make Chinese README the default

Browse Source
This commit is contained in:
wehub-resource-sync
2026-07-13 10:27:41 +00:00
parent 5c5b7d401f
commit 69241917d0
1 changed files with 99 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+99 -93
View File
@@ -1,3 +1,9 @@
<!-- WEHUB_ZH_README -->
> [!NOTE]
> 本文档由 WeHub 基于上游 README 翻译整理，属于社区翻译，非官方中文文档。
> [English](./README.en.md) · [原始项目](https://github.com/ItzCrazyKns/Vane) · [上游 README](https://github.com/ItzCrazyKns/Vane/blob/HEAD/README.md)
> 原作者、版权与许可证归属以原始项目及本仓库 LICENSE 文件为准。
# Vane 🔍
[![GitHub Repo stars](https://img.shields.io/github/stars/ItzCrazyKns/Vane?style=social)](https://github.com/ItzCrazyKns/Vane/stargazers)
@@ -8,41 +14,41 @@
[![GitHub last commit](https://img.shields.io/github/last-commit/ItzCrazyKns/Vane?color=green)](https://github.com/ItzCrazyKns/Vane/commits/master)
[![Discord](https://dcbadge.limes.pink/api/server/26aArMy8tT?style=flat)](https://discord.gg/26aArMy8tT)
Vane is a **privacy-focused AI answering engine** that runs entirely on your own hardware. It combines knowledge from the vast internet with support for **local LLMs** (Ollama) and cloud providers (OpenAI, Claude, Groq), delivering accurate answers with **cited sources** while keeping your searches completely private.
Vane 是一款**注重隐私的 AI 问答引擎**，完全运行在你自己的硬件上。它将来自广阔互联网的知识与对**本地 LLM**（Ollama）及云端服务商（OpenAI、Claude、Groq）的支持相结合，在提供带有**引用来源**的准确答案的同时，让你的搜索完全保持私密。
![preview](.assets/vane-screenshot.png)
Want to know more about its architecture and how it works? You can read it [here](https://github.com/ItzCrazyKns/Vane/tree/master/docs/architecture/README.md).
想了解其架构和工作原理？可以[在此阅读](https://github.com/ItzCrazyKns/Vane/tree/master/docs/architecture/README.md).
## ✨ Features
🤖 **Support for all major AI providers** - Use local LLMs through Ollama or connect to OpenAI, Anthropic Claude, Google Gemini, Groq, and more. Mix and match models based on your needs.
🤖 **支持所有主流 AI 服务商** - 通过 Ollama 使用本地 LLM，或连接 OpenAI、Anthropic Claude、Google Gemini、Groq 等。可根据需求灵活搭配模型。
⚡ **Smart search modes** - Choose Speed Mode when you need quick answers, Balanced Mode for everyday searches, or Quality Mode for deep research.
⚡ **智能搜索模式** - 需要快速答案时选择 Speed Mode（速度模式），日常搜索使用 Balanced Mode（平衡模式），深度研究时选择 Quality Mode（质量模式）。
🧭 **Pick your sources** - Search the web, discussions, or academic papers. More sources and integrations are in progress.
🧭 **选择你的来源** - 搜索网页、讨论区或学术论文。更多来源和集成正在开发中。
🧩 **Widgets** - Helpful UI cards that show up when relevant, like weather, calculations, stock prices, and other quick lookups.
🧩 **Widgets（小组件）** - 在相关场景下显示实用的 UI 卡片，例如天气、计算、股价及其他快速查询。
🔍 **Web search powered by SearxNG** - Access multiple search engines while keeping your identity private. Support for Tavily and Exa coming soon for even better results.
🔍 **由 SearxNG 驱动的网页搜索** - 在保护身份隐私的同时访问多个搜索引擎。即将支持 Tavily 和 Exa，以获得更出色的结果。
📷 **Image and video search** - Find visual content alongside text results. Search isn't limited to just articles anymore.
📷 **图片和视频搜索** - 在文本结果之外查找视觉内容。搜索不再局限于文章。
📄 **File uploads** - Upload documents and ask questions about them. PDFs, text files, images - Vane understands them all.
📄 **文件上传** - 上传文档并针对其提问。PDF、文本文件、图片——Vane 都能理解。
🌐 **Search specific domains** - Limit your search to specific websites when you know where to look. Perfect for technical documentation or research papers.
🌐 **搜索特定域名** - 当你知道该去哪里查找时，可将搜索限定在特定网站。非常适合技术文档或研究论文。
💡 **Smart suggestions** - Get intelligent search suggestions as you type, helping you formulate better queries.
💡 **智能建议** - 输入时获得智能搜索建议，帮助你构建更好的查询。
📚 **Discover** - Browse interesting articles and trending content throughout the day. Stay informed without even searching.
📚 **Discover（发现）** - 全天浏览有趣的文章和热门内容。无需搜索也能保持信息更新。
🕒 **Search history** - Every search is saved locally so you can revisit your discoveries anytime. Your research is never lost.
🕒 **搜索历史** - 每次搜索都会本地保存，你可随时回顾自己的发现。你的研究永不丢失。
✨ **More coming soon** - We're actively developing new features based on community feedback. Join our Discord to help shape Vane's future!
✨ **更多功能即将推出** - 我们正在根据社区反馈积极开发新功能。加入我们的 Discord，共同塑造 Vane 的未来！
## Sponsors
Vane's development is powered by the generous support of our sponsors. Their contributions help keep this project free, open-source, and accessible to everyone.
Vane 的开发得益于赞助方的慷慨支持。他们的贡献帮助本项目保持免费、开源，并向所有人开放。
<div align="center">
@@ -53,13 +59,13 @@ Vane's development is powered by the generous support of our sponsors. Their con
### **✨ [Try Warp - The AI-Powered Terminal →](https://www.warp.dev/vane)**
Warp is revolutionizing development workflows with AI-powered features, modern UX, and blazing-fast performance. Used by developers at top companies worldwide.
Warp 正以 AI 驱动功能、现代 UX 和极速性能革新开发工作流。全球顶尖公司的开发者都在使用它。
</div>
---
We'd also like to thank the following partners for their generous support:
我们还要感谢以下合作伙伴的慷慨支持：
<table>
<tr>
@@ -76,191 +82,191 @@ We'd also like to thank the following partners for their generous support:
## Installation
There are mainly 2 ways of installing Vane - With Docker, Without Docker. Using Docker is highly recommended.
安装 Vane 主要有 2 种方式：使用 Docker，或不使用 Docker。强烈推荐使用 Docker。
### Getting Started with Docker (Recommended)
Vane can be easily run using Docker. Simply run the following command:
Vane 可通过 Docker 轻松运行。只需执行以下命令：
```bash
docker run -d -p 3000:3000 -v vane-data:/home/vane/data --name vane itzcrazykns1337/vane:latest
```
This will pull and start the Vane container with the bundled SearxNG search engine. Once running, open your browser and navigate to http://localhost:3000. You can then configure your settings (API keys, models, etc.) directly in the setup screen.
这将拉取并启动带有捆绑 SearxNG 搜索引擎的 Vane 容器。启动后，打开浏览器并访问 http://localhost:3000. 然后即可在设置界面直接配置各项设置（API 密钥、模型等）。
**Note**: The image includes both Vane and SearxNG, so no additional setup is required. The `-v` flags create persistent volumes for your data and uploaded files.
**Note**: 该镜像同时包含 Vane 和 SearxNG，因此无需额外配置。`-v` 标志会为你的数据和上传文件创建持久化卷。
#### Using Vane with Your Own SearxNG Instance
If you already have SearxNG running, you can use the slim version of Vane:
如果你已有正在运行的 SearxNG，可以使用 Vane 的精简版：
```bash
docker run -d -p 3000:3000 -e SEARXNG_API_URL=http://your-searxng-url:8080 -v vane-data:/home/vane/data --name vane itzcrazykns1337/vane:slim-latest
```
**Important**: Make sure your SearxNG instance has:
**Important**: 请确保你的 SearxNG 实例已：
- JSON format enabled in the settings
- Wolfram Alpha search engine enabled
- 在设置中启用 JSON 格式
- 启用 Wolfram Alpha 搜索引擎
Replace `http://your-searxng-url:8080` with your actual SearxNG URL. Then configure your AI provider settings in the setup screen at http://localhost:3000.
将 `http://your-searxng-url:8080` 替换为你的实际 SearxNG URL。然后在 http://localhost:3000. 的设置界面配置 AI 服务商设置。
#### Advanced Setup (Building from Source)
If you prefer to build from source or need more control:
如果你希望从源码构建或需要更多控制：
1. Ensure Docker is installed and running on your system.
2. Clone the Vane repository:
1. 确保系统已安装并运行 Docker。
2. 克隆 Vane 仓库：
```bash
git clone https://github.com/ItzCrazyKns/Vane.git
```
3. After cloning, navigate to the directory containing the project files.
3. 克隆完成后，进入包含项目文件的目录。
4. Build and run using Docker:
4. 使用 Docker 构建并运行：
```bash
docker build -t vane .
docker run -d -p 3000:3000 -v vane-data:/home/vane/data --name vane vane
```
5. Access Vane at http://localhost:3000 and configure your settings in the setup screen.
5. 在 http://localhost:3000 访问 Vane，并在设置界面配置你的设置。
**Note**: After the containers are built, you can start Vane directly from Docker without having to open a terminal.
**Note**: 容器构建完成后，你可以直接从 Docker 启动 Vane，无需打开终端。
### Non-Docker Installation
1. Install SearXNG and allow `JSON` format in the SearXNG settings. Make sure Wolfram Alpha search engine is also enabled.
2. Clone the repository:
1. 安装 SearXNG，并在 SearXNG 设置中允许 `JSON` 格式。同时确保已启用 Wolfram Alpha 搜索引擎。
2. 克隆仓库：
```bash
git clone https://github.com/ItzCrazyKns/Vane.git
cd Vane
```
3. Install dependencies:
3. 安装依赖：
```bash
npm i
```
4. Build the application:
4. 构建应用：
```bash
npm run build
```
5. Start the application:
5. 启动应用：
```bash
npm run start
```
6. Open your browser and navigate to http://localhost:3000 to complete the setup and configure your settings (API keys, models, SearxNG URL, etc.) in the setup screen.
6. 打开浏览器并访问 http://localhost:3000，在设置界面完成配置（API 密钥、模型、SearxNG URL 等）。
**Note**: Using Docker is recommended as it simplifies the setup process, especially for managing environment variables and dependencies.
**Note**: 推荐使用 Docker，因为它能简化安装流程，尤其是在管理环境变量和依赖方面。
See the [installation documentation](https://github.com/ItzCrazyKns/Vane/tree/master/docs/installation) for more information like updating, etc.
有关更新等更多信息的安装文档，请参阅 [installation documentation](https://github.com/ItzCrazyKns/Vane/tree/master/docs/installation)。
### Troubleshooting
#### Local OpenAI-API-Compliant Servers
If Vane tells you that you haven't configured any chat model providers, ensure that:
如果 Vane 提示你尚未配置任何聊天模型服务商，请确保：
1. Your server is running on `0.0.0.0` (not `127.0.0.1`) and on the same port you put in the API URL.
2. You have specified the correct model name loaded by your local LLM server.
3. You have specified the correct API key, or if one is not defined, you have put _something_ in the API key field and not left it empty.
1. 你的服务器运行在 `0.0.0.0`（而非 `127.0.0.1`），且端口与你在 API URL 中填写的端口一致。
2. 你已指定本地 LLM 服务器加载的正确模型名称。
3. 你已指定正确的 API 密钥；若未定义密钥，也请在 API 密钥字段中填入_任意内容_，不要留空。
#### Ollama Connection Errors
If you're encountering an Ollama connection error, it is likely due to the backend being unable to connect to Ollama's API. To fix this issue you can:
如果你遇到 Ollama 连接错误，很可能是后端无法连接到 Ollama 的 API。可按以下方式修复：
1. **Check your Ollama API URL:** Ensure that the API URL is correctly set in the settings menu.
2. **Update API URL Based on OS:**
1. **检查你的 Ollama API URL：** 确保在设置菜单中正确配置了 API URL。
2. **根据操作系统更新 API URL：**
- **Windows:** Use `http://host.docker.internal:11434`
- **Mac:** Use `http://host.docker.internal:11434`
- **Linux:** Use `http://<private_ip_of_host>:11434`
- **Windows:** 使用 `http://host.docker.internal:11434`
- **Mac:** 使用 `http://host.docker.internal:11434`
- **Linux:** 使用 `http://<private_ip_of_host>:11434`
Adjust the port number if you're using a different one.
若你使用其他端口，请相应调整端口号。
3. **Linux Users - Expose Ollama to Network:**
3. **Linux 用户 — 将 Ollama 暴露到网络：**
- Inside `/etc/systemd/system/ollama.service`, you need to add `Environment="OLLAMA_HOST=0.0.0.0:11434"`. (Change the port number if you are using a different one.) Then reload the systemd manager configuration with `systemctl daemon-reload`, and restart Ollama by `systemctl restart ollama`. For more information see [Ollama docs](https://github.com/ollama/ollama/blob/main/docs/faq.md#setting-environment-variables-on-linux)
- 在 `/etc/systemd/system/ollama.service` 中，你需要添加 `Environment="OLLAMA_HOST=0.0.0.0:11434"`。（若你使用其他端口，请相应调整端口号。）然后使用 `systemctl daemon-reload` 重新加载 systemd 管理器配置，并通过 `systemctl restart ollama` 重启 Ollama。更多信息请参阅 [Ollama 文档](https://github.com/ollama/ollama/blob/main/docs/faq.md#setting-environment-variables-on-linux)
- Ensure that the port (default is 11434) is not blocked by your firewall.
- 确保该端口（默认为 11434）未被防火墙拦截。
#### Lemonade Connection Errors
#### Lemonade 连接错误
If you're encountering a Lemonade connection error, it is likely due to the backend being unable to connect to Lemonade's API. To fix this issue you can:
如果你遇到 Lemonade 连接错误，很可能是后端无法连接到 Lemonade 的 API。可按以下步骤排查：
1. **Check your Lemonade API URL:** Ensure that the API URL is correctly set in the settings menu.
2. **Update API URL Based on OS:**
1. **检查 Lemonade API URL：** 确保在设置菜单中正确配置了 API URL。
2. **根据操作系统更新 API URL：**
- **Windows:** Use `http://host.docker.internal:8000`
- **Mac:** Use `http://host.docker.internal:8000`
- **Linux:** Use `http://<private_ip_of_host>:8000`
- **Windows：** 使用 `http://host.docker.internal:8000`
- **Mac：** 使用 `http://host.docker.internal:8000`
- **Linux：** 使用 `http://<private_ip_of_host>:8000`
Adjust the port number if you're using a different one.
若你使用其他端口，请相应调整端口号。
3. **Ensure Lemonade Server is Running:**
3. **确保 Lemonade 服务器正在运行：**
- Make sure your Lemonade server is running and accessible on the configured port (default is 8000).
- Verify that Lemonade is configured to accept connections from all interfaces (`0.0.0.0`), not just localhost (`127.0.0.1`).
- Ensure that the port (default is 8000) is not blocked by your firewall.
- 确保 Lemonade 服务器正在运行，且可在配置的端口（默认为 8000）上访问。
- 确认 Lemonade 已配置为接受来自所有接口的连接（`0.0.0.0`），而不仅是 localhost（`127.0.0.1`）。
- 确保该端口（默认为 8000）未被防火墙拦截。
## Using as a Search Engine
## 作为搜索引擎使用
If you wish to use Vane as an alternative to traditional search engines like Google or Bing, or if you want to add a shortcut for quick access from your browser's search bar, follow these steps:
若你想将 Vane 作为 Google 或 Bing 等传统搜索引擎的替代方案，或希望在浏览器搜索栏中添加快速访问快捷方式，请按以下步骤操作：
1. Open your browser's settings.
2. Navigate to the 'Search Engines' section.
3. Add a new site search with the following URL: `http://localhost:3000/?q=%s`. Replace `localhost` with your IP address or domain name, and `3000` with the port number if Vane is not hosted locally.
4. Click the add button. Now, you can use Vane directly from your browser's search bar.
1. 打开浏览器设置。
2. 进入「搜索引擎」部分。
3. 添加新的站点搜索，URL 如下：`http://localhost:3000/?q=%s`。将 `localhost` 替换为你的 IP 地址或域名；若 Vane 未在本地托管，则将 `3000` 替换为端口号。
4. 点击添加按钮。之后即可直接从浏览器搜索栏使用 Vane。
## Using Vane's API
## 使用 Vane API
Vane also provides an API for developers looking to integrate its powerful search engine into their own applications. You can run searches, use multiple models and get answers to your queries.
Vane 还为希望将强大搜索引擎集成到自有应用中的开发者提供 API。你可以执行搜索、使用多种模型，并获取查询答案。
For more details, check out the full documentation [here](https://github.com/ItzCrazyKns/Vane/tree/master/docs/API/SEARCH.md).
更多详情，请查看完整文档[此处](https://github.com/ItzCrazyKns/Vane/tree/master/docs/API/SEARCH.md).
## Expose Vane to network
## 将 Vane 暴露到网络
Vane runs on Next.js and handles all API requests. It works right away on the same network and stays accessible even with port forwarding.
Vane 基于 Next.js 运行，并处理所有 API 请求。在同一网络内可立即使用，即使进行端口转发也能保持可访问。
## One-Click Deployment
## 一键部署
[![Deploy to Sealos](https://raw.githubusercontent.com/labring-actions/templates/main/Deploy-on-Sealos.svg)](https://usw.sealos.io/?openapp=system-template%3FtemplateName%3Dperplexica)
[![Deploy to RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploylobe.svg)](https://repocloud.io/details/?app_id=267)
[![Run on ClawCloud](https://raw.githubusercontent.com/ClawCloud/Run-Template/refs/heads/main/Run-on-ClawCloud.svg)](https://template.run.claw.cloud/?referralCode=U11MRQ8U9RM4&openapp=system-fastdeploy%3FtemplateName%3Dperplexica)
[![Deploy on Hostinger](https://assets.hostinger.com/vps/deploy.svg)](https://www.hostinger.com/vps/docker-hosting?compose_url=https://raw.githubusercontent.com/ItzCrazyKns/Vane/refs/heads/master/docker-compose.yaml)
## Upcoming Features
## 即将推出的功能
- [ ] Adding more widgets, integrations, search sources
- [ ] Adding ability to create custom agents (name T.B.D.)
- [ ] Adding authentication
- [ ] 添加更多小组件、集成与搜索源
- [ ] 添加创建自定义智能体（Agent）的能力（名称待定）
- [ ] 添加身份认证
## Support Us
## 支持我们
If you find Vane useful, consider giving us a star on GitHub. This helps more people discover Vane and supports the development of new features. Your support is greatly appreciated.
若你觉得 Vane 有用，欢迎在 GitHub 上为我们点 Star。这有助于更多人发现 Vane，并支持新功能的开发。我们非常感谢你的支持。
### Donations
### 捐赠
We also accept donations to help sustain our project. If you would like to contribute, you can use the following options to donate. Thank you for your support!
我们也接受捐赠以维持项目运营。若你愿意贡献，可通过以下方式捐赠。感谢你的支持！
| Ethereum |
| ----------------------------------------------------- |
| Address: `0xB025a84b2F269570Eb8D4b05DEdaA41D8525B6DD` |
| 地址：`0xB025a84b2F269570Eb8D4b05DEdaA41D8525B6DD` |
## Contribution
## 贡献
Vane is built on the idea that AI and large language models should be easy for everyone to use. If you find bugs or have ideas, please share them in via GitHub Issues. For more information on contributing to Vane you can read the [CONTRIBUTING.md](CONTRIBUTING.md) file to learn more about Vane and how you can contribute to it.
Vane 的理念是让 AI 与大语言模型（LLM）对每个人都易于使用。若你发现 bug 或有想法，请通过 GitHub Issues 分享。有关如何为 Vane 做贡献的更多信息，可阅读 [CONTRIBUTING.md](CONTRIBUTING.md) 文件，进一步了解 Vane 及你的参与方式。
## Help and Support
## 帮助与支持
If you have any questions or feedback, please feel free to reach out to us. You can create an issue on GitHub or join our Discord server. There, you can connect with other users, share your experiences and reviews, and receive more personalized help. [Click here](https://discord.gg/EFwsmQDgAu) to join the Discord server. To discuss matters outside of regular support, feel free to contact me on Discord at `itzcrazykns`.
如有任何问题或反馈，欢迎联系我们。你可以在 GitHub 上创建 issue，或加入我们的 Discord 服务器。在那里你可以与其他用户交流、分享体验与评价，并获得更个性化的帮助。[点此](https://discord.gg/EFwsmQDgAu) 加入 Discord 服务器。如需讨论常规支持范围以外的事项，欢迎在 Discord 上通过 `itzcrazykns` 联系我。
Thank you for exploring Vane, the AI-powered search engine designed to enhance your search experience. We are constantly working to improve Vane and expand its capabilities. We value your feedback and contributions which help us make Vane even better. Don't forget to check back for updates and new features!
感谢你探索 Vane——这款旨在提升搜索体验的 AI 驱动搜索引擎。我们持续改进 Vane 并扩展其能力。我们珍视你的反馈与贡献，它们帮助我们让 Vane 变得更好。别忘了常回来看看更新与新功能！