Feature Map¶

Use this page when you know what you want to do, but not which tldw_server surface or guide covers it.

Primary surfaces:

WebUI: the main self-hosted browser app for chat, media, knowledge work, audio, study, and admin workflows.
Browser extension: capture and sidepanel workflows that connect to your tldw_server instance.
Server API: FastAPI endpoints, including OpenAI-compatible Chat, Audio, Embeddings, and vector-store APIs.
Admin/operator tools: setup, authentication, hardening, usage, monitoring, backups, and multi-user operations.

Setup And Connection¶

Goal	Start in	Best next guide
Choose an install path	Docs	Self-hosting profiles
Run the shortest local self-hosted path	Docker + WebUI	Docker single-user + WebUI
Run a contributor/debug setup	Local API + WebUI	Local single-user
Run a shared server	Docker + Postgres	Docker multi-user + Postgres
Configure auth	Server/admin	Authentication setup
Connect the browser extension	Extension	Extension docs

Goal	Start in	Best next guide
Chat in the WebUI	WebUI	WebUI user guide
Understand chat pages	WebUI	Chat pages
Use the OpenAI-compatible chat API	API	Chat API documentation
List configured providers	API/WebUI settings	Providers API documentation
Use characters and roleplay	WebUI	Character roleplay quickstart
Tune prompt behavior	WebUI/API	Prompt engineering notes

Goal	Start in	Best next guide
Add videos, audio, documents, or web pages	WebUI Media / API	Media to RAG evals workflow
Use async media ingest jobs	API	Media ingest jobs API
Scrape and ingest websites	WebUI/API	Web scraping and ingestion
Configure reusable ingestion sources	API/admin	Ingestion sources API
Tune chunking	WebUI/API	Chunking templates user guide
Read EPUBs	WebUI	EPUB reader guide

Goal	Start in	Best next guide
Search ingested content	WebUI/API	RAG API guide
Configure production RAG	Server/admin	RAG production configuration
Compare or tune retrieval quality	WebUI/API	RAG evals playbook
Create embeddings	API	Embeddings API documentation
Query vector stores	API	Vector stores admin and query
Use docs Q&A help in the WebUI	WebUI	Quick Chat Docs Assistant

Goal	Start in	Best next guide
Set up STT and TTS for the first time	WebUI/server	Getting started with STT and TTS
Configure CPU audio dependencies	Server	CPU audio setup
Configure GPU or accelerated audio	Server	GPU audio setup
Transcribe files or streams	API	Audio transcription API
Generate speech	WebUI/API	TTS getting started
Run audio jobs	API/admin	Audio jobs API

Goal	Start in	Best next guide
Run evaluations	WebUI/API	Evaluations user guide
Use unified evaluation APIs	API	Evaluations API unified reference
Create benchmark runs	WebUI/API/extension	Benchmark creation and runs
Study with flashcards	WebUI/extension	Flashcards study guide
Use kanban boards	WebUI	Kanban board guide

Goal	Start in	Best next guide
Export, import, or migrate chats	WebUI/API	Chatbook user guide
Use Chatbook tools	WebUI/API	Chatbook tools getting started
Import Google Keep notes	WebUI	Google Keep import/export
Manage reading items	API/WebUI	Reading list API
Use prompt projects and tests	API/WebUI	Prompt Studio API

Goal	Start in	Best next guide
Build workflow examples	WebUI/API	Workflows examples
Manage RSS or Atom feed ingestion	API	Collections feeds API
Use watchlists	API/WebUI	Watchlists API
Connect external agent clients	Server/API	Getting started with ACP
Use MCP tooling	API/admin	MCP status and tools

Goal	Start in	Best next guide
Harden a production deployment	Server/admin	Production hardening checklist
Manage organizations and sharing	Admin/WebUI/API	Organizations and sharing
Administer organizations	Admin	Organization administration
Manage bring-your-own-key provider access	Admin/user settings	BYOK user guide
Understand usage reporting	Admin/API	Usage module
Back up SQLite deployments	Server/admin	Backups using Litestream
Monitor the server	Admin/operator	Metrics cheatsheet