Skip to content

Overhaul README: step-by-step self-hosting guide#7

Merged
omachala merged 7 commits into
mainfrom
readme-overhaul
Jun 7, 2026
Merged

Overhaul README: step-by-step self-hosting guide#7
omachala merged 7 commits into
mainfrom
readme-overhaul

Conversation

@omachala

@omachala omachala commented Jun 7, 2026

Copy link
Copy Markdown
Owner

Summary

  • Remove broken Path 1 (direct whisper without gateway) replaced with the correct gateway+whisper compose that actually works
  • All compose snippets now have volume mounts, depends_on, platform, and restart policies
  • Add structured 6-step setup guide (Docker, compose, start, test, IP, app)
  • Add troubleshooting tables, Reach From Anywhere section (Tailscale, Cloudflare Tunnel, ngrok)
  • Fix Parakeet link: parakeet-tdt-0.6b-v2 to parakeet-tdt-0.6b-v3
  • Fix /v1/models description: response has both data[] (OpenAI) and providers[] (iOS legacy)
  • Remove fake Codecov badge
  • AI Cleanup section restructured with Option A (cloud) and Option B (Ollama)
  • GPU section split: Option A (Parakeet) and Option B (large-v3-turbo) with full compose snippets
  • App connection steps updated to Preferences > Mode UI

Ondrej Machala added 7 commits June 7, 2026 21:05
- Remove fragile Path 1 (direct whisper, no gateway) — replaced with the
  correct gateway+whisper compose that actually works end-to-end
- All compose snippets now include volume mounts, depends_on, platform, and
  restart policies — no more model re-downloading on every container restart
- Add Step 1–6 structure: Docker install, compose file, start stack, test
  with curl, find IP, connect the app
- Add troubleshooting tables for startup errors and test failures
- Add Reach From Anywhere section (Tailscale, Cloudflare Tunnel, ngrok)
- Fix Parakeet link: parakeet-tdt-0.6b-v2 → parakeet-tdt-0.6b-v3
- Fix /v1/models description: response has both data[] (OpenAI) and
  providers[] (iOS legacy), not just OpenAI format
- Remove fake Codecov badge (no codecov is set up in this repo)
- AI Cleanup section restructured with Option A (cloud) and Option B (Ollama),
  test commands, and prompt file mounting example
- GPU section split into Option A (Parakeet) and Option B (large-v3-turbo)
  with full compose snippets for each
- Update app connection steps to reflect current Preferences → Mode UI
- Tailscale: restore "Install the Tailscale app on iPhone, sign in."
- Parakeet: restore "For languages outside this list, use Option B."
- large-v3-turbo: restore first-boot download / instant-start note
- OpenAI compat: restore auth note (pass any non-empty string as API key)
@omachala omachala merged commit d051d99 into main Jun 7, 2026
1 check passed
@omachala omachala deleted the readme-overhaul branch June 7, 2026 21:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant