Skip to content

README.md

Latest commit

 

History

History
46 lines (33 loc) · 2.45 KB

README.md

File metadata and controls

46 lines (33 loc) · 2.45 KB

Getting Started (Self-Hosting Profiles)

Choose exactly one base setup profile and follow it end-to-end.

Recommended default:

  • Run make quickstart from the repo root for the Docker single-user + WebUI path. That default browser flow uses same-origin browser API requests through the WebUI proxy.
  • Use make quickstart-docker if you want the API-only Docker path.
  • Use Docker multi-user + Postgres when you need a team or public deployment.
  • Use Local single-user for development, debugging, or contributor workflows.

Canonical base profiles:

  1. Local single-user
  2. Docker single-user
  3. Docker multi-user + Postgres

Optional add-ons:

How To Use These Guides

  • Pick the profile that matches your target environment.
  • For most users, start with the quickstart-docker-webui path via make quickstart.
  • Treat LAN/custom-host browser access as advanced configuration and stay on the default same-origin browser API requests through the WebUI proxy unless you specifically need another device or origin to reach the API.
  • Complete the guide sections in order: prerequisites, install, run, verify, troubleshoot, then follow the "What to Do Next" section for first API calls and provider setup.
  • Do not mix setup commands from other docs unless the guide explicitly links to them.
  • Apply add-ons only after your chosen base profile is healthy.
  • If speech is part of day-one setup, switch to the CPU or GPU/accelerated audio guide after the base profile is healthy instead of starting with the older STT/TTS reference pages.

Notes

  • This page is the onboarding index for self-hosting.
  • For legacy/deeper reference material, use linked docs from each profile guide.

Migration Disposition (2026-02-28)

Onboarding setup content was consolidated into these canonical guides.

Path Action Replacement
README.md migrated Docs/Getting_Started/README.md
Docs/Deployment/First_Time_Production_Setup.md redirected Docs/Getting_Started/Profile_Docker_Multi_User_Postgres.md
Docs/User_Guides/Server/CLI_Reference.md redirected Docs/Getting_Started/README.md