2.4 KiB
2.4 KiB
Documentation
Getting it running
- install-ubuntu-desktop.md — start to finish on a clean machine. Read this one first.
- deployment/ — compose files for the three services that live outside this repo: Ollama, Open WebUI and Gitea.
- open-webui.md — registering the tool server and configuring the model.
Using and tuning it
- configuration.md — every file in
configs/, every setting. - tools.md — all 22 tools, what each needs, and how to switch one off.
- advanced-params.md — recommended parameters for both models, and the three timeouts that must agree.
- filters.md — the five optional Open WebUI plugins.
- verifying.md —
./verify.py: what is set up, what is switched off, and what is broken. - operating.md — logs, rate limits, the cache, restarting things safely, known constraints and a troubleshooting table.
- ../logs/ — every component writes its own log file there; one page saying which is which.
- setup/ — one short page per tool that needs anything beyond
docker compose up: searxng · octave · vm-agent · gitea · contact · github-token · stackexchange · nvd
The VM sub-agent
- vm-agent/overview.md — what it is and how the isolation works.
- setup/vm-agent.md — the setup checklist.
- vm-agent/base-images.md — installation media, building a base image, and what "frozen" means.
- vm-agent/troubleshooting.md — including how to find out what a session actually did.
Why it is the way it is
- TUNING.md — the change log. Every entry is one change: what it was meant to fix, and what measurably happened afterwards. It is long, and it is the most useful document here if you intend to modify anything.
- testing/ — the corpus those measurements came from: forty graded prompts with rubrics, transcripts and scores.