mirror of
https://github.com/open-webui/docs
synced 2025-05-20 19:26:22 +00:00
Add documentation for Yacy config
This commit is contained in:
parent
0264608216
commit
5c21b94f29
28
docs/tutorials/web-search/yacy.md
Normal file
28
docs/tutorials/web-search/yacy.md
Normal file
@ -0,0 +1,28 @@
|
||||
---
|
||||
sidebar_position: 16
|
||||
title: "Yacy"
|
||||
---
|
||||
|
||||
:::warning
|
||||
This tutorial is a community contribution and is not supported by the Open WebUI team. It serves only as a demonstration on how to customize Open WebUI for your specific use case. Want to contribute? Check out the contributing tutorial.
|
||||
:::
|
||||
|
||||
## Yacy API
|
||||
|
||||
### Setup
|
||||
|
||||
1. Navigate to: `Admin Panel` -> `Settings` -> `Web Search`
|
||||
2. Toggle `Enable Web Search`
|
||||
3. Set `Web Search Engine` from dropdown menu to `yacy`
|
||||
4. Set `Yacy Instance URL` to one of the following examples:
|
||||
|
||||
* `http://yacy:8090` (using the container name and exposed port, suitable for Docker-based setups)
|
||||
* `http://host.docker.internal:8090` (using the `host.docker.internal` DNS name and the host port, suitable for Docker-based setups)
|
||||
* `https://<yacy.local>:8443` (using a local domain name, suitable for local network access)
|
||||
* `https://yacy.example.com` (using a custom domain name for a self-hosted Yacy instance, suitable for public or private access)
|
||||
* `https://yacy.example.com:8443` (using https over the default Yacy https port)
|
||||
|
||||
5. Optionally, enter your Yacy username and password if authentication is required for your Yacy instance. If both are left blank, digest authentication will be skipped
|
||||
6. Press save
|
||||
|
||||

|
BIN
static/images/tutorial_yacy.png
Normal file
BIN
static/images/tutorial_yacy.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 36 KiB |
Loading…
Reference in New Issue
Block a user