Skip to content

Install

Timothy runs as a set of containers under Docker Compose. You install it on one machine, and you open it in your browser.

After the install, these services run on your machine:

Service What it does
brain The public API. It runs chats, agents and missions.
gateway Sends each model request to the right provider and records what it cost.
memoryd Stores and searches what Timothy remembers.
sandboxd Starts a separate container for each mission’s work.
web The web interface you use in the browser.
searxng Web search for Timothy’s search tool.
markitdown Turns files such as PDFs into text Timothy can read.
ocr Reads text from images.
pdfgen Makes PDFs: a chat answer, a mission result, or any document Timothy writes.
whisper Local speech to text for the microphone button. It is off unless you turn it on.

A PostgreSQL database holds all data. It has no port on your machine. Only two ports are open to you: 3300 for the web interface and 8300 for the API.

  • Quick start uses the released images. You need Docker and nothing else. This is the right choice for most people.
  • Build from source builds every image from the Timothy repository. Choose it if you want to change the code.

Do you run a Kubernetes cluster? The Kubernetes pages install Timothy there with the Helm chart.

Before you start, read the requirements.

After the install, these pages help you keep Timothy running: