feat: Add optional SearXNG deployment for web search

first commented

2025-07-23 21:48:55 +00:00

Owner

This pull request introduces a major new feature: the ability to automatically deploy and configure a private, secure SearXNG instance alongside Open WebUI. This provides powerful, private web search capabilities that can be used by models, either through the native Web Search setting or via advanced Python tools.

This merge finalizes the searxng feature branch, incorporating all the bug fixes and robust configurations discovered during its development.

Key Changes:

New SearXNG Deployment Module (onepush.sh):
- Adds a new, skippable user prompt to enable the deployment of a SearXNG container.
- Prompts for a separate, customizable domain for the public-facing search engine.
- Includes an optional prompt for a Brave Search API key to enhance search quality.
Robust Container Orchestration (onepush.sh):
- Creates a shared Docker network (open-webui-net) to allow secure, internal communication between the Open WebUI and SearXNG containers.
- Deploys the searxng/searxng container and publishes its port securely to the host's localhost interface for Nginx to access.
- Adds a custom user.yml override to the SearXNG configuration, enabling the json format required by Open WebUI tools.
Secure Public Access (onepush.sh):
- Dynamically creates a new Nginx reverse proxy configuration for the SearXNG domain.
- Adds a mandatory HTTP Basic Authentication layer to protect the public-facing search interface from abuse.
- Automatically obtains and configures a Let's Encrypt SSL certificate for the new search domain.
Comprehensive Documentation (README.md):
- The README.md has been completely updated to reflect the new functionality.
- Crucially, it now includes a detailed "Post-Installation" guide that explains the two methods for integrating the new SearXNG instance with Open WebUI:
  1. Option A: Configuring the native "Web Search" feature in the admin panel.
  2. Option B: Setting up the advanced research_tool.py by loading it from its URL and setting the required SEARXNG_BASE_URL environment variable.

This pull request introduces a major new feature: the ability to automatically deploy and configure a private, secure SearXNG instance alongside Open WebUI. This provides powerful, private web search capabilities that can be used by models, either through the native Web Search setting or via advanced Python tools. This merge finalizes the `searxng` feature branch, incorporating all the bug fixes and robust configurations discovered during its development. #### Key Changes: * **New SearXNG Deployment Module (`onepush.sh`):** * Adds a new, skippable user prompt to enable the deployment of a SearXNG container. * Prompts for a separate, customizable domain for the public-facing search engine. * Includes an optional prompt for a Brave Search API key to enhance search quality. * **Robust Container Orchestration (`onepush.sh`):** * Creates a shared Docker network (`open-webui-net`) to allow secure, internal communication between the Open WebUI and SearXNG containers. * Deploys the `searxng/searxng` container and publishes its port securely to the host's localhost interface for Nginx to access. * Adds a custom `user.yml` override to the SearXNG configuration, enabling the `json` format required by Open WebUI tools. * **Secure Public Access (`onepush.sh`):** * Dynamically creates a new Nginx reverse proxy configuration for the SearXNG domain. * Adds a mandatory HTTP Basic Authentication layer to protect the public-facing search interface from abuse. * Automatically obtains and configures a Let's Encrypt SSL certificate for the new search domain. * **Comprehensive Documentation (`README.md`):** * The `README.md` has been completely updated to reflect the new functionality. * **Crucially, it now includes a detailed "Post-Installation" guide** that explains the two methods for integrating the new SearXNG instance with Open WebUI: 1. **Option A:** Configuring the native "Web Search" feature in the admin panel. 2. **Option B:** Setting up the advanced `research_tool.py` by loading it from its URL and setting the required `SEARXNG_BASE_URL` environment variable.

first added 7 commits 2025-07-23 21:48:56 +00:00