Skip to content

docs: refresh README for Ollama + OpenWebUI deployment#5

Merged
dwetmore merged 1 commit into
mainfrom
codex/update-readme.md-for-accuracy-and-clarity
Feb 10, 2026
Merged

docs: refresh README for Ollama + OpenWebUI deployment#5
dwetmore merged 1 commit into
mainfrom
codex/update-readme.md-for-accuracy-and-clarity

Conversation

@dwetmore
Copy link
Copy Markdown
Owner

Motivation

  • Make the README accurate and durable by limiting the documented deployment to the currently deployed components: Ollama and OpenWebUI only.
  • Remove brittle, host-specific documentation and replace it with a durable nip.io pattern and a small WSL one-liner to discover the host IP.
  • Clarify repository layout and ingress intent so readers know which overlay is active and that only OpenWebUI is exposed.

Description

  • Updated README.md to state the active deployment is only Ollama (in-cluster LLM runtime at http://ollama:11434) and OpenWebUI (the only user-facing web UI that calls Ollama).
  • Revised the repo layout to mark overlays/dev-ollama/ as the deployment path for Ollama + OpenWebUI and mark base/ as deprecated/not used by that overlay.
  • Replaced the hard-coded nip.io hostname with the pattern webui.<WSLIP>.nip.io and added a WSL one-liner hostname -I | awk '{print $1}' to obtain WSLIP.
  • Explicitly documented that the ingress exposes only OpenWebUI and that there is no separate chatbot ingress.

Testing

  • Verified README content and changes with a targeted search using rg -n "nip.io|chatbot ingress|ollama:11434|base/|overlays/dev-ollama|hostname -I" README.md, which returned the expected updated phrases.
  • Reviewed the rendered README.md contents with nl -ba README.md | sed -n '1,220p' to confirm the new wording and added examples appear as intended.
  • Confirmed the diff shows the hard-coded webui.<ip>.nip.io string was removed and replaced with the new hostname pattern.

Codex Task

@dwetmore dwetmore merged commit 76d6615 into main Feb 10, 2026
1 check passed
@dwetmore dwetmore deleted the codex/update-readme.md-for-accuracy-and-clarity branch February 10, 2026 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant