mirror of
https://github.com/langgenius/dify-docs-archived.git
synced 2026-07-01 20:35:52 -04:00
Adding Documentation on SearXNG functions (#429)
* Update searxng.md Add how to set up private instance for SearXNG with LinuxVM to ensure SearXNG instance always running * Update searxng.md for Chinese Version Add description on how to deploy SearXNG on a LinuxVM
This commit is contained in:
Xinghan Pan
@@ -26,3 +26,175 @@ docker run --rm -d -p 8081:8080 -v "${PWD}/api/core/tools/provider/builtin/searx
|
||||
## 3. Use SearXNG
|
||||
|
||||
Fill in the access address in "Tools > SearXNG > Authenticate" to establish a connection between the Dify service and the SearXNG service. The Docker internal address for SearXNG is usually `http://host.docker.internal:8081`.
|
||||
|
||||
---
|
||||
|
||||
# Hosting SearXNG on a Linux VM for a Private Instance
|
||||
|
||||
This section covers how to host **SearXNG** on a **Linux VM** and make it accessible to Dify.
|
||||
|
||||
### 1. Prepare the Linux VM
|
||||
|
||||
Ensure your Linux VM has the following:
|
||||
|
||||
- A **fresh installation** of a supported Linux distribution (e.g., Ubuntu 24.04 or any Debian-based distribution).
|
||||
- **Docker** and **Docker Compose** installed.
|
||||
|
||||
#### 1.1 Install Docker
|
||||
|
||||
Follow these commands to install Docker:
|
||||
|
||||
```bash
|
||||
# Update your package list
|
||||
sudo apt update
|
||||
|
||||
# Install necessary packages
|
||||
sudo apt install apt-transport-https ca-certificates curl software-properties-common
|
||||
|
||||
# Add Docker's GPG key
|
||||
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
|
||||
|
||||
# Add Docker's official repository
|
||||
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
|
||||
|
||||
# Install Docker
|
||||
sudo apt update
|
||||
sudo apt install docker-ce docker-ce-cli containerd.io
|
||||
```
|
||||
|
||||
Verify Docker installation:
|
||||
|
||||
```bash
|
||||
docker --version
|
||||
```
|
||||
|
||||
#### 1.2 Install Docker Compose
|
||||
|
||||
```bash
|
||||
sudo curl -L "https://github.com/docker/compose/releases/download/2.32.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
|
||||
sudo chmod +x /usr/local/bin/docker-compose
|
||||
```
|
||||
|
||||
Verify Docker Compose installation:
|
||||
|
||||
```bash
|
||||
docker-compose --version
|
||||
```
|
||||
|
||||
### 2. Set Up SearXNG Docker Container
|
||||
|
||||
#### 2.1 Clone the SearXNG Docker Repository
|
||||
|
||||
Clone the SearXNG repository into your desired directory on the Linux VM:
|
||||
|
||||
```bash
|
||||
git clone https://github.com/searxng/searxng-docker.git
|
||||
cd searxng-docker
|
||||
```
|
||||
|
||||
#### 2.2 Modify Docker Configuration
|
||||
|
||||
1. **Edit the `docker-compose.yaml` file** to bind SearXNG to port `8081` and configure Redis. Ensure it looks like this:
|
||||
|
||||
```yaml
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
searxng:
|
||||
image: searxng/searxng:latest
|
||||
ports:
|
||||
- "8081:8080"
|
||||
volumes:
|
||||
- ./searxng:/etc/searxng
|
||||
networks:
|
||||
- searxng_network
|
||||
|
||||
redis:
|
||||
image: valkey/valkey:8-alpine
|
||||
ports:
|
||||
- "6379:6379"
|
||||
networks:
|
||||
- searxng_network
|
||||
|
||||
caddy:
|
||||
image: caddy:2-alpine
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
networks:
|
||||
- searxng_network
|
||||
|
||||
networks:
|
||||
searxng_network:
|
||||
driver: bridge
|
||||
```
|
||||
|
||||
2. **Edit the `settings.yml`** configuration file to set the bind address and enable JSON format:
|
||||
|
||||
```yaml
|
||||
server:
|
||||
bind_address: "0.0.0.0" # Allow external access
|
||||
port: 8080
|
||||
|
||||
search:
|
||||
formats:
|
||||
- html
|
||||
- json
|
||||
- csv
|
||||
- rss
|
||||
```
|
||||
|
||||
#### 2.3 Build and Start the Docker Containers
|
||||
|
||||
Once you’ve made the necessary changes, run the following command to start the containers:
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### 3. Expose SearXNG to the Public Network
|
||||
|
||||
By default, SearXNG in Docker will be bound to `localhost` or `127.0.0.1`. To make it accessible externally (especially for Dify to connect), ensure the port `8081` is open on your Linux VM and that you’re using the appropriate public IP address.
|
||||
|
||||
You can check your VM's IP address with:
|
||||
|
||||
```bash
|
||||
ip addr show
|
||||
```
|
||||
|
||||
For the SearXNG service to be accessed from other machines or services (like Dify), you need to replace the Docker internal URL with your VM's public IP address.
|
||||
|
||||
---
|
||||
|
||||
# 4. Connect SearXNG with Dify
|
||||
|
||||
Once your SearXNG instance is up and running on the Linux VM, you need to authenticate it in Dify.
|
||||
|
||||
### 4.1 Configure Dify
|
||||
|
||||
1. Go to **Tools > SearXNG > Authenticate** in the Dify platform.
|
||||
2. Enter the **Base URL** of your self-hosted SearXNG instance, using your VM’s IP address:
|
||||
|
||||
```text
|
||||
http://<your-linux-vm-ip>:8081
|
||||
```
|
||||
|
||||
3. After entering the correct URL, save the configuration.
|
||||
|
||||
---
|
||||
|
||||
## 5. Testing SearXNG Integration
|
||||
|
||||
You can test if everything is working correctly by making a sample search using `curl`:
|
||||
|
||||
```bash
|
||||
curl "http://<your-linux-vm-ip>:8081/search?q=apple&format=json&categories=general"
|
||||
```
|
||||
|
||||
You should receive a JSON response with search results for "apple".
|
||||
|
||||
---
|
||||
|
||||
## Conclusion
|
||||
|
||||
By following these steps, you can successfully host a private instance of **SearXNG** on your **Linux VM** and integrate it with **Dify**. You’ll have your own self-hosted search engine, ensuring privacy and customization for your needs.
|
||||
|
||||
@@ -30,3 +30,171 @@ docker run --rm -d -p 8081:8080 -v "${PWD}/api/core/tools/provider/builtin/searx
|
||||
## 3. 使用 SearXNG
|
||||
|
||||
在 `工具 > SearXNG > 去认证` 中填写访问地址，建立 Dify 服务与 SearXNG 服务的连接。SearXNG 的 Docker 内网地址一般是 `http://host.docker.internal:8081`。
|
||||
|
||||
|
||||
---
|
||||
|
||||
# 在 Linux VM 上托管 SearXNG 作为私有实例
|
||||
|
||||
本节将指导你如何在 **Linux VM** 上托管 SearXNG 并确保它可以与 Dify 集成。
|
||||
|
||||
### 1. 准备 Linux VM 环境
|
||||
|
||||
确保你的 Linux VM 环境具备以下条件：
|
||||
|
||||
- **安装了 Docker 和 Docker Compose**。
|
||||
- 你可以使用任何支持的 Linux 发行版（如 Ubuntu 24.04 或其他基于 Debian 的系统）。
|
||||
|
||||
#### 1.1 安装 Docker
|
||||
|
||||
运行以下命令来安装 Docker：
|
||||
|
||||
```bash
|
||||
# 更新包列表
|
||||
sudo apt update
|
||||
|
||||
# 安装必要的包
|
||||
sudo apt install apt-transport-https ca-certificates curl software-properties-common
|
||||
|
||||
# 添加 Docker GPG 密钥
|
||||
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
|
||||
|
||||
# 添加 Docker 官方仓库
|
||||
echo "deb [arch=amd64 signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
|
||||
|
||||
# 安装 Docker
|
||||
sudo apt update
|
||||
sudo apt install docker-ce docker-ce-cli containerd.io
|
||||
```
|
||||
|
||||
验证 Docker 是否安装成功：
|
||||
|
||||
```bash
|
||||
docker --version
|
||||
```
|
||||
|
||||
#### 1.2 安装 Docker Compose
|
||||
|
||||
运行以下命令来安装 Docker Compose：
|
||||
|
||||
```bash
|
||||
sudo curl -L "https://github.com/docker/compose/releases/download/2.32.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
|
||||
sudo chmod +x /usr/local/bin/docker-compose
|
||||
```
|
||||
|
||||
验证 Docker Compose 是否安装成功：
|
||||
|
||||
```bash
|
||||
docker-compose --version
|
||||
```
|
||||
|
||||
### 2. 设置 SearXNG Docker 容器
|
||||
|
||||
#### 2.1 克隆 SearXNG Docker 仓库
|
||||
|
||||
首先，克隆 SearXNG Docker 仓库到你的 Linux VM 中：
|
||||
|
||||
```bash
|
||||
git clone https://github.com/searxng/searxng-docker.git
|
||||
cd searxng-docker
|
||||
```
|
||||
|
||||
#### 2.2 修改 Docker 配置文件
|
||||
|
||||
1. **修改 `docker-compose.yaml` 文件**，确保 SearXNG 服务绑定到端口 `8081`，并且配置 Redis 服务。修改后的 `docker-compose.yaml` 文件如下所示：
|
||||
|
||||
```yaml
|
||||
version: '3'
|
||||
|
||||
services:
|
||||
searxng:
|
||||
image: searxng/searxng:latest
|
||||
ports:
|
||||
- "8081:8080" # 将容器的 8080 端口映射到宿主机的 8081 端口
|
||||
volumes:
|
||||
- ./searxng:/etc/searxng # 配置 SearXNG 配置文件的挂载
|
||||
networks:
|
||||
- searxng_network
|
||||
|
||||
redis:
|
||||
image: valkey/valkey:8-alpine
|
||||
ports:
|
||||
- "6379:6379" # Redis 服务映射端口
|
||||
networks:
|
||||
- searxng_network
|
||||
|
||||
caddy:
|
||||
image: caddy:2-alpine
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
networks:
|
||||
- searxng_network
|
||||
|
||||
networks:
|
||||
searxng_network:
|
||||
driver: bridge
|
||||
```
|
||||
|
||||
2. **修改 `settings.yml` 配置文件**，确保 SearXNG 监听所有 IP 地址并启用 JSON 格式的输出：
|
||||
|
||||
```yaml
|
||||
server:
|
||||
bind_address: "0.0.0.0" # 允许外部访问
|
||||
port: 8080
|
||||
|
||||
search:
|
||||
formats:
|
||||
- html
|
||||
- json
|
||||
- csv
|
||||
- rss
|
||||
```
|
||||
|
||||
#### 2.3 启动 Docker 容器
|
||||
|
||||
修改完配置文件后，使用以下命令启动 Docker 容器：
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
### 3. 使 SearXNG 服务可访问
|
||||
|
||||
默认情况下，Docker 容器将绑定到 `localhost` 或 `127.0.0.1`。如果你希望外部设备（如 Dify）能访问 SearXNG，你需要确保你的 Linux VM 可以通过公共 IP 地址访问端口 `8081`。
|
||||
|
||||
你可以查看你的 VM 的公共 IP 地址：
|
||||
|
||||
```bash
|
||||
ip addr show
|
||||
```
|
||||
|
||||
确保你的防火墙已开放 `8081` 端口。
|
||||
|
||||
---
|
||||
|
||||
# 4. 将 SearXNG 与 Dify 集成
|
||||
|
||||
一旦你的 SearXNG 实例在 Linux VM 上运行，你可以将其与 Dify 进行连接。
|
||||
|
||||
### 4.1 配置 Dify
|
||||
|
||||
1. 在 Dify 平台的 **工具 > SearXNG > 去认证** 页面中，输入你的自建 SearXNG 服务的 **Base URL**，格式为：
|
||||
|
||||
```text
|
||||
http://<your-linux-vm-ip>:8081
|
||||
```
|
||||
|
||||
2. 保存配置后，Dify 将能够连接到你的 SearXNG 实例。
|
||||
|
||||
---
|
||||
|
||||
## 5. 测试 SearXNG 集成
|
||||
|
||||
你可以通过 `curl` 命令测试 SearXNG 服务是否正常工作：
|
||||
|
||||
```bash
|
||||
curl "http://<your-linux-vm-ip>:8081/search?q=apple&format=json&categories=general"
|
||||
```
|
||||
|
||||
如果一切正常，你应该收到包含 "apple" 搜索结果的 JSON 响应。
|
||||
|
||||
Reference in New Issue
Block a user