Files
owui-tools/docs/setup/contact.md
T
2026-09-15 15:24:03 -04:00

43 lines
1.2 KiB
Markdown

# `OWUITOOLS_CONTACT` — needed by `wikipedia_lookup` and `search_papers`
Two minutes. No account, no key.
## Why
Wikimedia **requires** a descriptive User-Agent with a way to contact you, and returns
**HTTP 403** without one. Their policy also rules out generic strings like `curl/8.5.0`,
which work today and may not tomorrow. OpenAlex and Crossref read the same string to decide
whether you get their "polite pool", which is noticeably faster.
The tool server builds the header from this one value:
```
owuitools/1.0 (+<your Open WebUI URL>; <OWUITOOLS_CONTACT>)
```
## Steps
1. Open `configs/owuitools.env`.
2. Set it to an address someone could actually reach you at:
```
OWUITOOLS_CONTACT=you@example.com
```
3. `docker compose up -d api`
## Checking it
```sh
./tests/try-tool.sh wikipedia_lookup '{"topic": "Ampere"}' | head -5
```
A 403 from Wikimedia comes back as prose saying the request was refused. Anything else
means the header was accepted.
## If you leave it unset
It defaults to `owuitools@localhost`, which is a valid string but not a real contact.
Wikipedia lookups may be refused, and paper searches will be slower. Nothing else is
affected.